API key actions

All paths are relative to the base URL. See authentication and errors and idempotency.

Register a wallet-signed API grant

POST /v1/api-keys

Requires the main account owner’s EIP-712 signature. Copy-wallet key creation is rejected with main_account_required; non-mainnet grants are rejected with mainnet_required.

Request body

Example request

curl -X POST "$LEGEND_API_BASE/v1/api-keys" \
  -H "Content-Type: application/json" \
  --data @signed-request.json

Response

See the OpenAPI schema for nested response objects and validation patterns.

Illustrative successful response:

{
  "object": "api_key",
  "account": "00000000-0000-4000-8000-000000000001",
  "network": "hyperliquid_mainnet",
  "key_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "scopes": ["trading:read", "trading:write"],
  "expires_at": null
}

Revoke a key with the account owner signature, including before registration

POST /v1/api-keys/revoke

Requires the account owner’s EIP-712 signature.

Request body

Example request

curl -X POST "$LEGEND_API_BASE/v1/api-keys/revoke" \
  -H "Content-Type: application/json" \
  --data @signed-request.json

Response

See the OpenAPI schema for nested response objects and validation patterns.

Illustrative successful response:

{
  "object": "api_key",
  "key_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "revoked": true
}