Sign in

v3

OpenAPI 3.0.02026-07-31103181312.8 KB
api-keys

Create API Key

Endpoint for creating a new API key with a user-provided public key. This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.

post/api_keys

Request body

namestring required

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

public_keystring required

RSA public key in PEM format. This will be used to verify signatures on API requests

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 created successfully

api_key_idstring required

Unique identifier for the newly created API key