Skip to main content

Introduction

Welcome to the Apex Brokerage Integration API documentation.

This API allows you to integrate with the Apex Brokerage platform programmatically. You can manage nodes, markets, distributors, tokens, and more through our RESTful API.

Base URL​

https://api.apex.com/api/v1/integration

Authentication​

All API requests (except authentication endpoints) require authentication using Bearer tokens. See the Authentication section for details.

Required Headers​

All API requests require the X-Target-Server header:

  • Authentication endpoints (/auth/authenticate and /auth/refresh): Use X-Target-Server: authentication
  • All other endpoints: Use X-Target-Server: integration

Rate Limits​

API requests are rate-limited to ensure fair usage. Current limits:

  • 50 requests per minute per API key

Response Format​

All API responses are in JSON format. Successful responses return HTTP status codes in the 2xx range, while errors return 4xx or 5xx status codes.

Error Responses​

Error responses follow this format:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "details": {}
  }
}

Getting Started​

  1. Obtain API credentials from the Brokerage platform
  2. Authenticate using the /auth/authenticate endpoint
  3. Use the access token in the Authorization header for subsequent requests
  4. Refresh your token when it expires using the /auth/refresh endpoint