Note: You can have a maximum of 50 API keys. This includes keys that are stored as well as keys that are generated in Bullish.

Bullish supports the following key types for Trading API and Custody API.

Key type Trading API Custody API
FIX :check_mark: :cross_mark:
HMAC :check_mark: :cross_mark:
ECDSA :check_mark: :check_mark:
Bullish Keys :check_mark: :check_mark:

 

Important: Bullish Keys will continue to be supported through June 28, 2024. You will no longer be able to create new Bullish Keys after March 29, 2024. Bullish will end the support of Bullish Keys and bring your own key as of June 28, 2024.
Note: If you are generating your own API keys, please note that Bullish supports these 2 types of API keys: ECDSA and Bullish Keys. See the format of these key types here.

 

Adding API Keys

For Trading API keys, you can add HMAC, ECDSA and Bullish keys.

To add an HMAC Trading key:

  1. Go to the left-hand navigation and choose Settings.
    Settings in lefthand navigation.png
  2. Navigate to API Keys.
    API Keys tab in Settings.png
  3. Choose Add API Key.
    Add API Key button.png
  4. Select Trading Key.
    Trading Key in Add API Key pop up.png
  5. Select the type of key (HMAC) and its permissions. By default, the key will have the Read Info permission. As an added layer of security, you can also set the range of IP addresses from which the API key is allowed to connect. This is optional. The IP whitelist ranges may be edited after the key has been created.
    Adding Trading API Key GIF.gif
  6. Choose Continue.
  7. Enter the key name, the trading accounts it is allowed to access (Institutional customers only), and choose Generate.
    Enter name and trading account.png
  8. Use your two-factor authenticator (passkey or TOTP authentication) to complete the process.
  9. You can copy your API Public Key and API Private Key.
    API PRV and PUB keys.png

To add an ECDSA Trading key:

  1. Go to the left-hand navigation and choose Settings.
    Settings in lefthand navigation.png
  2. Navigate to API Keys.
    API Keys tab in Settings.png
  3. Choose Add API Key.
    Add API Key button.png
  4. Select Trading Key.
    Trading Key in Add API Key pop up.png
  5. Select the type of key (ECDSA) and its permissions. By default, the key will have the Read Info permission. As an added layer of security, you can also set the range of IP addresses from which the API key is allowed to connect. This is optional. The IP whitelist ranges may be edited after the key has been created.
    ECDSA Trading key in Add API key pop up.png
  6. Choose Continue, then enter the key name and the trading accounts it is allowed to access (Institutional customers only). You can choose to Generate an API key or enter your own key.
    Enter name, trading account, and generate ECDSA.png
  7. Choose Continue.
  8. Use your two-factor authenticator (passkey or TOTP authentication) to complete the process.
  9. You can copy your API Private Key and UUID.
    ECDSA Trading Key Generated.png

For Custody API keys, you can add ECDSA and Bullish keys.

To add an ECDSA Custody key:

  1. Go to the left-hand navigation and choose Settings.
    Settings in lefthand navigation.png
  2. Navigate to API Keys.
    API Keys tab in Settings.png
  3. Choose Add API Key.
    Add API Key button.png
  4. Select Custody Key.
    ECDSA Custody Key in Add API key pop up.png
  5. Select the type of key (ECDSA) and its permissions. By default, the key will have the Read Info and IP Address Whitelist permission.
    ECDSA Key selected.png
  6. In the Add Custody API Keypop up window, enter your IP addresses (Start Range and End Range). To add multiple IP ranges, choose Add IP range. The IP whitelist ranges may be edited after the key has been created.
    Add IP addresses.png
  7. Choose Continue, then enter the key name and the trading accounts it is allowed to access (institutional customers only). You can choose to Generate an API key or enter your own key.
    Generate button in Custody Key pop up.png
  8. Use your two-factor authenticator (passkey or TOTP authentication) to complete the process.
  9. You can copy your API Private Key and UUID.
    ECDSA Custody Key Generated.png

The API Key is now saved and will appear in the API Key listing in Settings.

The name of an API key may be changed. Any additional properties that you wish to change require that you delete the key and create a new one, however you can reuse the same private key if you choose by entering the value in step 11 instead of generating a new one.

If you want to reset an API key, visit our API documentation.

Editing IP range

To edit the IP range in your API keys:

  1. Go to the left-hand navigation and choose Settings.
    Settings in lefthand navigation.png
  2. Choose API Keys.
  3. Choose Edit next to the API key that you want to update.
  4. In this step you can amend the IP range in your API key.
    a. If you did not specify the IP range when you first created the API key, you can select IP Address Whitelist and enter the Start Range and End Range.
    OR
    b. If you want to enter additional IP ranges, choose Add IP Range and enter the Start Range and End Range.
    OR
    c. If you want to remove a specific IP range, choose the 'X' button next to the IP range you want to delete.
  5. Choose Continue.

 

Using your own API key

You can use your own API keys in the Bullish exchange if they follow the format listed below.

For example purposes only:

Key type Key format Example
ECDSA Curve ECDSA R1 (prime256v1 or secp256r1 or P-256) -----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEYtPSVNz5ZsfxfaYdpRf3e2iv9iAc goiGiFUG0au5Mvn/MiaSTu2Ji5TyO/+BGYEcxQZ5aUb9QNz+yHTB1/fAxQ== -----END PUBLIC KEY----- 
Key Format X.509 SubjectPublicKeyInfo format, PEM encoded
Bullish Key Curve ECDSA R1 + (EOSIO special requirement) PUB_R1_7mhjRzhFjcbRusLyCWnLaWhuUu5MojXbeN5oUHsjT4PdYJnnYc
PVT_R1_2C6FjyDWhf2EbCioKWfSTCWcjtchhXjdpqvoLaFjYcMuCxYvLH
Key Format EOSIO own specific format
Was this article helpful?
0 out of 0 found this helpful