Common

Response structure

Failed response structure:

{ "code": 25, "error": "Exchange cant process order ...." }

• code (integer): Represents the internal status code indicating the nature of the failure.

• error (string): Provides a human-readable description of the encountered error.

Successful response structure:

{ "result": "Some successful result data here." }

• result (any): Contains the successful response data.

• Prices and quantities, and amounts are returned in normal format For example price of USDC 1945.4 will be presented as "1945.4".

Auth

For the endpoints labelled with AUTH, a valid JWT token is necessary for access. This token must be included in the 'Authorization' header when making a request. If the authentication header is incorrect, users will receive a failed response with an HTTP status code of 401, signalling unauthorized access.

Rate Limits

In the context of your API, each endpoint is subject to a rate limit, individually specified for each trader. If a user exceeds this designated rate limit, the system will respond with an HTTP status code of 429, indicating that the rate limit has been reached. The accompanying error description will provide information on the suggested sleep time in milliseconds after which the trader can attempt to repeat the request. It's crucial to note that the abuse of rate limits can have a negative impact on a user's overall rate limits, affecting their ability to interact with the API. This ensures fair usage and encourages responsible and considerate utilization of API resources