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 | 데이터 타입 - trade: 체결 | O | |
| codes | List | 마켓 코드 리스트 *대문자로 요청해야 합니다. | O | |
| is_only_snapshot | Boolean | 스냅샷 시세만 제공 | X | false |
| is_only_realtime | Boolean | 실시간 시세만 제공 | X | false |
Response
| 필드명 | 축약형 (format: SIMPLE) | 내용 | 타입 | 값 |
|---|---|---|---|---|
| type | ty | 타입 | String | trade : 체결 |
| code | cd | 마켓 코드 (ex. KRW-BTC) | String | |
| trade_price | tp | 체결 가격 | Double | |
| trade_volume | tv | 체결량 | Double | |
| ask_bid | ab | 매수/매도 구분 | String | ASK : 매도BID : 매수 |
| prev_closing_price | pcp | 전일 종가 | Double | |
| change | c | 전일 대비 | String | RISE : 상승EVEN : 보합FALL : 하락 |
| change_price | cp | 부호 없는 전일 대비 값 | Double | |
| trade_date | td | 체결 일자(UTC 기준) | String | yyyy-MM-dd |
| trade_time | ttm | 체결 시각(UTC 기준) | String | HH:mm:ss |
| trade_timestamp | ttms | 체결 타임스탬프 (millisecond) | Long | |
| timestamp | tms | 타임스탬프 (millisecond) | Long | |
| sequential_id | sid | 체결 번호 (Unique) | Long | |
| stream_type | st | 스트림 타입 | String | SNAPSHOT : 스냅샷REALTIME : 실시간 |
*sequential_id 필드는 체결의 유일성 판단을 위한 근거로 쓰일 수 있습니다. 하지만 체결의 순서를 보장하지는 못합니다.
Example
[
{
"ticket": "test example"
},
{
"type": "trade",
"codes": [
"KRW-BTC",
"KRW-ETH"
]
},
{
"format": "DEFAULT"
}
]
Response
{
"type": "trade",
"code": "KRW-BTC",
"timestamp": 1676965220452,
"trade_date": "2023-02-21",
"trade_time": "07:40:20",
"trade_timestamp": 1676965220395,
"trade_price": 32292000,
"trade_volume": 0.03096742,
"ask_bid": "BID",
"prev_closing_price": 31883000.00000000,
"change": "RISE",
"change_price": 409000.00000000,
"sequential_id": 1676965220395000,
"stream_type": "SNAPSHOT"
}