@upbit-official/upbit-sdk 0.9.0

package/src/resources/deposits.ts

@@ -0,0 +1,484 @@
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { PagePromise, UuidCursorIDPage, type UuidCursorIDPageParams } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+export class Deposits extends APIResource {
+  /**
+   * Get Deposit
+   *
+   * GET /v1/deposit
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/get-deposit
+   * - docs(global): https://global-docs.upbit.com/reference/get-deposit
+   *
+   * @example
+   * ```ts
+   * const deposit = await client.deposits.retrieve();
+   * ```
+   */
+  retrieve(
+    query: DepositRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Deposit> {
+    return this._client.get('/v1/deposit', { query, ...options });
+  }
+
+  /**
+   * List Deposits
+   *
+   * GET /v1/deposits
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/list-deposits
+   * - docs(global): https://global-docs.upbit.com/reference/list-deposits
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const deposit of client.deposits.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: DepositListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DepositsUuidCursorIDPage, Deposit> {
+    return this._client.getAPIList('/v1/deposits', UuidCursorIDPage<Deposit>, { query, ...options });
+  }
+
+  /**
+   * Create Deposit Address
+   *
+   * POST /v1/deposits/generate_coin_address
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/create-deposit-address
+   * - docs(global): https://global-docs.upbit.com/reference/create-deposit-address
+   *
+   * @example
+   * ```ts
+   * const response = await client.deposits.createCoinAddress({
+   *   currency: 'BTC',
+   *   net_type: 'BTC',
+   * });
+   * ```
+   */
+  createCoinAddress(
+    body: DepositCreateCoinAddressParams,
+    options?: RequestOptions,
+  ): APIPromise<DepositCreateCoinAddressResponse> {
+    return this._client.post('/v1/deposits/generate_coin_address', { body, ...options });
+  }
+
+  /**
+   * Deposit KRW
+   *
+   * POST /v1/deposits/krw
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/deposit-krw
+   * - docs(global): https://global-docs.upbit.com/reference/deposit-krw
+   *
+   * @example
+   * ```ts
+   * const deposit = await client.deposits.depositKrw({
+   *   amount: '10000',
+   *   two_factor_type: 'naver',
+   * });
+   * ```
+   */
+  depositKrw(body: DepositDepositKrwParams, options?: RequestOptions): APIPromise<Deposit> {
+    return this._client.post('/v1/deposits/krw', { body, ...options });
+  }
+
+  /**
+   * List Deposit Addresses
+   *
+   * GET /v1/deposits/coin_addresses
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/list-deposit-addresses
+   * - docs(global): https://global-docs.upbit.com/reference/list-deposit-addresses
+   *
+   * @example
+   * ```ts
+   * const depositAddresses =
+   *   await client.deposits.listCoinAddresses();
+   * ```
+   */
+  listCoinAddresses(options?: RequestOptions): APIPromise<DepositListCoinAddressesResponse> {
+    return this._client.get('/v1/deposits/coin_addresses', options);
+  }
+
+  /**
+   * Get Available Deposit Information
+   *
+   * GET /v1/deposits/chance/coin
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/available-deposit-information
+   * - docs(global):
+   *   https://global-docs.upbit.com/reference/available-deposit-information
+   *
+   * @example
+   * ```ts
+   * const response = await client.deposits.retrieveChance({
+   *   currency: 'BTC',
+   *   net_type: 'BTC',
+   * });
+   * ```
+   */
+  retrieveChance(
+    query: DepositRetrieveChanceParams,
+    options?: RequestOptions,
+  ): APIPromise<DepositRetrieveChanceResponse> {
+    return this._client.get('/v1/deposits/chance/coin', { query, ...options });
+  }
+
+  /**
+   * Get Deposit Address
+   *
+   * GET /v1/deposits/coin_address
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/get-deposit-address
+   * - docs(global): https://global-docs.upbit.com/reference/get-deposit-address
+   *
+   * @example
+   * ```ts
+   * const depositAddress =
+   *   await client.deposits.retrieveCoinAddress({
+   *     currency: 'BTC',
+   *     net_type: 'BTC',
+   *   });
+   * ```
+   */
+  retrieveCoinAddress(
+    query: DepositRetrieveCoinAddressParams,
+    options?: RequestOptions,
+  ): APIPromise<DepositAddress> {
+    return this._client.get('/v1/deposits/coin_address', { query, ...options });
+  }
+}
+
+export type DepositsUuidCursorIDPage = UuidCursorIDPage<Deposit>;
+
+export interface Deposit {
+  /**
+   * Deposit amount.
+   */
+  amount: string;
+
+  /**
+   * Timestamp when the deposit was requested.
+   *
+   * [Format] yyyy-MM-ddTHH:mm:ss+00:00
+   */
+  created_at: string;
+
+  /**
+   * Currency code of the deposit.
+   */
+  currency: string;
+
+  /**
+   * Timestamp when the deposit was completed.
+   *
+   * [Format] yyyy-MM-ddTHH:mm:ss+00:00
+   */
+  done_at: string | null;
+
+  /**
+   * Deposit fee.
+   */
+  fee: string;
+
+  /**
+   * 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)
+   */
+  state:
+    | 'PROCESSING'
+    | 'ACCEPTED'
+    | 'CANCELLED'
+    | 'REJECTED'
+    | 'TRAVEL_RULE_SUSPECTED'
+    | 'REFUNDING'
+    | 'REFUNDED';
+
+  /**
+   * Deposit transaction type.
+   *
+   * - `default`: Standard deposit
+   * - `internal`: Internal deposit (between Upbit accounts)
+   */
+  transaction_type: 'default' | 'internal';
+
+  /**
+   * Deposit transaction ID.
+   */
+  txid: string;
+
+  /**
+   * Transaction type.
+   */
+  type: string;
+
+  /**
+   * Unique identifier (UUID) of the deposit.
+   */
+  uuid: string;
+
+  /**
+   * Deposit network type. Returns null for fiat (KRW) deposits.
+   *
+   * [Example] ETH, TRX, SOL
+   */
+  net_type?: string | null;
+}
+
+export interface DepositAddress {
+  /**
+   * Currency code for which the deposit address was created.
+   */
+  currency: string;
+
+  /**
+   * Deposit address.
+   */
+  deposit_address: string;
+
+  /**
+   * Deposit network type.
+   *
+   * Blockchain network identifier used by Upbit.
+   *
+   * [Example] ETH, TRX, SOL
+   */
+  net_type: string | null;
+
+  /**
+   * Secondary deposit address (Destination Tag, Memo, or Message).
+   */
+  secondary_address?: string | null;
+}
+
+export type DepositCreateCoinAddressResponse =
+  | DepositAddress
+  | DepositCreateCoinAddressResponse.GenerateCoinAddressResponse;
+
+export namespace DepositCreateCoinAddressResponse {
+  export interface GenerateCoinAddressResponse {
+    /**
+     * Message about the deposit address creation request.
+     */
+    message: string;
+
+    /**
+     * Whether the deposit address creation request was accepted.
+     */
+    success: boolean;
+  }
+}
+
+export type DepositListCoinAddressesResponse = Array<DepositAddress>;
+
+export interface DepositRetrieveChanceResponse {
+  /**
+   * Currency code to be queried.
+   */
+  currency: string;
+
+  /**
+   * Decimal precision applied to deposits.
+   */
+  decimal_precision: number;
+
+  /**
+   * Reason why deposits are not possible.
+   *
+   * ※ Provided when "is_deposit_possible" is "false".
+   */
+  deposit_impossible_reason: string;
+
+  /**
+   * Whether deposits are currently possible.
+   */
+  is_deposit_possible: boolean;
+
+  /**
+   * Minimum deposit amount.
+   */
+  minimum_deposit_amount: string;
+
+  /**
+   * Minimum number of blockchain confirmations required for the deposit to be
+   * credited.
+   */
+  minimum_deposit_confirmations: number;
+
+  /**
+   * Deposit network type.
+   *
+   * Blockchain network identifier used by Upbit.
+   *
+   * [Example] ETH, TRX, SOL
+   */
+  net_type: string | null;
+}
+
+export interface DepositRetrieveParams {
+  /**
+   * Currency code filter.
+   */
+  currency?: string;
+
+  /**
+   * Transaction ID of the deposit to query.
+   *
+   * If neither uuid nor txid is provided, the latest deposit is returned.
+   */
+  txid?: string;
+
+  /**
+   * UUID of the deposit to query.
+   *
+   * If neither uuid nor txid is provided, the latest deposit is returned.
+   */
+  uuid?: string;
+}
+
+export interface DepositListParams extends UuidCursorIDPageParams {
+  /**
+   * Currency code filter. If not specified, the latest deposits are returned.
+   */
+  currency?: string;
+
+  /**
+   * Cursor for pagination. Enter a "uuid" from the response to retrieve "limit"
+   * deposits after that timestamp.
+   */
+  from?: string;
+
+  /**
+   * Sort order. "desc" (newest first) or "asc" (oldest first). Default is "desc".
+   */
+  order_by?: 'asc' | 'desc';
+
+  /**
+   * Page number for pagination. Default is 1.
+   */
+  page?: number;
+
+  /**
+   * Deposit state filter.
+   *
+   * - `PROCESSING`: Processing
+   * - `ACCEPTED`: Completed
+   * - `CANCELLED`: Cancelled
+   * - `REJECTED`: Rejected
+   * - `TRAVEL_RULE_SUSPECTED`: Pending Travel Rule verification
+   * - `REFUNDING`: Refund in progress
+   * - `REFUNDED`: Refunded
+   */
+  state?:
+    | 'PROCESSING'
+    | 'ACCEPTED'
+    | 'CANCELLED'
+    | 'REJECTED'
+    | 'TRAVEL_RULE_SUSPECTED'
+    | 'REFUNDING'
+    | 'REFUNDED';
+
+  /**
+   * List of transaction IDs to query.
+   *
+   * [Example] txids[]=txid1&txids[]=txid2
+   */
+  txids?: Array<string>;
+
+  /**
+   * List of UUIDs to query.
+   *
+   * [Example] uuids[]=uuid1&uuids[]=uuid2
+   */
+  uuids?: Array<string>;
+}
+
+export interface DepositCreateCoinAddressParams {
+  /**
+   * Currency code for which to create a deposit address.
+   */
+  currency: string;
+
+  /**
+   * Network type.
+   */
+  net_type: string;
+}
+
+export interface DepositDepositKrwParams {
+  /**
+   * KRW amount to deposit.
+   */
+  amount: string;
+
+  /**
+   * Two-factor authentication method for KRW transactions.
+   *
+   * - `kakao`: Kakao authentication
+   * - `naver`: Naver authentication
+   * - `hana`: Hana certificate authentication
+   */
+  two_factor_type: 'kakao' | 'naver' | 'hana';
+}
+
+export interface DepositRetrieveChanceParams {
+  /**
+   * Currency code to query deposit availability for.
+   */
+  currency: string;
+
+  /**
+   * Blockchain network identifier for digital asset deposit.
+   *
+   * Used to filter by network.
+   */
+  net_type: string;
+}
+
+export interface DepositRetrieveCoinAddressParams {
+  /**
+   * Currency code to query.
+   */
+  currency: string;
+
+  /**
+   * Blockchain network identifier.
+   *
+   * Used to filter by network.
+   */
+  net_type: string;
+}
+
+export declare namespace Deposits {
+  export {
+    type Deposit as Deposit,
+    type DepositAddress as DepositAddress,
+    type DepositCreateCoinAddressResponse as DepositCreateCoinAddressResponse,
+    type DepositListCoinAddressesResponse as DepositListCoinAddressesResponse,
+    type DepositRetrieveChanceResponse as DepositRetrieveChanceResponse,
+    type DepositsUuidCursorIDPage as DepositsUuidCursorIDPage,
+    type DepositRetrieveParams as DepositRetrieveParams,
+    type DepositListParams as DepositListParams,
+    type DepositCreateCoinAddressParams as DepositCreateCoinAddressParams,
+    type DepositDepositKrwParams as DepositDepositKrwParams,
+    type DepositRetrieveChanceParams as DepositRetrieveChanceParams,
+    type DepositRetrieveCoinAddressParams as DepositRetrieveCoinAddressParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,102 @@
+
+export { APIKeys, type APIKeyListResponse } from './api-keys';
+export { Accounts, type AccountListResponse } from './accounts';
+export {
+  Candles,
+  type Candle,
+  type CandlePeriod,
+  type CandleListDaysResponse,
+  type CandleListMinutesResponse,
+  type CandleListMonthsResponse,
+  type CandleListSecondsResponse,
+  type CandleListWeeksResponse,
+  type CandleListYearsResponse,
+  type CandleListDaysParams,
+  type CandleListMinutesParams,
+  type CandleListMonthsParams,
+  type CandleListSecondsParams,
+  type CandleListWeeksParams,
+  type CandleListYearsParams,
+} from './candles';
+export {
+  Deposits,
+  type Deposit,
+  type DepositAddress,
+  type DepositCreateCoinAddressResponse,
+  type DepositListCoinAddressesResponse,
+  type DepositRetrieveChanceResponse,
+  type DepositRetrieveParams,
+  type DepositListParams,
+  type DepositCreateCoinAddressParams,
+  type DepositDepositKrwParams,
+  type DepositRetrieveChanceParams,
+  type DepositRetrieveCoinAddressParams,
+  type DepositsUuidCursorIDPage,
+} from './deposits';
+export {
+  Orderbooks,
+  type OrderbookListResponse,
+  type OrderbookListInstrumentsResponse,
+  type OrderbookListParams,
+  type OrderbookListInstrumentsParams,
+} from './orderbooks';
+export {
+  Orders,
+  type BatchCancelResult,
+  type ClosedOrderState,
+  type OpenOrderState,
+  type OrdTypeEnum,
+  type Order,
+  type SideEnum,
+  type SmpTypeEnum,
+  type TimeInForceEnum,
+  type OrderListByUuidsResponse,
+  type OrderListClosedResponse,
+  type OrderRetrieveChanceResponse,
+  type OrderCreateParams,
+  type OrderRetrieveParams,
+  type OrderCancelParams,
+  type OrderCancelAndNewParams,
+  type OrderCancelByUuidsParams,
+  type OrderCancelOpenParams,
+  type OrderListByUuidsParams,
+  type OrderListClosedParams,
+  type OrderListOpenParams,
+  type OrderRetrieveChanceParams,
+  type OrderTestCreateParams,
+  type OrdersPageNumberPage,
+} from './orders';
+export {
+  Tickers,
+  type Ticker,
+  type TickerListByQuoteCurrenciesResponse,
+  type TickerListByTradingPairsResponse,
+  type TickerListByQuoteCurrenciesParams,
+  type TickerListByTradingPairsParams,
+} from './tickers';
+export { Trades, type TradeListResponse, type TradeListParams } from './trades';
+export { TradingPairs, type TradingPairListResponse, type TradingPairListParams } from './trading-pairs';
+export {
+  TravelRule,
+  type VerificationResult,
+  type TravelRuleListVaspsResponse,
+  type TravelRuleVerifyDepositByTxidParams,
+  type TravelRuleVerifyDepositByUuidParams,
+} from './travel-rule';
+export { WalletStatus, type WalletStatusListResponse } from './wallet-status';
+export {
+  Withdraws,
+  type Withdraw,
+  type WithdrawCreateKrwWithdrawalResponse,
+  type WithdrawListCoinAddressesResponse,
+  type WithdrawRetrieveChanceResponse,
+  type WithdrawRetrieveParams,
+  type WithdrawListParams,
+  type WithdrawCancelWithdrawalParams,
+  type WithdrawCreateKrwWithdrawalParams,
+  type WithdrawCreateWithdrawalParams,
+  type WithdrawRetrieveChanceParams,
+  type WithdrawsUuidCursorIDPage,
+} from './withdraws';
+export { WsPrivate, type ConnectPrivateClientEvent, type ConnectPrivateServerEvent } from './ws-private';
+export { WsPublic, type ConnectPublicClientEvent, type ConnectPublicServerEvent } from './ws-public';