Request
요청은 JSON Object를 이용하며 응답 또한 JSON Object 입니다. 요청은 크게 ticket field, type field, format field 로 나누어지며 하나의 요청에 여러 개의 type field 를 명시할 수 있습니다. ticket field 와 format field 에 대해서는 요청 방법 및 포맷을 참고해주시기 바랍니다.
Request format
[{Ticket Field},{Type Field},....,{Type Field},{Format Field}]
Type Field
수신하고 싶은 시세 정보를 나열하는 필드입니다.
is_only_snapshot, is_only_realtime 필드는 생략 가능하며 모두 생략시 스냅샷과 실시간 데이터 모두를 수신합니다.
필드명 | 타입 | 내용 | 필수 여부 | 기본 값 |
|---|---|---|---|---|
| type | String | 데이터 타입 - orderbook: 호가 | O | |
| codes | List | 마켓 코드 리스트 *대문자로 요청해야 합니다. | O | |
| level | Double | 모아보기 단위 | X | |
| is_only_snapshot | Boolean | 스냅샷 시세만 제공 | X | false |
| is_only_realtime | Boolean | 실시간 시세만 제공 | X | false |
v1.4.4 호가 모아보기 기능 추가 (원화마켓만 지원)
v1.4.4 부터
level항목을 통해 호가 모아보기를 지원합니다.
지원하는 전체 단위는 아래와 같으며 각 종목별 호가 단위에 따라 지원하는 단위가 다릅니다.
*종목별로 지원하는 모아보기 단위는 v1/orderbook/supported_levels 에서 확인하실 수 있습니다.
해당 종목에서 지원하지 않는level단위를 넣을 경우 수신받으실 데이터가 없으니 주의해주세요- 100000000 - 10000000 - 1000000 - 100000 - 10000 - 1000 - 100 - 10 - 1 - 0 - 0.1 - 0.01 - 0.001 - 0.0001 - 0.00001 - 0.000001 - 0.0000001
v1.1.0 Orderbook Unit 갯수 커스텀 수신기능 추가
v1.1.0 부터 orderbook 타입의 패킷에 한하여 Orderbook Unit의 갯수를 최대 제공 갯수 (15개) 안에서 원하는 만큼 조절하여 호출 가능합니다. 기존의
codes항목에 시세 종목과 원하는 Unit 갯수를 넣어주시면 됩니다.형식:
{code}.{count}
ex) "KRW-BTC.5", "BTC-XRP.3"
Response
| 필드명 | 축약형 (format: SIMPLE) | 내용 | 타입 | 값 |
|---|---|---|---|---|
| type | ty | 타입 | String | orderbook : 호가 |
| code | cd | 마켓 코드 (ex. KRW-BTC) | String | |
| total_ask_size | tas | 호가 매도 총 잔량 | Double | |
| total_bid_size | tbs | 호가 매수 총 잔량 | Double | |
| orderbook_units | obu | 호가 | List of Objects | |
| orderbook_units.ask_price | obu.ap | 매도 호가 | Double | |
| orderbook_units.bid_price | obu.bp | 매수 호가 | Double | |
| orderbook_units.ask_size | obu.as | 매도 잔량 | Double | |
| orderbook_units.bid_size | obu.bs | 매수 잔량 | Double | |
| timestamp | tms | 타임스탬프 (millisecond) | Long | |
| level | lv | 호가 모아보기 단위 (default: 0, 기본 호가단위) *호가 모아보기 기능은 원화마켓(KRW)에서만 지원하므로 BTC, USDT 마켓의 경우 0만 존재합니다. *종목별 지원하는 모아보기 단위는 v1/orderbook/supported_levels 에서 확인하실 수 있습니다. | Double | 모아보기 단위 |
Example
Request
level 값은 필수가 아니며, 제외될 경우 DEFUALT(0), 기본 호가단위로 내려갑니다.
[
{
"ticket": "test"
},
{
"type": "orderbook",
"codes": [
"KRW-BTC",
"KRW-ETH.3"
],
"level": 10000
},
{
"format": "DEFAULT"
}
]
종목별로 각기다른 모아보기 level 값을 지정하기 위해서는 아래와 같이 요청할 수 있습니다.
[
{
"ticket": "test"
},
{
"type": "orderbook",
"codes": [
"KRW-BTC"
],
"level": 10000
},
{
"type": "orderbook",
"codes": [
"KRW-BTT"
],
"level": 0
},
{
"format": "DEFAULT"
}
]
Response
{
"type": "orderbook",
"code": "KRW-BTC",
"timestamp": 1704867306396,
"total_ask_size": 7.3262086,
"total_bid_size": 29.27948667,
"orderbook_units": [
{
"ask_price": 61820000,
"bid_price": 61800000,
"ask_size": 1.44125174,
"bid_size": 8.95463042
},
{
"ask_price": 61830000,
"bid_price": 61790000,
"ask_size": 0.025,
"bid_size": 2.65037043
},
{
"ask_price": 61840000,
"bid_price": 61780000,
"ask_size": 0.00161707,
"bid_size": 0.26890135
},
{
"ask_price": 61850000,
"bid_price": 61770000,
"ask_size": 0.06059401,
"bid_size": 0.63729629
},
{
"ask_price": 61860000,
"bid_price": 61760000,
"ask_size": 0.08702514,
"bid_size": 0.33709503
},
{
"ask_price": 61870000,
"bid_price": 61750000,
"ask_size": 0.21193036,
"bid_size": 0.62382278
},
{
"ask_price": 61880000,
"bid_price": 61740000,
"ask_size": 0.95938473,
"bid_size": 1.14006691
},
{
"ask_price": 61890000,
"bid_price": 61730000,
"ask_size": 0.35962299,
"bid_size": 0.90819049
},
{
"ask_price": 61900000,
"bid_price": 61720000,
"ask_size": 1.02822787,
"bid_size": 5.32751807
},
{
"ask_price": 61910000,
"bid_price": 61710000,
"ask_size": 0.09103111,
"bid_size": 0.54694518
},
{
"ask_price": 61920000,
"bid_price": 61700000,
"ask_size": 2.86063421,
"bid_size": 1.90083344
},
{
"ask_price": 61930000,
"bid_price": 61690000,
"ask_size": 0.11484434,
"bid_size": 3.40407167
},
{
"ask_price": 61940000,
"bid_price": 61680000,
"ask_size": 0.01953653,
"bid_size": 1.23800334
},
{
"ask_price": 61950000,
"bid_price": 61670000,
"ask_size": 0.02769878,
"bid_size": 0.24941321
},
{
"ask_price": 61960000,
"bid_price": 61660000,
"ask_size": 0.03780972,
"bid_size": 1.09232806
}
],
"stream_type": "REALTIME",
"level": 10000
}