Skip to main content
API keys are the credential that produces the JWT bearer token used by every v2 request. Create them in the dashboard, scope them to the access level you need, and revoke them when they are no longer in use.

Permissions

API keys can be configured with specific access levels:
  • View — Read-only access; cannot request trades or quotes.
  • Trade — Enables live trade execution, trade history access, and balance inquiries.

Creating an API key

1

Open the API Keys section

Navigate to the API Keys section of the dashboard.
2

Create a new key

Click Create API Key and assign the required access scopes.
3

Configure key 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 dashboard and select Delete next to the key. Once revoked, the key and any associated JWTs are invalid.
  • To temporarily disable a key, toggle the Status button next to the key off. This prevents access without revocation. The key can be reactivated at any time by toggling Status back on.