Lux Docs

API Reference

Lux Cloud REST API endpoints

All Lux Cloud API requests require authentication via Bearer token.

Authentication

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.lux.cloud/v1/...

Endpoints

MethodPathDescription
POST/v1/rpc/{chain}JSON-RPC proxy to any chain
GET/v1/tokens/balancesERC-20 token balances for an address
GET/v1/tokens/transfersToken transfer history
GET/v1/nft/ownerNFTs owned by an address
GET/v1/nft/collectionCollection metadata
GET/v1/nft/tokenSingle token metadata
POST/v1/webhooksCreate a webhook subscription
GET/v1/webhooksList active webhooks
DELETE/v1/webhooks/:idDelete a webhook
GET/v1/healthHealth check (no auth required)

Token Balances

curl "https://api.lux.cloud/v1/tokens/balances?address=0x...&chain=lux" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "address": "0x...",
  "chain": "lux",
  "nativeBalance": "1500000000000000000",
  "tokens": [
    {
      "contract": "0xToken...",
      "symbol": "USDC",
      "decimals": 6,
      "balance": "1000000000"
    }
  ]
}

Error Responses

CodeDescription
401Missing or invalid API key
429Rate limit exceeded
500Internal server error
502Upstream node unavailable

Rate Limits

Rate limits are enforced per API key. Responses include rate limit headers:

X-RateLimit-Limit: 600
X-RateLimit-Remaining: 599
X-RateLimit-Reset: 1711094400

Pagination

List endpoints support cursor-based pagination:

curl "https://api.lux.cloud/v1/tokens/transfers?address=0x...&page=2&limit=50"

On this page