My Asset

This document provides example request and subscription payloads for receiving personal asset data via WebSocket.

Real-Time Streaming Method for My Asset

For My Asset data, the real-time stream transmits updates only when there is an actual change in the asset balance. Therefore, it is normal behavior that no data is received if no asset changes occur after connection. Please refer to the WebSocket Usage Guide – Connection Management to ensure your client implementation maintains the connection even when no data is transmitted.

Important Notice for Initial Use of My Asset WebSocket Stream

When subscribing to the My Asset WebSocket stream for the first time, data reception may not occur properly for several minutes regardless of asset changes. After the initial connection to the account, please ensure to verify data reception through reconnection or other means before using the stream. For example, if you first use the stream at 00:00 on May 1, 2025, even if asset changes occur, the stream data might only start transmitting from 00:05. Upon reconnecting at 00:10, since this is not the initial connection, the stream will provide immediate updates upon asset changes.

WebSocket Endpoint

TypeEndpoint
Privatewss://{region}-api.upbit.com/websocket/v1/private

Use the endpoint for your region.

RegionEndpoint
Singaporewss://sg-api.upbit.com/websocket/v1/private
Indonesiawss://id-api.upbit.com/websocket/v1/private
Thailandwss://th-api.upbit.com/websocket/v1/private

Private WebSocket Connection Management Guide

  • The /websocket/v1/private Endpoint is subject to a concurrent connection limit of 5 connections per Account. New connection requests exceeding this limit are rejected with an HTTP 429 too_many_connections error.
  • Connections maintained using multiple API Keys issued under the same Account are counted together, while connection limits are applied separately to each Endpoint. Please close any unused connections. For more details, refer to the WebSocket Usage and Error Guide.

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 NameTypeDescriptionRequiredDefault
typeStringData type to receive. Set to myAsset to receive data.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 NameAbbreviationDescriptionTypeValue Example
typetyData typeStringmyAsset
asset_uuidastuidUnique identifier of the assetString
assetsastList of assetsList of Objects
assets.currencyast.cuCurrency codeString
assets.balanceast.bAvailable quantity for ordersDouble
assets.lockedast.lQuantity locked in active ordersDouble
asset_timestampasttmsAsset timestamp (ms)Long
timestamptmsTimestamp (ms)Long
stream_typestStream typeStringREALTIME : Real-time

Examples

Subscription Request Example

[
  {
    "ticket": "0e66c0ac-7e13-43ef-91fb-2a87c2956c49"
  },
  {
    "type": "myAsset"
  }
]

Subscription Data Example

{
  "type": "myAsset",
  "asset_uuid": "e635f223-1609-4969-8fb6-4376937baad6",
  "assets": [
    {
      "currency": "SGD",
      "balance": 1386929.37231066771348207123,
      "locked": 10329.670127489597585685
    }
  ],
  "asset_timestamp": 1710146517259,
  "timestamp": 1710146517267,
  "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.nameReasonRecommended Action
INVALID_AUTHMissing authentication information or authentication token verification failureWhen 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_FORMATInvalid request message formatMake sure the request message follows the WebSocket request format. Check the Object structure as well as the type and value of each field.
NO_TICKETMissing ticket fieldMake sure the request message includes a Ticket Object and the ticket field.
NO_TYPEMissing type fieldMake sure the Data Type Object includes the type field and specify the data type to subscribe to.
NO_CODESMissing codes fieldCheck whether the subscribed data type requires the codes field and specify the trading pair codes to receive.
INVALID_PARAMMissing required request field or unsupported valueMake sure all required fields are included and that each field contains a supported value.
Too Many RequestsRequest rate limit exceededWait until another request can be made, then retry. Refer to the Rate Limits section for details.

Rate Limits

The maximum number of requests allowed per second may change with prior notice in accordance with service policies, and additional restrictions may apply depending on service conditions. For more details, refer to Rate Limits.

Managing WebSocket Request Rate Limits

The remaining request quota for data request messages sent after a connection is established is not provided. Please track the number of messages sent on the client side.