v4

latestOpenAPI 3.0.02026-08-04103181301.4 KB

api-keys

Generate API Key

Endpoint for generating a new API key with an automatically created key pair. This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.

post/api_keys/generate

Request body

namestring required

Name for the API key. This helps identify the key's purpose

scopesApiKeyScope[]

List of scopes to grant to the API key. If the broad write parent scope is included, read must also be included. Child scopes may be granted without the broad parent scope. Defaults to full access (read, write) if not provided.

subaccountinteger

If set, restricts the API key to a single sub-account (0-63) that you own. A restricted key may only read and trade on that sub-account; it cannot act on other sub-accounts, transfer funds between sub-accounts, or create sub-accounts. Omit to leave the key unrestricted.

Response

API key generated successfully

api_key_idstring required

Unique identifier for the newly generated API key

private_keystring required

RSA private key in PEM format. This must be stored securely and cannot be retrieved again after this response