@upbit-official/upbit-sdk 0.9.0

package/src/resources/ws-public/ws-public.ts

@@ -0,0 +1,561 @@
+
+import { APIResource } from '../../core/resource';
+
+export class WsPublic extends APIResource {}
+
+/**
+ * WebSocket public client event — subscription request sent to server
+ */
+export type ConnectPublicClientEvent =
+  | Array<
+      | ConnectPublicClientEvent.WsTicketField
+      | ConnectPublicClientEvent.WsTickerTypeField
+      | ConnectPublicClientEvent.WsFormatField
+    >
+  | Array<
+      | ConnectPublicClientEvent.WsTicketField
+      | ConnectPublicClientEvent.WsTradeTypeField
+      | ConnectPublicClientEvent.WsFormatField
+    >
+  | Array<
+      | ConnectPublicClientEvent.WsTicketField
+      | ConnectPublicClientEvent.WsOrderbookTypeField
+      | ConnectPublicClientEvent.WsFormatField
+    >
+  | Array<
+      | ConnectPublicClientEvent.WsTicketField
+      | ConnectPublicClientEvent.WsCandleTypeField
+      | ConnectPublicClientEvent.WsFormatField
+    >;
+
+export namespace ConnectPublicClientEvent {
+  /**
+   * Ticket field that identifies the requester
+   */
+  export interface WsTicketField {
+    /**
+     * A value that uniquely identifies the requester (UUID recommended)
+     */
+    ticket: string;
+  }
+
+  /**
+   * Ticker subscription type field
+   */
+  export interface WsTickerTypeField {
+    /**
+     * List of market codes to receive (uppercase)
+     */
+    codes: Array<string>;
+
+    /**
+     * Stream type
+     */
+    type: 'ticker';
+
+    /**
+     * Receive realtime data only
+     */
+    is_only_realtime?: boolean;
+
+    /**
+     * Receive snapshot data only
+     */
+    is_only_snapshot?: boolean;
+  }
+
+  /**
+   * Response format specifier field
+   */
+  export interface WsFormatField {
+    /**
+     * Response format selector
+     */
+    format?: 'DEFAULT' | 'SIMPLE' | 'JSON_LIST' | 'SIMPLE_LIST';
+  }
+
+  /**
+   * Trade subscription type field
+   */
+  export interface WsTradeTypeField {
+    codes: Array<string>;
+
+    type: 'trade';
+
+    is_only_realtime?: boolean;
+
+    is_only_snapshot?: boolean;
+  }
+
+  /**
+   * Orderbook subscription type field
+   */
+  export interface WsOrderbookTypeField {
+    /**
+     * List of market codes. Unit count can be specified as `{code}.{count}`
+     * (1/5/15/30).
+     */
+    codes: Array<string>;
+
+    type: 'orderbook';
+
+    is_only_realtime?: boolean;
+
+    is_only_snapshot?: boolean;
+
+    /**
+     * Orderbook grouping unit (KRW markets only). Defaults to 0 (no grouping) when not
+     * specified.
+     */
+    level?: string;
+  }
+
+  /**
+   * Candle subscription type field. The `type` value follows the `candle.{interval}`
+   * format, determined by the path parameter `interval`.
+   */
+  export interface WsCandleTypeField {
+    codes: Array<string>;
+
+    /**
+     * candle.{interval} format. Examples: candle.1s, candle.1m, candle.240m
+     */
+    type: string;
+
+    is_only_realtime?: boolean;
+
+    is_only_snapshot?: boolean;
+  }
+}
+
+/**
+ * WebSocket public server event — stream message received from server
+ */
+export type ConnectPublicServerEvent =
+  | ConnectPublicServerEvent.Ticker
+  | ConnectPublicServerEvent.Trade
+  | ConnectPublicServerEvent.Orderbook
+  | ConnectPublicServerEvent.WsCandleResponse;
+
+export namespace ConnectPublicServerEvent {
+  /**
+   * Ticker stream message payload (current price)
+   */
+  export interface Ticker {
+    /**
+     * Data type
+     */
+    type: 'ticker';
+
+    /**
+     * Accumulated ask volume
+     */
+    acc_ask_volume?: string;
+
+    /**
+     * Accumulated bid volume
+     */
+    acc_bid_volume?: string;
+
+    /**
+     * Accumulated trade value (since UTC 00:00)
+     */
+    acc_trade_price?: string;
+
+    /**
+     * 24-hour accumulated trade value
+     */
+    acc_trade_price_24h?: string;
+
+    /**
+     * Accumulated trade volume (since UTC 00:00)
+     */
+    acc_trade_volume?: string;
+
+    /**
+     * 24-hour accumulated trade volume
+     */
+    acc_trade_volume_24h?: string;
+
+    /**
+     * Ask/bid side
+     */
+    ask_bid?: 'ASK' | 'BID';
+
+    /**
+     * Price change direction relative to previous close
+     */
+    change?: 'RISE' | 'EVEN' | 'FALL';
+
+    /**
+     * Absolute price change from previous close
+     */
+    change_price?: string;
+
+    /**
+     * Absolute change rate from previous close
+     */
+    change_rate?: string;
+
+    /**
+     * Market code
+     */
+    code?: string;
+
+    /**
+     * Delisting date (only present when delisting is scheduled)
+     */
+    delisting_date?: Ticker.DelistingDate | null;
+
+    /**
+     * High price
+     */
+    high_price?: string;
+
+    /**
+     * Date of 52-week high (yyyy-MM-dd)
+     */
+    highest_52_week_date?: string;
+
+    /**
+     * 52-week high price
+     */
+    highest_52_week_price?: string;
+
+    /**
+     * Low price
+     */
+    low_price?: string;
+
+    /**
+     * Date of 52-week low (yyyy-MM-dd)
+     */
+    lowest_52_week_date?: string;
+
+    /**
+     * 52-week low price
+     */
+    lowest_52_week_price?: string;
+
+    /**
+     * Market trading status
+     */
+    market_state?: 'PREVIEW' | 'ACTIVE' | 'DELISTED';
+
+    /**
+     * Opening price
+     */
+    opening_price?: string;
+
+    /**
+     * Previous day closing price
+     */
+    prev_closing_price?: string;
+
+    /**
+     * Signed price change from previous close
+     */
+    signed_change_price?: string;
+
+    /**
+     * Signed change rate from previous close
+     */
+    signed_change_rate?: string;
+
+    /**
+     * Stream type (snapshot or realtime)
+     */
+    stream_type?: 'SNAPSHOT' | 'REALTIME';
+
+    /**
+     * Timestamp (ms)
+     */
+    timestamp?: number;
+
+    /**
+     * Most recent trade date (UTC, yyyyMMdd)
+     */
+    trade_date?: string;
+
+    /**
+     * Current price (closing price)
+     */
+    trade_price?: string;
+
+    /**
+     * Most recent trade time (UTC, HHmmss)
+     */
+    trade_time?: string;
+
+    /**
+     * Trade timestamp (ms)
+     */
+    trade_timestamp?: number;
+
+    /**
+     * Most recent trade volume
+     */
+    trade_volume?: string;
+  }
+
+  export namespace Ticker {
+    /**
+     * Delisting date (only present when delisting is scheduled)
+     */
+    export interface DelistingDate {
+      day?: number;
+
+      month?: number;
+
+      year?: number;
+    }
+  }
+
+  /**
+   * Trade stream message payload
+   */
+  export interface Trade {
+    /**
+     * Data type
+     */
+    type: 'trade';
+
+    /**
+     * Ask/bid side
+     */
+    ask_bid?: 'ASK' | 'BID';
+
+    /**
+     * Best ask price
+     */
+    best_ask_price?: string;
+
+    /**
+     * Best ask quantity
+     */
+    best_ask_size?: string;
+
+    /**
+     * Best bid price
+     */
+    best_bid_price?: string;
+
+    /**
+     * Best bid quantity
+     */
+    best_bid_size?: string;
+
+    /**
+     * Price change direction relative to previous close
+     */
+    change?: 'RISE' | 'EVEN' | 'FALL';
+
+    /**
+     * Absolute price change from previous close
+     */
+    change_price?: string;
+
+    /**
+     * Market code
+     */
+    code?: string;
+
+    /**
+     * Previous day closing price
+     */
+    prev_closing_price?: string;
+
+    /**
+     * Unique trade ID. Used to determine trade uniqueness; order is not guaranteed.
+     */
+    sequential_id?: number;
+
+    /**
+     * Stream type (snapshot or realtime)
+     */
+    stream_type?: 'SNAPSHOT' | 'REALTIME';
+
+    /**
+     * Timestamp (ms)
+     */
+    timestamp?: number;
+
+    /**
+     * Trade date (UTC, yyyy-MM-dd)
+     */
+    trade_date?: string;
+
+    /**
+     * Trade price
+     */
+    trade_price?: string;
+
+    /**
+     * Trade time (UTC, HH:mm:ss)
+     */
+    trade_time?: string;
+
+    /**
+     * Trade timestamp (ms)
+     */
+    trade_timestamp?: number;
+
+    /**
+     * Trade volume
+     */
+    trade_volume?: string;
+  }
+
+  /**
+   * Orderbook stream message payload
+   */
+  export interface Orderbook {
+    /**
+     * Data type
+     */
+    type: 'orderbook';
+
+    /**
+     * Market code
+     */
+    code?: string;
+
+    /**
+     * Orderbook grouping unit. 0 means default unit. KRW markets only.
+     */
+    level?: string;
+
+    /**
+     * List of orderbook units (default 30; adjustable via .count in codes)
+     */
+    orderbook_units?: Array<Orderbook.OrderbookUnit>;
+
+    /**
+     * Stream type (snapshot or realtime)
+     */
+    stream_type?: 'SNAPSHOT' | 'REALTIME';
+
+    /**
+     * Timestamp (ms)
+     */
+    timestamp?: number;
+
+    /**
+     * Total ask quantity in orderbook
+     */
+    total_ask_size?: string;
+
+    /**
+     * Total bid quantity in orderbook
+     */
+    total_bid_size?: string;
+  }
+
+  export namespace Orderbook {
+    /**
+     * Orderbook unit entry
+     */
+    export interface OrderbookUnit {
+      /**
+       * Ask price
+       */
+      ask_price?: string;
+
+      /**
+       * Ask quantity
+       */
+      ask_size?: string;
+
+      /**
+       * Bid price
+       */
+      bid_price?: string;
+
+      /**
+       * Bid quantity
+       */
+      bid_size?: string;
+    }
+  }
+
+  /**
+   * Candle stream message payload
+   */
+  export interface WsCandleResponse {
+    /**
+     * Data type (candle.{interval}). Examples: candle.1s, candle.1m, candle.240m
+     */
+    type:
+      | 'candle.1s'
+      | 'candle.1m'
+      | 'candle.3m'
+      | 'candle.5m'
+      | 'candle.10m'
+      | 'candle.15m'
+      | 'candle.30m'
+      | 'candle.60m'
+      | 'candle.240m';
+
+    /**
+     * Accumulated trade value
+     */
+    candle_acc_trade_price?: string;
+
+    /**
+     * Accumulated trade volume
+     */
+    candle_acc_trade_volume?: string;
+
+    /**
+     * Candle base time (KST, yyyy-MM-dd'T'HH:mm:ss)
+     */
+    candle_date_time_kst?: string;
+
+    /**
+     * Candle base time (UTC, yyyy-MM-dd'T'HH:mm:ss)
+     */
+    candle_date_time_utc?: string;
+
+    /**
+     * Market code
+     */
+    code?: string;
+
+    /**
+     * High price
+     */
+    high_price?: string;
+
+    /**
+     * Low price
+     */
+    low_price?: string;
+
+    /**
+     * Opening price
+     */
+    opening_price?: string;
+
+    /**
+     * Stream type (snapshot or realtime)
+     */
+    stream_type?: 'SNAPSHOT' | 'REALTIME';
+
+    /**
+     * Timestamp (ms)
+     */
+    timestamp?: number;
+
+    /**
+     * Closing price (current price)
+     */
+    trade_price?: string;
+  }
+}
+
+export declare namespace WsPublic {
+  export {
+    type ConnectPublicClientEvent as ConnectPublicClientEvent,
+    type ConnectPublicServerEvent as ConnectPublicServerEvent,
+  };
+}