Announcement

This document provides example request and subscription payloads for receiving Upbit(Singapore, Indonesia, Thailand) announcement data via WebSocket.

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

When a large number of Private WebSocket connections are maintained simultaneously, new connection attempts may be rejected. Please minimize unnecessary connections and, where possible, subscribe to the required data types through a single existing connection.

No data is sent unless a new announcement is published or an existing announcement is updated.

Announcement data is transmitted in real time only when a new announcement is published or an existing announcement is updated. Therefore, it is normal to receive no data after establishing a WebSocket connection if no new announcement is published or updated.

Announcement data supports real-time streams only, and stream_type is provided as REALTIME. For details on WebSocket connection and authentication, refer to the WebSocket Usage and Error Guide.

Announcement delivery timing may vary by channel.

Announcements are provided only in the default language of each region.

If an announcement is not available in the default language of the region, a predefined message is returned instead. Empty data or content in another language is not returned.

  • title: This announcement is currently not available in [language].
  • body: Announcements available in other languages can be viewed through the provided link.

Announcement Language

Announcements are provided only in the default language of each region.

If an announcement is not available in the default language of the region, a predefined message is returned instead. Empty data or content in another language is not returned.

  • title: This announcement is currently not available in language.
  • body: Announcements available in other languages can be viewed through the provided link.

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 announcement to receive announcement data.Required
categoriesList:StringList of announcement categories to receive. If omitted, announcements from all supported categories are received. If the request includes an unsupported value, an INVALID_PARAM error is returned.OptionalAll
include_bodyBooleanWhether to include the announcement body. If set to true, the body field is included in the subscription data. If the body data is too large, it may be returned as null.Optionalfalse
formatStringData 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

Announcement Categories (categories)

You can specify categories to subscribe only to announcements in selected categories. If omitted, announcements from all supported categories are received.

Available categories may vary by region. If a request includes a category that is not supported in the connected region, an INVALID_PARAM error is returned.

Categorycategories ValueTHIDSGDescription
NotenoteGeneral announcements related to service usage and updates
TradingtradingAnnouncements related to trading support, market changes, investment warnings, and termination of trading support
WalletwalletAnnouncements related to digital asset deposits and withdrawals, including suspensions and resumptions
MaintenancemaintenanceAnnouncements related to system and service maintenance
Digital Assetdigital_assetAnnouncements related to digital assets
AirdropairdropAnnouncements related to airdrops
EventeventAnnouncements related to Upbit events
FeaturefeatureAnnouncements related to new features and service improvements
DisclosuredisclosureDisclosure-related announcements

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
typetyData typeStringannouncement
event_typeetAnnouncement event typeStringCREATED: New announcement published
UPDATED: Existing announcement updated
uuiduidUnique identifier of the announcementString
titlettAnnouncement titleString
categorycatAnnouncement categoryStringExample: trading, wallet, maintenance, digital_asset
urlurlURL of the announcement detail pageString
first_listed_atflatInitial publication timeStringISO 8601
listed_atlatLatest publication time. Updated when the announcement is updated.StringISO 8601
timestamptmsTimestamp (ms)Long
stream_typestStream typeStringREALTIME: Real-time stream
bodybdAnnouncement body in Markdown format. Included only when include_body is set to true in the request.String

Examples

Subscribe to All Announcements

This example subscribes to all Upbit announcements without specifying a category. The announcement body is excluded. The ticket field identifies the request and can be set to any string.

Subscription Request Example

[
  {
    "ticket": "announcement-monitor"
  },
  {
    "type": "announcement",
    "include_body": false
  },
  {
    "format": "DEFAULT"
  }
]

Subscription Data Example - New Announcement Published

{
  "type": "announcement",
  "event_type": "CREATED",
  "uuid": "562593104",
  "title": "[Trading] New Trading Support ...",
  "category": "trading",
  "url": "https://sg.upbit.com/service_center/notice?id=562593104",
  "first_listed_at": "2026-07-14T16:36:34+08:00",
  "listed_at": "2026-07-14T16:36:34+08:00",
  "timestamp": 1752566400123,
  "stream_type": "REALTIME"
}

Subscription Data Example - Existing Announcement Updated

{
  "type": "announcement",
  "event_type": "UPDATED",
  "uuid": "562593104",
  "title": "[Trading] New Trading Support (Schedule Updated)",
  "category": "trading",
  "url": "https://sg.upbit.com/service_center/notice?id=562593104",
  "first_listed_at": "2026-07-14T16:36:34+08:00",
  "listed_at": "2026-07-14T21:19:33+08:00",
  "timestamp": 1752570000234,
  "stream_type": "REALTIME"
}

Subscribe to Announcements in a Specific Category

This example specifies trading in categories to subscribe only to trading-related announcements. The announcement body is excluded.

Subscription Request Example

[
  {
    "ticket": "trading-announcement-monitor"
  },
  {
    "type": "announcement",
    "categories": ["trading"],
    "include_body": false
  },
  {
    "format": "DEFAULT"
  }
]

Subscription Data Example

{
  "type": "announcement",
  "event_type": "CREATED",
  "uuid": "562593104",
  "title": "[Trading] New Trading Support ...",
  "category": "trading",
  "url": "https://sg.upbit.com/service_center/notice?id=562593104",
  "first_listed_at": "2026-07-14T16:36:34+08:00",
  "listed_at": "2026-07-14T16:36:34+08:00",
  "timestamp": 1752566400123,
  "stream_type": "REALTIME"
}

Subscribe with Announcement Body

This example subscribes to announcements from all categories and sets include_body to true to receive the announcement body. The ticket field identifies the request and can be set to any string.

If the body data is too large, it may be returned as null.

Subscription Request Example

[
  {
    "ticket": "announcement-subscription"
  },
  {
    "type": "announcement",
    "include_body": true
  },
  {
    "format": "DEFAULT"
  }
]

Subscription Data Example - New Announcement Published

{
  "type": "announcement",
  "event_type": "CREATED",
  "uuid": "562593104",
  "title": "[Trading] New Trading Support ...",
  "category": "trading",
  "url": "https://sg.upbit.com/service_center/notice?id=562593104",
  "first_listed_at": "2026-07-14T16:36:34+08:00",
  "listed_at": "2026-07-14T16:36:34+08:00",
  "timestamp": 1752566400123,
  "stream_type": "REALTIME",
  "body": "Announcement body ..."
}

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.
I'm a teapotRequests are temporarily restricted due to repeated Too Many Requests errorsCheck 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 GroupPolicyApplied By
websocket-connectUp to 5 connections per secondAccount
websocket-messageUp to 5 messages per second and 100 messages per minuteConnection

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..