Technical Guidelines

For general technical guidelines on the Exberry WebSocket API, please refer to https://docs.exberry.io. This section provides additional guidelines specific to the Market Data API.

Public Access Mode

In this mode, each request must include a token in addition to the standard parameters: q, sid, and d.

Parameter	Type	Description
token	String	Token is configurable value per environment, it allows accurate and efficient instrument discovery. Token generation described on the Introduction section.

{
  "q": "v1/exchange.marketdata/lightTickers",
  "token": "eyJleGNoYW5nZUlkIjozMCwicHJvamVjdElkIjoyMDB9",
  "sid": 102432,
  "d": {
    "symbols": [
      "XYZ"
    ],
    "interval": 1000
  }
}

Generic Error Codes

Code	Message
1	System is unavailable
2	Missing fields: token
3	Invalid token

Authenticated Access Mode

In this mode, a session is established in advance via the WebSocket connection. Therefore, no token is required in individual requests.

Generic Error Codes

Code	Message
1	System is unavailable
1008	Insufficient permissions (in case session was not established in advance)

Heartbeats (Pings)

The WebSocket connection supports ping messages for the client to identify connection drops. Ping requests can be made on-demand, and the server responds to each request.

It is recommended that this API should only be used for heartbeats from the browser. Use WebSocket native ping/pong for other use cases.

qualifier: v1/heartbeat/ping

Request Parameters

Parameter	Type	Description
d	Int	This value will be returned in the response.

Samples

Request

{
  "q": "v1/heartbeat/ping",
  "sid": 1,
  "d": 42
}

Success Response

{
  "q": "v1/heartbeat/ping",
  "sid": 1,
  "d": 42
}

Failure Response

{
  "sig": 2,
  "q": "v1/heartbeat/ping",
  "errorType": "500",
  "sid": 1,
  "d": {
    "errorCode": 500,
    "errorMessage": "Failed to decode service message data"
  }
}