@upbit-official/upbit-sdk 0.9.0

package/src/resources/tickers.ts

@@ -0,0 +1,233 @@
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Tickers extends APIResource {
+  /**
+   * List Tickers by Market
+   *
+   * GET /v1/ticker/all
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/list-quote-tickers
+   * - docs(global): https://global-docs.upbit.com/reference/list-quote-tickers
+   */
+  listByQuoteCurrencies(
+    query: TickerListByQuoteCurrenciesParams,
+    options?: RequestOptions,
+  ): APIPromise<TickerListByQuoteCurrenciesResponse> {
+    return this._client.get('/v1/ticker/all', { query, ...options, __security: {} });
+  }
+
+  /**
+   * List Tickers by Pairs
+   *
+   * GET /v1/ticker
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/list-tickers
+   * - docs(global): https://global-docs.upbit.com/reference/list-tickers
+   */
+  listByTradingPairs(
+    query: TickerListByTradingPairsParams,
+    options?: RequestOptions,
+  ): APIPromise<TickerListByTradingPairsResponse> {
+    return this._client.get('/v1/ticker', { query, ...options, __security: {} });
+  }
+}
+
+export interface Ticker {
+  /**
+   * Accumulated trade amount since UTC midnight.
+   */
+  acc_trade_price: string;
+
+  /**
+   * Accumulated trade amount over the past 24 hours.
+   */
+  acc_trade_price_24h: string;
+
+  /**
+   * Accumulated trade volume since UTC midnight.
+   */
+  acc_trade_volume: string;
+
+  /**
+   * Accumulated trade volume over the past 24 hours.
+   */
+  acc_trade_volume_24h: string;
+
+  /**
+   * Price change status.
+   *
+   * - `EVEN`: No change
+   * - `RISE`: Price rose
+   * - `FALL`: Price fell
+   */
+  change: 'EVEN' | 'RISE' | 'FALL';
+
+  /**
+   * Absolute price change from previous day's closing price.
+   *
+   * Calculated as "trade_price" - "prev_closing_price".
+   */
+  change_price: string;
+
+  /**
+   * Absolute price change rate from previous day's closing price.
+   *
+   * Calculated as ("trade_price" - "prev_closing_price") / "prev_closing_price".
+   */
+  change_rate: string;
+
+  /**
+   * Highest trading price of the trading pair.
+   */
+  high_price: string;
+
+  /**
+   * Date of 52-week highest price.
+   *
+   * [Format] yyyy-MM-dd
+   */
+  highest_52_week_date: string;
+
+  /**
+   * 52-week highest price.
+   */
+  highest_52_week_price: string;
+
+  /**
+   * Lowest trading price of the trading pair.
+   */
+  low_price: string;
+
+  /**
+   * Date of 52-week lowest price.
+   *
+   * [Format] yyyy-MM-dd
+   */
+  lowest_52_week_date: string;
+
+  /**
+   * 52-week lowest price.
+   */
+  lowest_52_week_price: string;
+
+  /**
+   * Trading pair code.
+   */
+  market: string;
+
+  /**
+   * Opening price of the trading pair.
+   */
+  opening_price: string;
+
+  /**
+   * Previous day's closing price (UTC-based).
+   */
+  prev_closing_price: string;
+
+  /**
+   * Signed price change from previous day's closing price. Calculated as
+   * "trade_price" - "prev_closing_price".
+   *
+   * - Positive(+): price rose
+   * - Negative(-): price fell
+   */
+  signed_change_price: string;
+
+  /**
+   * Signed price change rate from previous day's closing price. Calculated as
+   * ("trade_price" - "prev_closing_price") / "prev_closing_price".
+   *
+   * - Positive(+): price rose
+   * - Negative(-): price fell
+   *
+   * [Example] 0.015 = 1.5% increase
+   */
+  signed_change_rate: string;
+
+  /**
+   * Timestamp (ms) when the ticker information was recorded.
+   */
+  timestamp: number;
+
+  /**
+   * Most recent trade date (UTC-based).
+   *
+   * [Format] yyyyMMdd
+   */
+  trade_date: string;
+
+  /**
+   * Most recent trade date (KST-based). Supported in KOREA only.
+   *
+   * [Format] yyyyMMdd
+   */
+  trade_date_kst: string;
+
+  /**
+   * Current (closing) price of the trading pair.
+   */
+  trade_price: string;
+
+  /**
+   * Most recent trade time (UTC-based).
+   *
+   * [Format] HHmmss
+   */
+  trade_time: string;
+
+  /**
+   * Most recent trade time (KST-based). Supported in KOREA only.
+   *
+   * [Format] HHmmss
+   */
+  trade_time_kst: string;
+
+  /**
+   * Milliseconds timestamp when the trade was executed.
+   */
+  trade_timestamp: number;
+
+  /**
+   * Most recent trade volume.
+   */
+  trade_volume: string;
+}
+
+export type TickerListByQuoteCurrenciesResponse = Array<Ticker>;
+
+export type TickerListByTradingPairsResponse = Array<Ticker>;
+
+export interface TickerListByQuoteCurrenciesParams {
+  /**
+   * List of quote currencies to query. For multiple markets, use comma-separated
+   * format.
+   *
+   * [Example] SGD,BTC
+   */
+  quote_currencies: string;
+}
+
+export interface TickerListByTradingPairsParams {
+  /**
+   * List of trading pairs to query.
+   *
+   * For multiple pairs, use comma-separated format.
+   *
+   * [Example] SGD-BTC,SGD-ETH
+   */
+  markets: string;
+}
+
+export declare namespace Tickers {
+  export {
+    type Ticker as Ticker,
+    type TickerListByQuoteCurrenciesResponse as TickerListByQuoteCurrenciesResponse,
+    type TickerListByTradingPairsResponse as TickerListByTradingPairsResponse,
+    type TickerListByQuoteCurrenciesParams as TickerListByQuoteCurrenciesParams,
+    type TickerListByTradingPairsParams as TickerListByTradingPairsParams,
+  };
+}

