Permissions
API keys can be configured with specific access levels to suit user requirements:- View — Read-only access; cannot request trades or quotes.
- Trade — Enables live trade execution, trade history access, and balance inquiries.
Creating an API key
To generate an API key, follow these steps in the dashboard.1
Open API Keys
Navigate to the API Keys section of the dashboard.
2
Create the key
Click Create API Key and assign the required access scopes.
3
Configure parameters
Set the following parameters:
- Nickname — A unique identifier for the API key.
- Scopes — Defines the level of API access:
- View — Read-only access to account data.
- Trade — Enables trading and order management.
- Allowed IP Addresses — Restricts API key usage to specified IPs (leave blank for unrestricted access).
Revoke an API key
- To revoke an API key, go to the API Keys section of the OpenFX account (GUI) and select Delete next to the key. Once revoked, the key and any associated JWTs are rendered invalid.
- To temporarily disable a key, toggle the Status button next to the key off from the API Keys section. This prevents access without revocation. The key can be reactivated at any time by toggling Status back on.