1. Overview
Ekiden provides REST and WebSocket APIs for low-latency market making and automated trading.Supported Protocols
- REST API (HTTPS)
- WebSocket (WSS)
Environments
Public market data is available without authentication.
Trading operations and private account streams require authentication.
2. Authentication
Ekiden supports two authentication methods:- JWT Bearer authentication
- API Key authentication
Obtain a JWT
REST Authentication
Authenticated REST requests use the standard Bearer header:API Key Authentication
REST API Key authentication uses the following headers:X-API-KEYX-SIGNATUREX-TIMESTAMP-MSX-NONCE
3. REST API
REST endpoints are grouped by resource.
Example:
4. WebSocket
Ekiden provides separate public and private WebSocket endpoints.JWT Authentication
Authenticate immediately after connecting. Client → ServerAPI Key Authentication
Alternatively, authenticate using an API key. Client → ServerSubscribe
After successful authentication, subscribe to private topics.orderbook.<depth>.<symbol>trade.<symbol>ticker.<symbol>kline.<interval>.<symbol>insurance_pool.<symbol>adl_alert.<symbol>
5. Typical Trading Flow
A typical market maker integration follows this sequence:- Obtain a JWT or use API Key authentication.
- Connect to the public WebSocket.
- Subscribe to market data.
- Connect to the private WebSocket.
- Authenticate the private connection.
- Subscribe to private account topics.
- Place, amend, or cancel orders using the REST API.
- Monitor order, execution, position, and account updates through the private WebSocket.
6. Error Handling
Common HTTP status codes include:
Refer to the Error Handling guide for the complete list of application error codes.
7. Rate Limits
REST API requests are subject to rate limits. When a limit is exceeded, the server returns:- HTTP
429 Too Many Requests Retry-Afterresponse header
Retry-After value before retrying requests.
Refer to the Rate Limits guide for current limits.