Keys

Create an API key

POST
/v1/api-keys

The key itself is returned once, in this response, and cannot be read again.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Request Body

application/json
  1. body
name*string
Length1 <= length <= 60
level?string

What this key may do: 'read' reads only, 'manage' also changes what you already own, 'buy' also spends money. Absent means no ceiling at all, the same as every key made before this field existed

Value in"read""manage""buy"
perOrderLimit?integer

Largest single order this key may place, in cents. Absent means no ceiling

Range0 <= value <= 100000000
dailyLimit?integer

Most this key may spend in one UTC day, in cents. Absent means no ceiling

Range0 <= value <= 100000000

Response Body

Created

application/json
  1. response

Created

id*string
name*string
prefix*string

The first characters of the key, to recognise it by

level?string

What this key may do: 'read' reads only, 'manage' also changes what you already own, 'buy' also spends money. Absent means no ceiling at all, the same as every key made before this field existed

Value in"read""manage""buy"
perOrderLimit?integer

Largest single order this key may place, in cents

Range0 <= value <= 100000000
dailyLimit?integer

Most this key may spend in one UTC day, in cents

Range0 <= value <= 100000000
lastUsedAt*|
Formatdate-time
createdAt*string
Formatdate-time
key*string

The key itself. Store it now; it is not shown again

curl -X POST "https://example.com/v1/api-keys" \  -H "Content-Type: application/json" \  -d '{    "name": "production"  }'
{  "id": "key_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",  "name": "production",  "prefix": "rhq_test_k3J9xQ",  "level": "read",  "perOrderLimit": 500000,  "dailyLimit": 500000,  "lastUsedAt": null,  "createdAt": "2026-10-07T11:04:31.000Z",  "key": "rhq_test_k3J9xQ2mVb7TnY4wLc8HdR5sZ"}