Welcome to the API reference documentation. This section provides detailed information about the available API endpoints, request and response formats, authentication methods, and usage examples.

​
Getting Started

To begin using the API, you’ll need to authenticate by including an API key in your requests. Each endpoint listed in this documentation comes with an overview, supported HTTP methods, and example requests to get you up and running quickly.

​
Structure

The API is organized around REST principles and uses standard HTTP methods, status codes, and authentication. Each endpoint is described with:

  • Endpoint URL
  • HTTP Method (GET, POST, PUT, DELETE)
  • Required Parameters and their descriptions
  • Request Example
  • Response Example

​
Authentication

The API uses token-based authentication. Pass your API key in the header of each request as follows:

Authorization: Bearer YOUR_API_KEY

​
Error Handling

Standard HTTP status codes are used to indicate the success or failure of an API request. Common error codes include:

  • 400 Bad Request – Invalid request parameters
  • 401 Unauthorized – Missing or incorrect API key
  • 404 Not Found – Requested resource does not exist
  • 500 Internal Server Error – An error occurred on the server

For more details on each endpoint, refer to the specific documentation sections.

Note: Always refer to the latest version of the API documentation for any updates or changes.

Welcome to the API reference documentation. This section provides detailed information about the available API endpoints, request and response formats, authentication methods, and usage examples.

​
Getting Started

To begin using the API, you’ll need to authenticate by including an API key in your requests. Each endpoint listed in this documentation comes with an overview, supported HTTP methods, and example requests to get you up and running quickly.

​
Structure

The API is organized around REST principles and uses standard HTTP methods, status codes, and authentication. Each endpoint is described with:

  • Endpoint URL
  • HTTP Method (GET, POST, PUT, DELETE)
  • Required Parameters and their descriptions
  • Request Example
  • Response Example

​
Authentication

The API uses token-based authentication. Pass your API key in the header of each request as follows:

Authorization: Bearer YOUR_API_KEY

​
Error Handling

Standard HTTP status codes are used to indicate the success or failure of an API request. Common error codes include:

  • 400 Bad Request – Invalid request parameters
  • 401 Unauthorized – Missing or incorrect API key
  • 404 Not Found – Requested resource does not exist
  • 500 Internal Server Error – An error occurred on the server

For more details on each endpoint, refer to the specific documentation sections.

Note: Always refer to the latest version of the API documentation for any updates or changes.