Once the connection is successfully established, various requests can be made to the Websocket server.
Requests are made using JSON Objects, and responses are also JSON Objects.
Requests are divided into ticket field, type field, and format field, each consisting of the following components.
Request format
[{Ticket Field},{Type Field},....,{Type Field},{Format Field}]
Ticket Field
To identify the data that you want to get, a value of 'ticket field' is required.
This value identifies the recipient of the market data and it is recommended to use a unique value (such as UUID).
Field Name | Type | Description | Required | Default |
|---|---|---|---|---|
| ticket | String | A value that can identify you | O |
Type Field
In this field, you have to list the market data you want to receive.
"isOnlySnapshot" and "isOnlyRealtime" fields are optional and both snapshot and real-time data will be received if they are omitted.
Multiple {type field} can be specified for a single request.
Field Name | Type | Description | Required | Default |
|---|---|---|---|---|
| type | String | data type - ticker: Current market price- trade: Transaction- orderbook: Orders | O | |
| codes | List | Market code list *Must be requested in capital letters. | O | |
| isOnlySnapshot | Boolean | Only provides snapshot data | X | false |
| isOnlyRealtime | Boolean | Only provides real-time data | X | false |
'codes' in private data
For private data, if the
codesfield is omitted or requested as an empty array, you can receive information for all markets.
Format Field
If specified as "Simple", the response field names will be simplified. This is for reducing the traffic burden.
Field Name | Type | Description | Required | Default |
|---|---|---|---|---|
| format | String | Format to receive - DEFAULT: default format- SIMPLE: simplified format | X | DEFAULT |