UnBlinked Menu Bar
Once logged in, click My Profile on the upper right side of the screen and select Account Settings. In the account settings, you can reach Connect Exchange tab.
Connect Exchange Menu
Connect Exchange is a feature within Account Settings that allows you to connect an API key for an exchange. This feature enables you to view the connection status for each exchange.
The status reflects the availability of the API key:
- Click to connect - you can start connecting by clicking on this button.
- Connected - the key is functioning correctly.
- Error - the key has expired or has an incorrect value.
- Connecting - the data is being gathered from the exchange and this stage may take up to a maximum of 20~40 minutes.
Multi Account Please note that only one API key per exchange can be connected per account, and connecting one exchange account to multiple UnBlinked accounts is not recommended. Doing so may result in missing data or restricted data collection.
If you want to change the connected API key to a new one or connect the same key again, you must delete the current API key first.
Creating an API key is the first step to connecting your account with an exchange.
Read-only API keys
The API key is required to read data only, so please ensure that you grant read permissions and disable other permissions when creating an API key.
To create an API key, you will need to visit the exchange's site and follow its instructions. Some exchanges allow you to choose the permissions for your API key, but you will need to grant all permissions to read or acquire data (some exchanges may refer to this as 'read-only'). Permissions for making or changing orders and accessing account information are not required.
Note that some exchanges require you to restrict the IP addresses that can access your API key. However, except for Upbit_kr, you should avoid restricting IP addresses in order to connect your API key.
An API key consists of a public key, private key, and passphrase.
- Public key is a value that is exposed and is usually shown after creating the API key.
- Private key is a value that should not be exposed and is only available when the key is created. Therefore, it's crucial to keep the private key secure.
- Passphrase is a value that you can choose. Some exchanges require a passphrase and since the passphrase is needed to sync the API key, you should keep it as secure as the private key.
Additionally, some exchanges may ask for a Name or Description when creating an API key. Like the passphrase, you can choose any words you like for these fields. They are shown at the API management site of the exchange and are not required for syncing.
For more information on how to create an API key for each exchange, please refer to the Manual for Creating API Keys.
1. Choose the exchange you want to connect
Choose exchnage you want to connect
2. Insert your API keys
Insert your API keys
To connect your API key, you will need to insert the public key, private key, and, if required, passphrase of your API key. Once you have done this, please click submit button below.
For Upbit users Note that the policy for Upbitkr API keys has changed, and it is now mandatory to enter the IP address into the API key's configuration. To do this, please refer to the manual for the Upbit_kr API key and enter the IP address into the API key's configuration page before connecting the API key.
Once you have connected your API key, you can check out its status on your account settings. If the API key is working properly, the status will be shown as Connected.
API key deletion
To delete the connected API key, first select the exchange button which you want to delete and click on the delete button.
API key deletion warning
Choose either Delete only the API key or Delete user data + API key.
If you choose to Delete user data + API key, the transaction data obtained from the exchange using that API key will be terminated. This can be useful if the transaction data is incorrect or you want to sync another API key from the same exchange. However, be aware that some exchanges may lose past transaction data and it may not be recoverable.
After selecting the deletion options, you will be prompted to type in the name of the exchange. The exchange name is displayed in the input field.
- Data collection for the connected API key can take from a few seconds to more than 10 minutes, depending on the exchange. Therefore, data displayed in the dashboard may be delayed or incomplete.
- Only one API key for each exchange can be connected per account. If you connect API keys from the same exchange account to multiple UnBlinked accounts, data collection may be disrupted or restricted.
- The data displayed before the API key is connected is provided by calculating the records obtained from the API key. This process can take a few minutes to complete. If the exchange has restrictions on getting records, the data may differ from the actual records.
- If you select 'Delete user data + API key' to delete the API key, we recommend waiting for at least 30 minutes to ensure that all data has been completely deleted before connecting a new API key for the same exchange. Otherwise, some data may remain and interfere with new data.
- If you want to delete data after deleting the API key, you can connect a dummy API key with fake values and delete it by selecting 'Delete user data + API key'. If the data still remains after that, please contact us for assistance.
- Due to changes in exchange policies, the process for creating API keys may be different from the manual. In that case, please create the API key by following the guidelines in Create API Keys (i.e., activate read-only options, do not restrict IP addresses, etc.).