Trades

WebSocket Endpoint

Type	Endpoint
Public	`wss://{region}-api.upbit.com/websocket/v1`

Use the endpoint for your region.

Region	Endpoint
Singapore	`wss://sg-api.upbit.com/websocket/v1`
Indonesia	`wss://id-api.upbit.com/websocket/v1`
Thailand	`wss://th-api.upbit.com/websocket/v1`

Request Message Format

To request announcement data, after establishing a WebSocket connection, create a JSON Object with the structure below and include it as a Data Type Object in the request message.

For the complete WebSocket request message specification, including the Ticket and Format Objects, refer to the WebSocket Usage and Error Guide.

Field Name	Type	Description	Required	Default
type	String	Data type to receive. Set to `trade` to receive trade data.	Required
codes	List:String	List of trading pairs to receive. Must be requested in uppercase.	Required
is_only_snapshot	Boolean	Provide snapshot data only	Optional	`false`
is_only_realtime	Boolean	Provide real-time data only	Optional	`false`
format	String	Data format to receive. `DEFAULT`: Default format. `SIMPLE`: Simplified format with abbreviated field names. `JSON_LIST`: List format. `SIMPLE_LIST`: List format with abbreviated field names.	Required

Subscription Data Specification

When a new announcement is published or an existing announcement is updated, real-time stream data is returned as follows.

Field Name	Abbreviation	Description	Type	Value Example
type	ty	Data Types	String	`trade`
code	cd	Trading pair code	String	`SGD-BTC`
trade_price	tp	Current trade price	Double
trade_volume	tv	Most recent trade volume	Double
ask_bid	ab	Buy/Sell distinction	String	`ASK` : Sell `BID` : Buy
prev_closing_price	pcp	Previous day closing price	Double
change	c	Direction of price change compared to previous day closing price	String	`RISE` : Rise `EVEN` : Even `FALL` : Fall
change_price	cp	Absolute price change compared to previous day	Double
trade_date	td	Trade date (UTC)	String	`yyyy-MM-dd`
trade_time	ttm	Trade time (UTC)	String	`HH:mm:ss`
trade_timestamp	ttms	Trade timestamp (ms)	Long
timestamp	tms	Timestamp (ms)	Long
sequential_id	sid	Trade number (unique)	Long
best_ask_price	bap	Best ask price	Double
best_ask_size	bas	Best ask size	Double
best_bid_price	bbp	Best bid price	Double
best_bid_size	bbs	Best bid size	Double
stream_type	st	Stream type	String	`SNAPSHOT` : Snapshot `REALTIME` : Real-time

Examples

Subscription Request Example

[
  {
    "ticket": "test"
  },
  {
    "type": "trade",
    "codes": ["SGD-BTC","SGD-ETH"]
  },
  {
    "format": "DEFAULT"
  }
]

Subscription Data Example

{
  "type": "trade",
  "code": "SGD-BTC",
  "timestamp": 1696585056910,
  "trade_date": "2023-10-06",
  "trade_time": "09:37:36",
  "trade_timestamp": 1696585056846,
  "trade_price": 37625,
  "trade_volume": 8.428e-05,
  "ask_bid": "ASK",
  "prev_closing_price": 37296,
  "change": "RISE",
  "change_price": 329,
  "sequential_id": 1696585056846000,
  "best_ask_price": 32293000,
  "best_ask_size": 0.04414411,
  "best_bid_price": 32291000,
  "best_bid_size": 0.01202163,
  "stream_type": "SNAPSHOT"
}
...
{
  "type": "trade",
  "code": "SGD-ETH",
  "timestamp": 1696585254027,
  "trade_date": "2023-10-06",
  "trade_time": "09:40:53",
  "trade_timestamp": 1696585253974,
  "trade_price": 2224,
  "trade_volume": 0.00210894,
  "ask_bid": "ASK",
  "prev_closing_price": 2192,
  "change": "RISE",
  "change_price": 32,
  "sequential_id": 1696585253974000,
  "best_ask_price": 32293000,
  "best_ask_size": 0.04414411,
  "best_bid_price": 32291000,
  "best_bid_size": 0.01202163,
  "stream_type": "REALTIME"
}

Error Information

If an error occurs after establishing a WebSocket connection and sending a request, the response is returned in the following JSON format.

{
  "error": {
    "name": "ERROR_CODE",
    "message": "ERROR_MESSAGE"
  }
}

The main error codes that may be returned are listed below.

`error.name`	Reason	Recommended Action
`INVALID_AUTH`	Missing authentication information or authentication token verification failure	When using a Private WebSocket endpoint, make sure you are connected to the correct endpoint and that the `Authorization` header contains a valid authentication token.
`WRONG_FORMAT`	Invalid request message format	Make sure the request message follows the WebSocket request format. Check the Object structure as well as the type and value of each field.
`NO_TICKET`	Missing `ticket` field	Make sure the request message includes a Ticket Object and the `ticket` field.
`NO_TYPE`	Missing `type` field	Make sure the Data Type Object includes the `type` field and specify the data type to subscribe to.
`NO_CODES`	Missing `codes` field	Check whether the subscribed data type requires the `codes` field and specify the trading pair codes to receive.
`INVALID_PARAM`	Missing required request field or unsupported value	Make sure all required fields are included and that each field contains a supported value.
`Too Many Requests`	Request rate limit exceeded	Wait until another request can be made, then retry. Refer to the Rate Limits section for details.
`I'm a teapot`	Requests are temporarily restricted due to repeated `Too Many Requests` errors	Check the restriction period included in the response and retry after the specified time has passed.

Rate Limits

APIs are grouped into Rate Limit groups. APIs within the same group share the same per-second request limit.

The maximum number of requests allowed per Rate Limit group may change after prior notice according to service policy, and additional restrictions may be applied depending on service conditions. For details, refer to Rate Limits.

Rate Limit Group	Policy	Applied By
`websocket-connect`	Up to 5 connections per second	IP
`websocket-message`	Up to 5 messages per second and 100 messages per minute	Connection

Managing WebSocket Rate Limits
Unlike REST API responses, WebSocket does not provide the number of remaining requests. Clients should track the number of WebSocket connection attempts and data request messages they send to ensure compliance with the applicable rate limits. If a rate limit is reached, wait for an appropriate period before sending another request..