An API Key is a unique identifier that authenticates requests associated with your account. You may use an API Key to connect your account to the Bitfinex Mobile App and to use Bitfinex's authenticated API endpoints.
How to create an API key
1. Firstly, go to your API Key page.
2. Then, choose the Create New Key tab.
3. Here, choose the required permissions you would like to enable:
Account Info: lets you receive account fee information and/or edit account information;
Account History: provides you with the ability to view and download information on the detailed trading activities of your account;
Orders: view the orders on your account, also providing the option to create and cancel orders;
Margin Trading: view margin positions and information, you can also turn on the ability to claim your open positions;
Margin Funding: provides status information and can give you access to offer, cancel and close funding;
Wallets: allows access to balances and addresses with an option of transferring between your wallets;
Withdrawals: enables withdrawals through the API;
- Bitfinex Pay: provides status information Bitfinex Pay invoices and provides the option of creating Bitfinex Pay invoices;
- IP Access restrictions: provides you with the ability to whitelist up to 20 IP addresses for an API key, allowing API keys to only be used from specific IP addresses.
4. Label your API Key.
5. Click Generate API Key once you have confirmed all your settings, and we’re almost finished!
6. For security reasons, you will need to confirm the creation via your 2FA code (or U2F device, depending on your security setup).
7. Go to your email where you will receive an email with a confirmation link; click the Create API Key button to complete the process:
Note: Make sure to access the email confirmation using the same browser as your Bitfinex page. If clicking the link takes you to another browser, you can copy and paste the link to the browser you are using with your Bitfinex website.
8. Congratulations! You have now created your API key. The page will show both your API Key and API Key Secret in text and as a QR code. You can either scan the code or copy and paste the text according to your needs.
Important: The API Key information will be displayed to you only once. For security reasons, do not store your API Key online as it could be compromised.
How to edit or revoke an API Key
Your created API Keys can be found in the API section under My API Keys. Here you can only edit permissions or revoke your API key.
How to edit an API Key at Bitfinex
To edit your API Key, go to the API page and find the My API Keys tab.
Click on Permissions > Edit to proceed and adjust the permissions as you wish. When confirmed, click Update Permissions at the bottom of the page.
Note: For security reasons, you will be asked for your 2FA code to finalise the edit.
How to revoke an API key at Bitfinex
To remove your API key, go to the API page and find the My API Keys tab. Under Action, you can select Revoke, and this will automatically remove all permissions which were being used by this API key.
How to edit an API Key on the Bitfinex Mobile App
If you have logged into your Bitfinex account using an API Key, you can edit permissions directly on the Bitfinex Mobile App if you have enabled the Edit account information permissions when creating the API Key.
Follow the steps below to directly edit your API Key permissions within the Bitfinex Mobile App.
1. Open the Bitfinex Mobile App and go to the Account tab and select the Account option.
2. Tap on Permissions that you can find at the very top.
3. Tap on the Edit button to change permissions.
4. Once you have confirmed the changes, tap on Save.
5. You will be prompted to enter your 2FA code to complete the changes you have made.
- If you have logged into your Bitfinex account directly through email and password, the default setting has all permissions enabled, and this cannot be changed.
- If you have signed up through the Bitfinex Mobile App, the default setting has all permissions enabled. You can log in on the website version and create an API Key if you wish to change permissions.
If you have any questions, please feel free to contact Bitfinex Support. We are happy to help!