@upbit-official/upbit-sdk 0.9.0 → 1.0.0

package/src/resources/accounts.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
@@ -11,6 +10,8 @@ export class Accounts extends APIResource {
    *
    * - docs(kr): https://docs.upbit.com/kr/reference/get-balance
    * - docs(global): https://global-docs.upbit.com/reference/get-balance
+   *
+   * Retrieves the list of assets and balances owned by the account.
    */
   list(options?: RequestOptions): APIPromise<AccountListResponse> {
     return this._client.get('/v1/accounts', options);

package/src/resources/api-keys.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
@@ -10,7 +9,9 @@ export class APIKeys extends APIResource {
    * GET /v1/api_keys
    *
    * - docs(kr): https://docs.upbit.com/kr/reference/list-api-keys
-   * - docs(global): https://global-docs.upbit.com/reference/list-api-keys
+   * - Supported only in Korea.
+   *
+   * 계정의 모든 API Key 목록과 각 Key의 만료일자를 조회합니다.
    */
   list(options?: RequestOptions): APIPromise<APIKeyListResponse> {
     return this._client.get('/v1/api_keys', options);

package/src/resources/candles.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../core/resource';
 import * as CandlesAPI from './candles';
 import { APIPromise } from '../core/api-promise';
@@ -14,6 +13,8 @@ export class Candles extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-candles-days
    * - docs(global): https://global-docs.upbit.com/reference/list-candles-days
    *
+   * Retrieves the list of candles per day.
+   *
    * @example
    * ```ts
    * const response = await client.candles.listDays({
@@ -33,6 +34,8 @@ export class Candles extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-candles-minutes
    * - docs(global): https://global-docs.upbit.com/reference/list-candles-minutes
    *
+   * Retrieves the list of candles per minute.
+   *
    * @example
    * ```ts
    * const candles = await client.candles.listMinutes(15, {
@@ -56,6 +59,8 @@ export class Candles extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-candles-months
    * - docs(global): https://global-docs.upbit.com/reference/list-candles-months
    *
+   * Retrieves the list of candles per month.
+   *
    * @example
    * ```ts
    * const candlePeriods = await client.candles.listMonths({
@@ -75,6 +80,8 @@ export class Candles extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-candles-seconds
    * - docs(global): https://global-docs.upbit.com/reference/list-candles-seconds
    *
+   * Retrieves the list of candles per second.
+   *
    * @example
    * ```ts
    * const candles = await client.candles.listSeconds({
@@ -97,6 +104,8 @@ export class Candles extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-candles-weeks
    * - docs(global): https://global-docs.upbit.com/reference/list-candles-weeks
    *
+   * Retrieves the list of candles per week.
+   *
    * @example
    * ```ts
    * const candlePeriods = await client.candles.listWeeks({
@@ -116,6 +125,8 @@ export class Candles extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-candles-years
    * - docs(global): https://global-docs.upbit.com/reference/list-candles-years
    *
+   * Retrieves the list of candles per year.
+   *
    * @example
    * ```ts
    * const candlePeriods = await client.candles.listYears({
@@ -224,7 +235,16 @@ export namespace CandleListDaysResponse {
   }
 }
 
-export type CandleListMinutesResponse = Array<Candle>;
+export type CandleListMinutesResponse = Array<CandleListMinutesResponse.CandleListMinutesResponseItem>;
+
+export namespace CandleListMinutesResponse {
+  export interface CandleListMinutesResponseItem extends CandlesAPI.Candle {
+    /**
+     * Candle unit in minutes.
+     */
+    unit: 1 | 3 | 5 | 10 | 15 | 30 | 60 | 240;
+  }
+}
 
 export type CandleListMonthsResponse = Array<CandlePeriod>;
 

package/src/resources/deposits.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { PagePromise, UuidCursorIDPage, type UuidCursorIDPageParams } from '../core/pagination';
@@ -13,6 +12,9 @@ export class Deposits extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/get-deposit
    * - docs(global): https://global-docs.upbit.com/reference/get-deposit
    *
+   * Retrieves the latest deposit history. To query specific deposit information, you
+   * can specify the deposit’s UUID, transaction ID (TXID), or currency code.
+   *
    * @example
    * ```ts
    * const deposit = await client.deposits.retrieve();
@@ -33,6 +35,8 @@ export class Deposits extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-deposits
    * - docs(global): https://global-docs.upbit.com/reference/list-deposits
    *
+   * Retrieves the latest deposit list.
+   *
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
@@ -56,6 +60,9 @@ export class Deposits extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/create-deposit-address
    * - docs(global): https://global-docs.upbit.com/reference/create-deposit-address
    *
+   * Requests the creation of a deposit address for depositing assets from a personal
+   * wallet or another exchange into Upbit.
+   *
    * @example
    * ```ts
    * const response = await client.deposits.createCoinAddress({
@@ -77,7 +84,9 @@ export class Deposits extends APIResource {
    * POST /v1/deposits/krw
    *
    * - docs(kr): https://docs.upbit.com/kr/reference/deposit-krw
-   * - docs(global): https://global-docs.upbit.com/reference/deposit-krw
+   * - Supported only in Korea.
+   *
+   * 입출금 계좌로부터 원화를 지정한 금액만큼 입금합니다.
    *
    * @example
    * ```ts
@@ -99,6 +108,9 @@ export class Deposits extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-deposit-addresses
    * - docs(global): https://global-docs.upbit.com/reference/list-deposit-addresses
    *
+   * Retrieves deposit address information for the specified currency. Return all
+   * successfully generated deposit addresses.
+   *
    * @example
    * ```ts
    * const depositAddresses =
@@ -118,6 +130,8 @@ export class Deposits extends APIResource {
    * - docs(global):
    *   https://global-docs.upbit.com/reference/available-deposit-information
    *
+   * Deposits availability information for the specified currency is retrieved.
+   *
    * @example
    * ```ts
    * const response = await client.deposits.retrieveChance({
@@ -141,6 +155,8 @@ export class Deposits extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/get-deposit-address
    * - docs(global): https://global-docs.upbit.com/reference/get-deposit-address
    *
+   * Retrieves deposit address information for the specified currency.
+   *
    * @example
    * ```ts
    * const depositAddress =

package/src/resources/index.ts

@@ -1,4 +1,3 @@
-
 export { APIKeys, type APIKeyListResponse } from './api-keys';
 export { Accounts, type AccountListResponse } from './accounts';
 export {
@@ -66,6 +65,29 @@ export {
   type OrderTestCreateParams,
   type OrdersPageNumberPage,
 } from './orders';
+export {
+  Pockets,
+  type Pocket,
+  type PocketAPIKey,
+  type PocketAPIKeyGroup,
+  type PocketAPIKeyPermission,
+  type PocketBalance,
+  type PocketTransfer,
+  type PocketTransferDirection,
+  type PocketTransferState,
+  type PocketType,
+  type PocketListResponse,
+  type PocketListAPIKeysResponse,
+  type PocketListTransfersResponse,
+  type PocketListUniversalTransfersResponse,
+  type PocketRetrieveBalanceResponse,
+  type PocketListAPIKeysParams,
+  type PocketListTransfersParams,
+  type PocketListUniversalTransfersParams,
+  type PocketRetrieveBalanceParams,
+  type PocketTransferParams,
+  type PocketUniversalTransferParams,
+} from './pockets';
 export {
   Tickers,
   type Ticker,

package/src/resources/orderbooks.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
@@ -11,6 +10,8 @@ export class Orderbooks extends APIResource {
    *
    * - docs(kr): https://docs.upbit.com/kr/reference/list-orderbooks
    * - docs(global): https://global-docs.upbit.com/reference/list-orderbooks
+   *
+   * Retrieves the real-time orderbook data for the specified markets.
    */
   list(query: OrderbookListParams, options?: RequestOptions): APIPromise<OrderbookListResponse> {
     return this._client.get('/v1/orderbook', { query, ...options, __security: {} });
@@ -24,6 +25,8 @@ export class Orderbooks extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-orderbook-instruments
    * - docs(global):
    *   https://global-docs.upbit.com/reference/list-orderbook-instruments
+   *
+   * Retrieves the tick size (order price unit) for the specified trading pairs.
    */
   listInstruments(
     query: OrderbookListInstrumentsParams,

package/src/resources/orders.ts

@@ -1,4 +1,3 @@
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { PageNumberPage, type PageNumberPageParams, PagePromise } from '../core/pagination';
@@ -89,6 +88,8 @@ export class Orders extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/cancel-and-new-order
    * - docs(global): https://global-docs.upbit.com/reference/cancel-and-new-order
    *
+   * Cancel existing order and create new order in a single request.
+   *
    * @example
    * ```ts
    * const order = await client.orders.cancelAndNew({
@@ -134,6 +135,8 @@ export class Orders extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/batch-cancel-orders
    * - docs(global): https://global-docs.upbit.com/reference/batch-cancel-orders
    *
+   * Batch cancel up to 300 orders that satisfy the specified conditions.
+   *
    * @example
    * ```ts
    * const batchCancelResult = await client.orders.cancelOpen();
@@ -180,6 +183,8 @@ export class Orders extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-closed-orders
    * - docs(global): https://global-docs.upbit.com/reference/list-closed-orders
    *
+   * Retrieves the list of closed orders.
+   *
    * @example
    * ```ts
    * const orders = await client.orders.listClosed();
@@ -200,6 +205,8 @@ export class Orders extends APIResource {
    * - docs(kr): https://docs.upbit.com/kr/reference/list-open-orders
    * - docs(global): https://global-docs.upbit.com/reference/list-open-orders
    *
+   * Retrieves the list of open orders that are currently pending execution.
+   *
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
@@ -224,6 +231,8 @@ export class Orders extends APIResource {
    * - docs(global):
    *   https://global-docs.upbit.com/reference/available-order-information
    *
+   * Retrieves the order availability information for the specified pair.
+   *
    * @example
    * ```ts
    * const response = await client.orders.retrieveChance({
@@ -243,8 +252,8 @@ export class Orders extends APIResource {
    *
    * POST /v1/orders/test
    *
-   * - docs(kr): https://docs.upbit.com/kr/reference/test-order
-   * - docs(global): https://global-docs.upbit.com/reference/test-order
+   * - docs(kr): https://docs.upbit.com/kr/reference/order-test
+   * - docs(global): https://global-docs.upbit.com/reference/order-test
    *
    * Order parameter rules by `ord_type`:
    *