Request
The requests is consisted of JSON Object and the response is also JSON Object. Requests are divided into ticket field, method field, format field.
Request format
[{Ticket Field},{Method Field},{Format Field}]
Ticket Field
Field Name | Type | Description | Required | Default |
|---|---|---|---|---|
| ticket | String | A value that can identify request | O |
Method Field
Field Name | Type | Description | Required | Default |
|---|---|---|---|---|
| method | String | Method to request - LIST_SUBSCRIPTIONS | O |
Format Field
If specified as "Simple", the response field names will be simplified.
Field Name | Type | Description | Required | Default |
|---|---|---|---|---|
| format | String | Format to receive - DEFAULT: default format- SIMPLE: simplified format | X | DEFAULT |
Notice - Format Field
Please request with the same Format Field as when receiving real-time data.
The Format Field specifies the overall format for the current connection. Therefore, if you receive WebSocket data in the
SIMPLEformat and then requestLIST_SUBSCRIPTIONSin theDEFAULTformat, the previously requested data will be sent down in theDEFAULTformat.
Response
| Field Name | Simplified Format (format: SIMPLE) | Description | Type | Value |
|---|---|---|---|---|
| method | mthd | Method requested | String | LIST_SUBSCRIPTIONS |
| result | rslt | Result | List of Objects | |
| result.type | rslt.ty | Data type | String | |
| result.codes | rslt.cds | Market code list | List of String | |
| ticket | tckt | Ticket requested | String |
Notice - Request Limit
LIST_SUBSCRIPTIONSis also included in the request limit. For more information, please refer to the 'WebSocket Data Requests' section on the Request Limit Page.
Example
Request
ex 1. LIST_SUBSCRIPTIONS request
[
{
"method": "LIST_SUBSCRIPTIONS"
},
{
"type": "unique uuid"
}
]
Response
ex 1. public data
{
"method": "LIST_SUBSCRIPTIONS",
"result": [
{
"type": "ticker",
"codes": ["BTC-ETH"]
},
{
"type": "orderbook",
"codes": ["BTC-ETH"]
}
],
"ticket": "unique uuid"
}
ex 2. private data
{
"method": "LIST_SUBSCRIPTIONS",
"result": [
{
"type": "myAsset"
},
{
"type": "myOrder",
"codes": ["BTC-ETH"]
}
],
"ticket": "unique uuid"
}