package/src/resources/trades.ts

@@ -0,0 +1,127 @@
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Trades extends APIResource {
+  /**
+   * Recent Trades History
+   *
+   * GET /v1/trades/ticks
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/recent-trades-history
+   * - docs(global): https://global-docs.upbit.com/reference/recent-trades-history
+   */
+  list(query: TradeListParams, options?: RequestOptions): APIPromise<TradeListResponse> {
+    return this._client.get('/v1/trades/ticks', { query, ...options, __security: {} });
+  }
+}
+
+export type TradeListResponse = Array<TradeListResponse.TradeListResponseItem>;
+
+export namespace TradeListResponse {
+  export interface TradeListResponseItem {
+    /**
+     * Trade direction — ASK (sell) or BID (buy).
+     */
+    ask_bid: 'ASK' | 'BID';
+
+    /**
+     * Price change from previous day's closing price. Calculated as "trade_price" -
+     * "prev_closing_price".
+     *
+     * - Positive(+): current price rose from previous closing
+     * - Negative(-): current price fell from previous closing
+     * - 0: no change from previous closing
+     */
+    change_price: string;
+
+    /**
+     * Trading pair code.
+     */
+    market: string;
+
+    /**
+     * Previous day's closing price (UTC-based).
+     */
+    prev_closing_price: string;
+
+    /**
+     * Unique identifier for the trade.
+     *
+     * This field does not guarantee the sequence of trades.
+     */
+    sequential_id: number;
+
+    /**
+     * Milliseconds timestamp when the trade was executed.
+     */
+    timestamp: number;
+
+    /**
+     * Trade date (UTC-based).
+     *
+     * [Format] yyyy-MM-dd
+     */
+    trade_date_utc: string;
+
+    /**
+     * Most recent trade price.
+     */
+    trade_price: string;
+
+    /**
+     * Trade time (UTC-based).
+     *
+     * [Format] HH:mm:ss
+     */
+    trade_time_utc: string;
+
+    /**
+     * Most recent trade volume.
+     */
+    trade_volume: string;
+  }
+}
+
+export interface TradeListParams {
+  /**
+   * Trading pair code to query.
+   */
+  market: string;
+
+  /**
+   * Number of trade records to retrieve.
+   *
+   * Up to 500 supported. Default: 1.
+   */
+  count?: number;
+
+  /**
+   * Cursor for pagination. Enter the "sequential_id" from the response to retrieve
+   * the previous "count" trade records prior to that trade.
+   */
+  cursor?: string;
+
+  /**
+   * Day offset between the query date and the request date. Must specify the target
+   * date; up to 7 days of history is supported (UTC-based).
+   *
+   * Integer between 1 and 7. If omitted, returns trades for the current date. If 7,
+   * returns trades from 7 days ago in reverse chronological order.
+   */
+  days_ago?: number;
+
+  /**
+   * End time within the query date range (UTC). Optional parameter to retrieve
+   * trades within a specific time of the query date.
+   *
+   * Accepts HHmmss or HH:mm:ss format. Trade list is returned in reverse
+   * chronological order from the specified time.
+   */
+  to?: string;
+}
+
+export declare namespace Trades {
+  export { type TradeListResponse as TradeListResponse, type TradeListParams as TradeListParams };
+}

