@upbit-official/upbit-sdk 0.9.0

package/src/resources/orderbooks.ts

@@ -0,0 +1,170 @@
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Orderbooks extends APIResource {
+  /**
+   * Get Orderbook
+   *
+   * GET /v1/orderbook
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/list-orderbooks
+   * - docs(global): https://global-docs.upbit.com/reference/list-orderbooks
+   */
+  list(query: OrderbookListParams, options?: RequestOptions): APIPromise<OrderbookListResponse> {
+    return this._client.get('/v1/orderbook', { query, ...options, __security: {} });
+  }
+
+  /**
+   * List Orderbook Instruments
+   *
+   * GET /v1/orderbook/instruments
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/list-orderbook-instruments
+   * - docs(global):
+   *   https://global-docs.upbit.com/reference/list-orderbook-instruments
+   */
+  listInstruments(
+    query: OrderbookListInstrumentsParams,
+    options?: RequestOptions,
+  ): APIPromise<OrderbookListInstrumentsResponse> {
+    return this._client.get('/v1/orderbook/instruments', { query, ...options, __security: {} });
+  }
+}
+
+export type OrderbookListResponse = Array<OrderbookListResponse.OrderbookListResponseItem>;
+
+export namespace OrderbookListResponse {
+  export interface OrderbookListResponseItem {
+    /**
+     * Price unit applied for this orderbook level.
+     */
+    level: string;
+
+    /**
+     * Trading pair code.
+     */
+    market: string;
+
+    /**
+     * List of orderbook entries ordered from level 1 to level 30.
+     */
+    orderbook_units: Array<OrderbookListResponseItem.OrderbookUnit>;
+
+    /**
+     * Timestamp of the query request (ms).
+     */
+    timestamp: number;
+
+    /**
+     * Total ask volume in the current orderbook.
+     */
+    total_ask_size: string;
+
+    /**
+     * Total bid volume in the current orderbook.
+     */
+    total_bid_size: string;
+  }
+
+  export namespace OrderbookListResponseItem {
+    /**
+     * Individual orderbook entry.
+     */
+    export interface OrderbookUnit {
+      /**
+       * Lowest sell (ask) price.
+       */
+      ask_price: string;
+
+      /**
+       * Sell quantity at ask price.
+       */
+      ask_size: string;
+
+      /**
+       * Highest buy (bid) price.
+       */
+      bid_price: string;
+
+      /**
+       * Buy quantity at bid price.
+       */
+      bid_size: string;
+    }
+  }
+}
+
+export type OrderbookListInstrumentsResponse =
+  Array<OrderbookListInstrumentsResponse.OrderbookListInstrumentsResponseItem>;
+
+export namespace OrderbookListInstrumentsResponse {
+  export interface OrderbookListInstrumentsResponseItem {
+    /**
+     * Trading pair code.
+     */
+    market: string;
+
+    /**
+     * Quote currency code for the trading pair (e.g., SGD, BTC, USDT).
+     */
+    quote_currency: string;
+
+    /**
+     * Supported orderbook aggregation levels for this trading pair.
+     *
+     * - 0: Default unit
+     * - Aggregation is only supported for KRW markets. (BTC, USDT markets only have 0)
+     */
+    supported_levels: Array<string>;
+
+    /**
+     * Price unit applied to the orderbook level.
+     */
+    tick_size: string;
+  }
+}
+
+export interface OrderbookListParams {
+  /**
+   * List of trading pairs to query.
+   *
+   * For multiple pairs, use comma-separated format.
+   */
+  markets: string;
+
+  /**
+   * Number of orderbook entries to retrieve.
+   *
+   * Based on the best bid-ask pair, returns the specified number of pairs.
+   * Default: 30.
+   */
+  count?: number;
+
+  /**
+   * Orderbook aggregation level. Only supported for KRW markets. Groups ask/bid
+   * price and size by the specified unit. Provide as a numeric string. Use an
+   * integer string for units >= 1, or a double string for fractional units. Defaults
+   * to 0 if not specified.
+   */
+  level?: string;
+}
+
+export interface OrderbookListInstrumentsParams {
+  /**
+   * List of trading pairs to query.
+   *
+   * For multiple pairs, use comma-separated format.
+   */
+  markets: string;
+}
+
+export declare namespace Orderbooks {
+  export {
+    type OrderbookListResponse as OrderbookListResponse,
+    type OrderbookListInstrumentsResponse as OrderbookListInstrumentsResponse,
+    type OrderbookListParams as OrderbookListParams,
+    type OrderbookListInstrumentsParams as OrderbookListInstrumentsParams,
+  };
+}