📘

Endpoint for private type

For the newly added myOrder and myAsset types, requests must be made towss://api.upbit.com/websocket/v1/private. Please refer to the "General Information" for more details.

Request

The requests is consisted of JSON Object and the response is also JSON Object. Requests are divided into ticket field, type field, and format field, and multiple type fields can be specified in one request. Please refer to Request method and format for ticket field and format field.

📘

Request format

[{Ticket Field},{Type Field},....,{Type Field},{Format Field}]

Type Field

In this field, you have to list the market data you want to receive.

Field Name
Type
Description
Required
Default
typeStringdata type
myOrder: My Orders
O
codesListMarket code list
*Must be requested in capital letters.
XIf you omit it or request an empty array, you will receive data for all markets.

Response

Field Name
Simplified Format (format: SIMPLE)
Description
TypeValue
typetyTypeStringmyOrder
codecdMarket code (ex. SDG-BTC)String
uuiduidUnique Order IDString
ask_bidabAsk/BidStringASK
BID
order_typeotOrder methodStringlimit
price
market
best
statesOrder StateStringwait
watch
trade
done
cancel
trade_uuidtuidUnique ID of the transactionString
pricepOrder price,
Transaction price (when state: trade)
Double
avg_priceapAverage transaction priceDouble
volumevOrder volume,
Transaction volume (when state: trade)
Double
remaining_volumervThe amount remaining after the orderDouble
executed_volumeevThe amount of the orders madeDouble
trades_counttcThe number of transactions in the orderInteger
reserved_feersfReserved feesDouble
remaining_feermfRemaining feesDouble
paid_feepfUsed feesDouble
lockedlFund being used in transactionsDouble
executed_fundsefExecuted fundDouble
trade_timestampttmsTransaction timestamp (millisecond)Long
order_timestampotmsOrder timestamp (millisecond)Long
timestamptmstimestamp (millisecond)Long
stream_typestStream typeStringREALTIME
time_in_forceioc, fok settingsStringioc
fok

🚧

About best, price order

In best, price orders, if there is at least one order fulfilled, cancel events are not retrieved. This includes cases where the remaining balance is refunded after order execution.

Example

Request

ex 1. To get all market information (not specify codes field)

[
  {
    "ticket": "test-myorder"
  },
  {
    "type": "myOrder"
  }
]

ex 2. To get all market information (empty array in codes)

[
  {
    "ticket": "test-myorder"
  },
  {
    "type": "myOrder",
    "codes": []
  }
]

ex 3. To get specific market information

[
  {
    "ticket": "test-myorder"
  },
  {
    "type": "myOrder",
    "codes": ["KRW-BTC"]
  }
]

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_timestamp": 1710751590421,
  "order_timestamp": 1710751590000,
  "timestamp": 1710751597500,
  "stream_type": "REALTIME"
}