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 | 데이터 타입 - myAsset: 내 자산 | O |
Response
myAsset타입의 경우 특정 이벤트가 발생할 때만 데이터를 전송합니다.따라서, 연결 후 즉시 데이터가 수신되지 않는 경우는 정상적인 동작입니다. 주문의 체결/입출금과 같이 자산이 변동되는 이벤트가 발생할 때 데이터가 전송됩니다.
데이터 없이도 연결을 유지하고 싶으신 경우 주기적으로 ping/pong 을 통해 connection 관리를 하실 수 있습니다.
| 필드명 | 축약형 (format: SIMPLE) | 내용 | 타입 | 값 |
|---|---|---|---|---|
| type | ty | 타입 | String | myAsset : 내 자산 |
| asset_uuid | astuid | 자산 고유 아이디 | String | |
| assets | ast | 자산 리스트 | List of Objects | |
| assets.currency | ast.cu | 화폐를 의미하는 영문 대문자 코드 | String | |
| assets.balance | ast.b | 주문가능 수량 | Double | |
| assets.locked | ast.l | 주문 중 묶여있는 수량 | Double | |
| asset_timestamp | asttms | 자산 타임스탬프 (millisecond) | Long | |
| timestamp | tms | 타임스탬프 (millisecond) | Long | |
| stream_type | st | 스트림 타입 | String | REALTIME : 실시간 |
최초 이용 시 주의 사항최초 이용 시 수 분간 데이터 전송이 이뤄지지 않을 수 있습니다. 따라서 개발 시 데이터 수신을 1회 꼭 확인하시길 바랍니다.
예를 들어 2024년 5월 1일 00시 00분 최초 이용 시 자산 변동이 있더라도 00시 05분부터 데이터를 전송받을 수 있습니다. 이후 00시 10분에 재접속을 할 경우 이는 최초 이용이 아니므로 자산 변동 시 바로 데이터를 수신하실 수 있습니다.
Example
Request
예제 1. 모든 마켓 정보 수신
*주의사항: codes 필드를 요청하실 수 없습니다. 이 경우 WRONG_FORMAT 에러가 내려가게 됩니다.
[
{
"ticket": "test-myAsset"
},
{
"type": "myAsset"
}
]Response
{
"type": "myAsset",
"asset_uuid": "e635f223-1609-4969-8fb6-4376937baad6",
"assets": [
{
"currency": "KRW",
"balance": 1386929.37231066771348207123,
"locked": 10329.670127489597585685
}
],
"asset_timestamp": 1710146517259,
"timestamp": 1710146517267,
"stream_type": "REALTIME"
}