Deus X Pay Trading API (1.1)

The Deus X Pay API is a REST API. Where possible, the conventional HTTP verb is used for each operation:

Only JSON-encoded requests will be processed. Clients should set application/json as the value of the Content-Type header for each request.

Non zero-length responses will return either a JSON object or array. Zero-length responses will be accompanied by an HTTP 204 (No Content) code.

Date format

All dates in the API use UTC and are strings in the ISO 8601 "combined date and time representation" format:

2020-01-02T03:04:05.067Z

Numerical precision

Two fixed precision levels are used when referring to, or accepting input of currency values on Deus X Pay. This includes prices, balances, fees, trade values and deposit and withdrawal amounts.

Fiat Currency

All fiat currency values are represented with two (2) decimal places, except in the case of USDT orders the price can have up to five (5) decimal places.

E.g.:

• $12353.22
• $0.12

Digital Currency

All digital currency values are represented with six (6) decimal places. However some orders might restrict the precision of their amount to a value lower than 6 (as described in the "Orders" section of this document).

E.g.:

• ₿0.400213
• Ξ20.342214

Endpoints that return paginated results take in offset and limit as query parameters e.g.:

?offset=60&limit=20 will return up to 20 items, starting from the 60th item

The default value of limit is 25, and offset 0

Paginated responses will have the following body structure:

{
  "total": 100,
  "size": 20,
  "data": [
    {
      ...
    },
    ...
  ]
}

Where total is the total number of items matching the query, size the number of items returned in the response, and data the list of items.

When the HTTP response code is in the 4XX or 5XX range, the response body will contain an error object with a string code and usually an associated error message:

{
  "error": {
    "code": "some_error_code",
    "message": "A description of the problem"
  }
}

For error parsing, use the code field value. The message text may change without notice. Additional error fields may be returned specific to the type of error.

All API requests are required to be authenticated via Bearer Authentication. The API Key must be provided in the Authorization HTTP header:

Authorization: Bearer [API_KEY]

If an API Key is not provided, the request will be rejected with an HTTP 401 code.

Permissions are defined for each individual API Key. Currently these are either Read Only or Read & Write permissions.

More granular permissions may be made available in a future version.

HTTP Requests to the API will be rate limited. The rate limits apply to all requests and are measured per IP address. When the request rate exceeds the rate limit any further requests from the offending IP address will be blocked and return an HTTP 429 (TBC) response code for the duration of the block period. Once the block period has expired the client will be able to resume requests as normal.

IP addresses that repeatedly violate the rate limits may be banned permanently.

The API major version is included in the URL as the first path segment (https://api.deusxpay.com/trade /v1/).

Backwards compatible changes including the addition of new fields into existing objects of the published API or internal changes that do not affect the response structure will be made without incrementing the API major version.

Any changes to the existing API fields or structure will be published as a new major of the API with a different path segment (https://api.deusxpay.com/trade /v2/, /v3/, /v4/ etc...)

The previous major version(s) of the API will generally remain available concurrently with the newest version to ensure continuing compatability for existing integrations.

API Client Libraries are not currently available. These libraries will be made generally available for multiple languages in the future.

Client notifications (e.g. Websocket subscription/callback URL) are not currently available. Flexible notifcation options will be added for the APIs in an upcoming release.

Make or Take trade Orders

Transactions

Wallets

Deposits

Withdrawals