Private 타입 endpoint
새롭게 추가된
myOrder와myAsset타입의 경우wss://api.upbit.com/websocket/v1/private으로 요청하셔야 합니다. 자세한 내용은 기본 정보 를 참고해주시기 바랍니다.
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
수신하고 싶은 시세 정보를 나열하는 필드입니다.
필드명 | 타입 | 내용 | 필수 여부 | 기본 값 |
|---|---|---|---|---|
| type | String | 데이터 타입 - myOrder: 내 주문 | O | |
| codes | List | 마켓 코드 리스트 *대문자로 요청해야 합니다. | X | 생략하거나 빈 배열로 요청할 경우 모든 마켓에 대한 정보를 수신합니다. |
Response
- 자전거래 체결 방지 (Self-Match Prevention) 주문 옵션 필드가 추가됩니다. (상세 설명 바로가기)
smp_type:reduce,cancel_maker,cancel_taker- 주문 상태 state 필드에
prevented(체결 방지) 타입이 신규로 추가됩니다.- 신규 주문 조건
post_only가 추가되어 time_in_force 필드에post_only타입이 신규로 추가됩니다.
myOrder타입의 경우 특정 이벤트가 발생할 때만 데이터를 전송합니다.따라서, 연결 후 즉시 데이터가 수신되지 않는 경우는 정상적인 동작입니다. 주문의 생성/체결/취소와 같은 이벤트가 발생할 때 데이터가 전송됩니다.
데이터 없이도 연결을 유지하고 싶으신 경우 주기적으로 ping/pong 을 통해 connection 관리를 하실 수 있습니다.
| 필드명 | 축약형 (format: SIMPLE) | 내용 | 타입 | 값 |
|---|---|---|---|---|
| type | ty | 타입 | String | myOrder : 내 주문 |
| code | cd | 마켓 코드 (ex. KRW-BTC) | String | |
| uuid | uid | 주문 고유 아이디 | String | |
| ask_bid | ab | 매수/매도 구분 | String | ASK : 매도BID : 매수 |
| order_type | ot | 주문 타입 | String | limit: 지정가 주문price: 시장가 매수 주문market: 시장가 매도 주문best: 최유리 지정가 주문 |
| state | s | 주문 상태 | String | wait: 체결 대기watch: 예약 주문 대기trade: 체결 발생done: 전체 체결 완료cancel: 주문 취소prevented: 체결 방지 |
| trade_uuid | tuid | 체결의 고유 아이디 | String | |
| price | p | 주문 가격, 체결 가격 (state: trade 일 때) | Double | |
| avg_price | ap | 평균 체결 가격 | Double | |
| volume | v | 주문량, 체결량 (state: trade 일 때) | Double | |
| remaining_volume | rv | 체결 후 남은 주문 양 | Double | |
| executed_volume | ev | 체결된 양 | Double | |
| trades_count | tc | 해당 주문에 걸린 체결 수 | Integer | |
| reserved_fee | rsf | 수수료로 예약된 비용 | Double | |
| remaining_fee | rmf | 남은 수수료 | Double | |
| paid_fee | pf | 사용된 수수료 | Double | |
| locked | l | 거래에 사용중인 비용 | Double | |
| executed_funds | ef | 체결된 금액 | Double | |
| time_in_force | tif | IOC, FOK, POST ONLY 설정 | String | iocfokpost_only |
| trade_fee | tf | 체결 시 발생한 수수료 ( trade 타입이 아닐 경우 null 값) | Double | |
| is_maker | im | 체결이 발생한 주문의 maker / taker 여부 ( trade 타입이 아닐 경우 null 값) | Boolean | true : 메이커 주문false : 테이커 주문 |
| identifier | id | 조회용 사용자 지정값 *identifier 필드는 2024-10-18 이후에 생성된 주문에 대해서만 제공합니다. | String | |
| smp_type | smpt | 자전거래 체결 방지 타입 (동일 회원의 maker, taker 주문 간 체결 방지) | String | reduce :동일 회원의 maker와 taker 주문이 자전거래 체결될 상황에서, 체결될 금액(수량)만큼 주문을 줄이고(잔량이 0이면 취소) 진행 cancel_maker :자전거래 체결될 상황이면, maker 주문을 취소하고 taker 주문은 유지 cancel_taker : 자전거래 체결될 상황이면, taker 주문을 취소하고 maker 주문은 유지 |
| prevented_volume | pv | 자전거래 체결 방지로 인해 취소된 주문 수량 | Double | |
| prevented_locked | pl | (매수 시) 자전거래 체결 방지 설정으로 인해 취소된 금액 (매도 시) 자전거래 체결 방지 설정으로 인해 취소된 수량 | Double | |
| trade_timestamp | ttms | 체결 타임스탬프 (millisecond) | Long | |
| order_timestamp | otms | 주문 타임스탬프 (millisecond) | Long | |
| timestamp | tms | 타임스탬프 (millisecond) | Long | |
| stream_type | st | 스트림 타입 | String | REALTIME : 실시간 |
Example
Request
예제 1. 모든 마켓 정보 수신 (codes 필드 제외)
[
{
"ticket": "test-myOrder"
},
{
"type": "myOrder"
}
]
예제 2. 모든 마켓 정보 수신 (codes 에 빈 배열)
[
{
"ticket": "test-myOrder"
},
{
"type": "myOrder",
"codes": []
}
]
예제 3. 특정 마켓 정보 수신
[
{
"ticket": "test-myOrder"
},
{
"type": "myOrder",
"codes": ["KRW-BTC"]
}
]
예제 4. List 포맷으로 정보 수신
[
{
"ticket": "test-myOrder"
},
{
"type": "myOrder",
"codes": ["KRW-BTC"]
},
{
"format": "JSON_LIST"
}
]
Response
{
"type": "myOrder",
"code": "KRW-BTC",
"uuid": "ac2dc2a3-fce9-40a2-a4f6-5987c25c438f",
"ask_bid": "BID",
"order_type": "limit",
"state": "trade",
"trade_uuid": "68315169-fba4-4175-ade3-aff14a616657",
"price": 0.001453,
"avg_price": 0.00145372,
"volume": 30925891.29839369,
"remaining_volume": 29968038.09235948,
"executed_volume": 30925891.29839369,
"trades_count": 1,
"reserved_fee": 44.23943970238218,
"remaining_fee": 21.77177967409916,
"paid_fee": 22.467660028283017,
"locked": 43565.33112787242,
"executed_funds": 44935.32005656603,
"time_in_force": null,
"trade_fee": 22.467660028283017,
"is_maker": true,
"identifier": "test-1",
"smp_type": "cancel_maker",
"prevented_volume": 1.174291929,
"prevented_locked": 0.001706246173,
"trade_timestamp": 1710751590421,
"order_timestamp": 1710751590000,
"timestamp": 1710751597500,
"stream_type": "REALTIME"
}
[
{
"type": "myOrder",
"code": "KRW-BTC",
"uuid": "ac2dc2a3-fce9-40a2-a4f6-5987c25c438f",
"ask_bid": "BID",
"order_type": "limit",
"state": "trade",
"trade_uuid": "68315169-fba4-4175-ade3-aff14a616657",
"price": 0.001453,
"avg_price": 0.00145372,
"volume": 30925891.29839369,
"remaining_volume": 29968038.09235948,
"executed_volume": 30925891.29839369,
"trades_count": 1,
"reserved_fee": 44.23943970238218,
"remaining_fee": 21.77177967409916,
"paid_fee": 22.467660028283017,
"locked": 43565.33112787242,
"executed_funds": 44935.32005656603,
"time_in_force": null,
"trade_fee": 22.467660028283017,
"is_maker": true,
"identifier": "test-1",
"smp_type": "cancel_maker",
"prevented_volume": 1.174291929,
"prevented_locked": 0.001706246173,
"trade_timestamp": 1710751590421,
"order_timestamp": 1710751590000,
"timestamp": 1710751597500,
"stream_type": "REALTIME"
}
]