Skip to main content
POST
Create an API key

Body

application/json
name
string
required
Required string length: 1 - 200
scopes
enum<string>[]

Scopes granted to the new key. Send explicit least-privilege scopes for API-created keys.

Available options:
blueprints:read,
blueprints:write,
blueprints:deploy,
orders:read,
orders:write,
market_data:read,
portfolio:read,
portfolio:write,
risk:read,
risk:write,
api_keys:read,
api_keys:write

Response

Created API key including one-time plaintext key.

id
string<uuid>
name
string
scopes
enum<string>[]
Available options:
blueprints:read,
blueprints:write,
blueprints:deploy,
orders:read,
orders:write,
market_data:read,
portfolio:read,
portfolio:write,
risk:read,
risk:write,
api_keys:read,
api_keys:write
createdAt
string<date-time>
lastUsedAt
string<date-time> | null
revokedAt
string<date-time> | null
key
string
Example:

"bp_YOUR_API_KEY"