'api/v1', /* * Your API domain. By default, app domain is used. This is also a part of the default API routes * matcher, so when implementing your own, make sure you use this config if needed. */ 'api_domain' => null, /* * The path where your OpenAPI specification will be exported. */ 'export_path' => 'api.json', 'info' => [ /* * API version. */ 'version' => env('API_VERSION', '1.2'), /* * Description rendered on the home page of the API documentation (`/docs/api`). */ 'description' => 'Our REST API version 1.2 provides programmatic access to the platform’s trading engine API endpoints. We strongly recommend that our new customers use API version 1.2 to get the best trading experience. We also recommend that our current traders switch to the newest version 1.2.

DateTime Format

All timestamps are returned in ISO 8601 format or UNIX timestamp in milliseconds (UTC).

Example: "2021-06-03T10:20:49.315Z" or "1614815872000".

Number Format

All currency data, e.g., price, amount, fee, etc., should be precision numbers and have a string representation. Example: "20.4383003".

RATE LIMITING

The following Rate Limits are applied:

for the Market data, the limit is 20 requests per second for one IP;

for Trading, the limit is 50 requests per second for one user;

for other requests, the limit is 10 requests per second for one user.

Significantly exceeding the Rate Limits can lead to suspension.

BEST PRACTICES

The development team does its best to bring the best trading experience to API users. This manual contains a set of best practices for using the API as efficiently as possible.

HTTP Persistent Connection

The underlying TCP connection is kept active for multiple requests/responses. Subsequent requests will result in reduced latency as the TCP handshaking process is no longer required.

If you use the HTTP 1.0 client, please ensure it supports the Keep-Alive directive and submit the "Connection: Keep-Alive" header with your request.

Keep-Alive is a part of the HTTP/1.1 or HTTP/2 protocol and is enabled by default on compliant clients. However, you will have to ensure your implementation does not set other values as the connection header.

REST API Reference

HTTP Status Codes

200 OK. Successful request

422 Bad Request. Returns JSON with the error message

401 Unauthorized. Authorization is required or has been failed

403 Forbidden. Action is forbidden

404 Not Found. Data requested cannot be found

429 Too Many Requests. Your connection has been rate limited

500 Internal Server. Internal Server Error

503 Service Unavailable. Service is down for maintenance

504 Gateway Timeout. Request timeout expired

', ], /* * Customize Stoplight Elements UI */ 'ui' => [ /* * Define the title of the documentation's website. App name is used when this config is `null`. */ 'title' => 'REST API Documentation', /* * Define the theme of the documentation. Available options are `light` and `dark`. */ 'theme' => 'light', /* * Hide the `Try It` feature. Enabled by default. */ 'hide_try_it' => false, /* * URL to an image that displays as a small square logo next to the title, above the table of contents. */ 'logo' => '', /* * Use to fetch the credential policy for the Try It feature. Options are: omit, include (default), and same-origin */ 'try_it_credentials_policy' => 'include', ], /* * The list of servers of the API. By default, when `null`, server URL will be created from * `scramble.api_path` and `scramble.api_domain` config variables. When providing an array, you * will need to specify the local server URL manually (if needed). * * Example of non-default config (final URLs are generated using Laravel `url` helper): * * ```php * 'servers' => [ * 'Live' => 'api', * 'Prod' => 'https://scramble.dedoc.co/api', * ], * ``` */ 'servers' => null, 'middleware' => [ 'web', ], 'extensions' => [], ];