v1

latestOpenAPI 3.0.32026-07-267278168.1 KB
API Keys

Create API Key

Create a new API key. The secret is returned only once.

post/v1/api_keys

Request body

namestring required

Human-readable name for the API key

scopesApiKeyScope[] required

Permission scopes for the API key

Example request

{
  "name": "Trading Bot",
  "scopes": [
    "trade",
    "transfer"
  ]
}

Response

Created API key (includes secret)

successboolean required

Whether the request was successful

errorstring

Error message, present only on failure

error_codestring

Semantic error code. See each endpoint's error responses for the specific codes it can return.

deprecatedstring

Deprecation notice, if applicable

Example response

{
  "success": true
}