package/src/resources/trading-pairs.ts

@@ -0,0 +1,120 @@
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class TradingPairs extends APIResource {
+  /**
+   * List Trading Pairs
+   *
+   * GET /v1/market/all
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/list-trading-pairs
+   * - docs(global): https://global-docs.upbit.com/reference/list-trading-pairs
+   */
+  list(
+    query: TradingPairListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TradingPairListResponse> {
+    return this._client.get('/v1/market/all', { query, ...options, __security: {} });
+  }
+}
+
+export type TradingPairListResponse = Array<TradingPairListResponse.TradingPairListResponseItem>;
+
+export namespace TradingPairListResponse {
+  export interface TradingPairListResponseItem {
+    /**
+     * English name of the digital asset.
+     */
+    english_name: string;
+
+    /**
+     * Korean name of the digital asset.
+     */
+    korean_name: string;
+
+    /**
+     * Trading pair code representing the market.
+     *
+     * [Example]: "SGD-BTC"
+     */
+    market: string;
+
+    /**
+     * Market alert information.
+     */
+    market_event?: TradingPairListResponseItem.MarketEvent;
+
+    /**
+     * Trading pair warning status.
+     */
+    market_warning?: 'NONE' | 'CAUTION';
+  }
+
+  export namespace TradingPairListResponseItem {
+    /**
+     * Market alert information.
+     */
+    export interface MarketEvent {
+      /**
+       * Caution item status. If flagged, one or more of the following alert types may
+       * apply.
+       */
+      caution?: MarketEvent.Caution;
+
+      /**
+       * Whether the trading pair is flagged as a warning item.
+       */
+      warning?: boolean;
+    }
+
+    export namespace MarketEvent {
+      /**
+       * Caution item status. If flagged, one or more of the following alert types may
+       * apply.
+       */
+      export interface Caution {
+        /**
+         * Concentration of small accounts alert.
+         */
+        CONCENTRATION_OF_SMALL_ACCOUNTS?: boolean;
+
+        /**
+         * Deposit amount surge alert.
+         */
+        DEPOSIT_AMOUNT_SOARING?: boolean;
+
+        /**
+         * Global price difference alert.
+         */
+        GLOBAL_PRICE_DIFFERENCES?: boolean;
+
+        /**
+         * Price fluctuation alert.
+         */
+        PRICE_FLUCTUATIONS?: boolean;
+
+        /**
+         * Trading volume surge alert.
+         */
+        TRADING_VOLUME_SOARING?: boolean;
+      }
+    }
+  }
+}
+
+export interface TradingPairListParams {
+  /**
+   * Whether to include detailed information in the query. If true, the response
+   * includes detail fields such as caution or warning designation. Default: false.
+   */
+  is_details?: boolean;
+}
+
+export declare namespace TradingPairs {
+  export {
+    type TradingPairListResponse as TradingPairListResponse,
+    type TradingPairListParams as TradingPairListParams,
+  };
+}

package/src/resources/travel-rule.ts

@@ -0,0 +1,181 @@
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class TravelRule extends APIResource {
+  /**
+   * List Travel Rule Supporting VASPs
+   *
+   * GET /v1/travel_rule/vasps
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/list-travelrule-vasps
+   * - docs(global): https://global-docs.upbit.com/reference/list-travelrule-vasps
+   *
+   * @example
+   * ```ts
+   * const response = await client.travelRule.listVasps();
+   * ```
+   */
+  listVasps(options?: RequestOptions): APIPromise<TravelRuleListVaspsResponse> {
+    return this._client.get('/v1/travel_rule/vasps', options);
+  }
+
+  /**
+   * Verify Travel Rule by Deposit TxID
+   *
+   * POST /v1/travel_rule/deposit/txid
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/verify-travelrule-by-txid
+   * - docs(global):
+   *   https://global-docs.upbit.com/reference/verify-travelrule-by-txid
+   *
+   * @example
+   * ```ts
+   * const verificationResult =
+   *   await client.travelRule.verifyDepositByTxid({
+   *     currency: 'ETH',
+   *     net_type: 'ETH',
+   *     txid: '5b871d34-fe38-4025-8f5c-9b22028f85d3',
+   *     vasp_uuid: '8d4fe968-82b2-42e5-822f-3840a245f802',
+   *   });
+   * ```
+   */
+  verifyDepositByTxid(
+    body: TravelRuleVerifyDepositByTxidParams,
+    options?: RequestOptions,
+  ): APIPromise<VerificationResult> {
+    return this._client.post('/v1/travel_rule/deposit/txid', { body, ...options });
+  }
+
+  /**
+   * Verify Travel Rule by Deposit UUID
+   *
+   * POST /v1/travel_rule/deposit/uuid
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/verify-travelrule-by-uuid
+   * - docs(global):
+   *   https://global-docs.upbit.com/reference/verify-travelrule-by-uuid
+   *
+   * @example
+   * ```ts
+   * const verificationResult =
+   *   await client.travelRule.verifyDepositByUuid({
+   *     deposit_uuid: '5b871d34-fe38-4025-8f5c-9b22028f85d3',
+   *     vasp_uuid: '8d4fe968-82b2-42e5-822f-3840a245f802',
+   *   });
+   * ```
+   */
+  verifyDepositByUuid(
+    body: TravelRuleVerifyDepositByUuidParams,
+    options?: RequestOptions,
+  ): APIPromise<VerificationResult> {
+    return this._client.post('/v1/travel_rule/deposit/uuid', { body, ...options });
+  }
+}
+
+export interface VerificationResult {
+  /**
+   * Deposit status.
+   *
+   * - `PROCESSING`: Deposit in progress (digital asset only)
+   * - `ACCEPTED`: Completed
+   * - `CANCELLED`: Cancelled
+   * - `REJECTED`: Rejected
+   * - `TRAVEL_RULE_SUSPECTED`: Awaiting additional Travel Rule verification (digital
+   *   assets only)
+   * - `REFUNDING`: Refund in progress
+   * - `REFUNDED`: Refunded (digital asset only)
+   */
+  deposit_state:
+    | 'PROCESSING'
+    | 'ACCEPTED'
+    | 'CANCELLED'
+    | 'REJECTED'
+    | 'TRAVEL_RULE_SUSPECTED'
+    | 'REFUNDING'
+    | 'REFUNDED';
+
+  /**
+   * Unique identifier (UUID) for the deposit to verify.
+   */
+  deposit_uuid: string;
+
+  /**
+   * Result of the account verification process.
+   */
+  verification_result: string;
+}
+
+export type TravelRuleListVaspsResponse = Array<TravelRuleListVaspsResponse.TravelRuleListVaspsResponseItem>;
+
+export namespace TravelRuleListVaspsResponse {
+  export interface TravelRuleListVaspsResponseItem {
+    /**
+     * Indicates whether deposits are available from the VASP.
+     */
+    depositable: boolean;
+
+    /**
+     * Exchange name. Name of the VASP (Virtual Asset Service Provider).
+     */
+    vasp_name: string;
+
+    /**
+     * Unique identifier (UUID) of the exchange. Uniquely assigned VASP identifier for
+     * the transfer.
+     */
+    vasp_uuid: string;
+
+    /**
+     * Indicates whether withdrawals are available to the VASP.
+     */
+    withdrawable: boolean;
+  }
+}
+
+export interface TravelRuleVerifyDepositByTxidParams {
+  /**
+   * Currency code to be queried.
+   */
+  currency: string;
+
+  /**
+   * Blockchain network identifier for deposit/withdrawal of digital assets. Used as
+   * a filter parameter to specify the network.
+   */
+  net_type: string;
+
+  /**
+   * Transaction ID of the deposit to be verified.
+   */
+  txid: string;
+
+  /**
+   * Unique identifier (UUID) of the counterparty exchange from which the asset was
+   * withdrawn.
+   */
+  vasp_uuid: string;
+}
+
+export interface TravelRuleVerifyDepositByUuidParams {
+  /**
+   * Unique identifier (UUID) for the deposit to verify.
+   */
+  deposit_uuid: string;
+
+  /**
+   * Unique identifier (UUID) of the counterparty exchange from which the asset was
+   * withdrawn.
+   */
+  vasp_uuid: string;
+}
+
+export declare namespace TravelRule {
+  export {
+    type VerificationResult as VerificationResult,
+    type TravelRuleListVaspsResponse as TravelRuleListVaspsResponse,
+    type TravelRuleVerifyDepositByTxidParams as TravelRuleVerifyDepositByTxidParams,
+    type TravelRuleVerifyDepositByUuidParams as TravelRuleVerifyDepositByUuidParams,
+  };
+}