Skip to content
QeychainQeychain API

Create Api Key

POST
/api/v1/api-keys
curl --request POST \
  --url https://api.qeychain.xyz/api/v1/api-keys \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "permissions": [ "example" ], "rate_limit_rpm": 1, "rate_limit_rpd": 1, "allowed_addresses": [ "example" ], "expires_at": "2026-04-15T12:00:00Z", "plan": "example", "monthly_call_limit": 1 }'

Create a new API key.

IMPORTANT: The full API key is returned only once in this response. Store it securely - it cannot be retrieved again.

Available permissions:

  • read:holdings, read:transactions, read:lots, read:tax-reports
  • write:portfolios, write:webhooks
  • admin:api-keys, admin:users

Requires: admin:api-keys permission

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CreateAPIKeyRequest

Request to create a new API key.

object
name
required
Name

API key name

string
>= 1 characters <= 255 characters
description
Any of:
string
permissions
Permissions

Permission strings

Array<string>
rate_limit_rpm
Any of:
integer
>= 1 <= 10000
rate_limit_rpd
Any of:
integer
>= 1 <= 100000
allowed_addresses
Any of:
Array<string>
expires_at
Any of:
string format: date-time
plan
Any of:
string
monthly_call_limit
Any of:
integer
>= 1
Examplegenerated
{
  "name": "example",
  "description": "example",
  "permissions": [
    "example"
  ],
  "rate_limit_rpm": 1,
  "rate_limit_rpd": 1,
  "allowed_addresses": [
    "example"
  ],
  "expires_at": "2026-04-15T12:00:00Z",
  "plan": "example",
  "monthly_call_limit": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Create Api Key Api V1 Api Keys Post
object
key
additional properties
any
Examplegenerated
{}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}