Skip to main content

Base URL

The API gateway is accessible at:
For production deployments, configure your base URL accordingly.

API Versioning

All API endpoints are versioned and prefixed with /api/v1. Example:

Required Headers

All API requests require authentication headers:
string
required
Your API key for authentication. Configured via API_GATEWAY_API_KEYS environment variable.
string
Optional tenant identifier for multi-tenant deployments. Use * for wildcard access.

Common Headers

Response Envelope

All API responses follow a standardized envelope structure for consistent error handling:
See Response Format for detailed specifications.

HTTP Methods

The API uses standard HTTP methods:
  • GET - Retrieve resources
  • POST - Create resources or execute actions
  • PUT - Update existing resources
  • DELETE - Remove resources (limited use)

Rate Limiting

API requests are rate-limited per API key:
  • Default: 120 requests per minute
  • Configure via: API_GATEWAY_RATE_LIMIT_PER_MINUTE
  • Rate limit headers included in responses:
    • X-RateLimit-Limit
    • X-RateLimit-Remaining
    • X-RateLimit-Reset

Pagination

List endpoints support pagination via query parameters:
number
default:"50"
Maximum number of items to return (max: 100)
number
default:"0"
Number of items to skip
Example:

Idempotency

Transaction creation supports idempotency keys to prevent duplicate operations:
When an idempotency key is provided, repeated requests return the original transaction record.

Health Check

Verify API availability:
Response:

SDK Support

TypeScript SDK available at packages/sdk:

Next Steps

Authentication

Learn about API key and scope management

Response Format

Understand the response envelope structure

Errors

Handle errors and error codes

Wallets

Start with wallet operations