@upbit-official/upbit-sdk 0.9.0

package/src/resources/wallet-status.ts

@@ -0,0 +1,87 @@
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class WalletStatus extends APIResource {
+  /**
+   * Get Deposit/Withdrawal Service Status
+   *
+   * GET /v1/status/wallet
+   *
+   * - docs(kr): https://docs.upbit.com/kr/reference/get-service-status
+   * - docs(global): https://global-docs.upbit.com/reference/get-service-status
+   */
+  list(options?: RequestOptions): APIPromise<WalletStatusListResponse> {
+    return this._client.get('/v1/status/wallet', options);
+  }
+}
+
+export type WalletStatusListResponse = Array<WalletStatusListResponse.WalletStatusListResponseItem>;
+
+export namespace WalletStatusListResponse {
+  export interface WalletStatusListResponseItem {
+    /**
+     * Minutes elapsed since the last block update. May return null.
+     */
+    block_elapsed_minutes: number;
+
+    /**
+     * Currency code to be queried.
+     */
+    currency: string;
+
+    /**
+     * Deposit/withdrawal network type.
+     *
+     * Blockchain network identifier used by Upbit.
+     *
+     * [Example] "ETH", "TRX", "SOL"
+     */
+    net_type: string;
+
+    /**
+     * Deposit/withdrawal network name displayed to users.
+     *
+     * [Example] "Ethereum", "Bitcoin", "Tron", "Solana"
+     */
+    network_name: string;
+
+    /**
+     * Deposit/withdrawal status.
+     *
+     * - `working`: Both available
+     * - `withdraw_only`: Withdrawal only
+     * - `deposit_only`: Deposit only
+     * - `paused`: Both suspended
+     * - `unsupported`: Not supported
+     */
+    wallet_state: 'working' | 'withdraw_only' | 'deposit_only' | 'paused' | 'unsupported';
+
+    /**
+     * Current confirmed block height. May return null.
+     */
+    block_height?: number;
+
+    /**
+     * Blockchain network state. May return null depending on wallet or exchange
+     * status.
+     *
+     * - `normal`: Normal
+     * - `delayed`: Delayed
+     * - `inactive`: Inactive
+     */
+    block_state?: 'normal' | 'delayed' | 'inactive';
+
+    /**
+     * Timestamp when the block height was last updated (UTC). May return null.
+     *
+     * [Format] yyyy-MM-dd'T'HH:mm:sss+00:00
+     */
+    block_updated_at?: string;
+  }
+}
+
+export declare namespace WalletStatus {
+  export { type WalletStatusListResponse as WalletStatusListResponse };
+}