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
Orderbook Unit 개수 커스텀 수신기능 추가
orderbook 타입의 패킷에 한하여 Orderbook Unit의 개수를 조절하여 호출 가능합니다. 기존의
codes항목에 시세 종목과 원하는 Unit 개수를 넣어주시면 됩니다.
- 형식:
{code}.{count}
ex) "KRW-BTC.5", "BTC-XRP.5"- 지원하는 count: 1, 5, 15, 30
*이외의 값일 경우 기본 값인 30 호가로 내려가게 됩니다.
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.5"
],
"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": 1746601573804,
"total_ask_size": 4.79158413,
"total_bid_size": 2.65609625,
"orderbook_units": [
{
"ask_price": 137002000,
"bid_price": 137001000,
"ask_size": 0.10623869,
"bid_size": 0.03656812
},
{
"ask_price": 137023000,
"bid_price": 137000000,
"ask_size": 0.06144079,
"bid_size": 0.33543284
},
{
"ask_price": 137050000,
"bid_price": 136999000,
"ask_size": 0.0055433,
"bid_size": 0.00104379
},
{
"ask_price": 137052000,
"bid_price": 136980000,
"ask_size": 0.00452071,
"bid_size": 0.32709281
},
{
"ask_price": 137053000,
"bid_price": 136978000,
"ask_size": 0.12781487,
"bid_size": 0.00875219
},
{
"ask_price": 137054000,
"bid_price": 136976000,
"ask_size": 0.03777519,
"bid_size": 0.01867952
},
{
"ask_price": 137055000,
"bid_price": 136975000,
"ask_size": 0.06073315,
"bid_size": 0.04379996
},
{
"ask_price": 137056000,
"bid_price": 136971000,
"ask_size": 0.00372511,
"bid_size": 0.00036504
},
{
"ask_price": 137060000,
"bid_price": 136970000,
"ask_size": 0.00308733,
"bid_size": 0.15547631
},
{
"ask_price": 137065000,
"bid_price": 136969000,
"ask_size": 0.04218546,
"bid_size": 0.00036504
},
{
"ask_price": 137070000,
"bid_price": 136942000,
"ask_size": 0.01172394,
"bid_size": 0.00021907
},
{
"ask_price": 137071000,
"bid_price": 136931000,
"ask_size": 0.001,
"bid_size": 0.00260654
},
{
"ask_price": 137076000,
"bid_price": 136930000,
"ask_size": 0.00120371,
"bid_size": 0.00014606
},
{
"ask_price": 137079000,
"bid_price": 136924000,
"ask_size": 0.00007303,
"bid_size": 0.00004381
},
{
"ask_price": 137080000,
"bid_price": 136911000,
"ask_size": 0.01051428,
"bid_size": 0.09531
},
{
"ask_price": 137084000,
"bid_price": 136910000,
"ask_size": 0.00004,
"bid_size": 0.01354743
},
{
"ask_price": 137086000,
"bid_price": 136906000,
"ask_size": 0.00643152,
"bid_size": 0.00519774
},
{
"ask_price": 137091000,
"bid_price": 136902000,
"ask_size": 0.0105,
"bid_size": 0.00485
},
{
"ask_price": 137098000,
"bid_price": 136898000,
"ask_size": 4.0534502,
"bid_size": 0.01017513
},
{
"ask_price": 137099000,
"bid_price": 136897000,
"ask_size": 0.00995,
"bid_size": 0.0002599
},
{
"ask_price": 137100000,
"bid_price": 136895000,
"ask_size": 0.14272057,
"bid_size": 0.01245
},
{
"ask_price": 137104000,
"bid_price": 136893000,
"ask_size": 0.0012294,
"bid_size": 0.01468299
},
{
"ask_price": 137109000,
"bid_price": 136892000,
"ask_size": 0.009,
"bid_size": 0.0042
},
{
"ask_price": 137112000,
"bid_price": 136890000,
"ask_size": 0.03154608,
"bid_size": 0.00385
},
{
"ask_price": 137113000,
"bid_price": 136881000,
"ask_size": 0.00136546,
"bid_size": 0.00080361
},
{
"ask_price": 137120000,
"bid_price": 136880000,
"ask_size": 0.00325241,
"bid_size": 0.01460539
},
{
"ask_price": 137123000,
"bid_price": 136879000,
"ask_size": 0.02020901,
"bid_size": 1.203
},
{
"ask_price": 137124000,
"bid_price": 136874000,
"ask_size": 0.00734507,
"bid_size": 0.00791911
},
{
"ask_price": 137135000,
"bid_price": 136868000,
"ask_size": 0.0002192,
"bid_size": 0.01735219
},
{
"ask_price": 137137000,
"bid_price": 136861000,
"ask_size": 0.01674565,
"bid_size": 0.31730166
}
],
"stream_type": "SNAPSHOT",
"level": 0
}