better-bitkub-client 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,6 @@
 # better-bitkub-client
 
-TypeScript rewrite of the repository's C# `bitkubwrapper` library.
+TypeScript client for working with Bitkub V3 and V4 APIs, based on Bitkub's official API documentation.
 
 ## What it includes
 
@@ -12,14 +12,13 @@ TypeScript rewrite of the repository's C# `bitkubwrapper` library.
 ## Install
 
 ```bash
-npm install
-npm run build
+npm install better-bitkub-client
 ```
 
 ## Usage
 
 ```ts
-import { BitkubV3Client, BitkubV4Client } from "./dist/index.js";
+import { BitkubV3Client, BitkubV4Client } from "better-bitkub-client";
 
 const v3 = new BitkubV3Client({
   apiKey: process.env.BITKUB_KEY!,
@@ -40,3 +39,4 @@ const withdraws = await v4.getCryptoWithdraws({ limit: 50 });
 - Requires Node 18+ for the built-in `fetch` API.
 - The default base URL is `https://api.bitkub.com`.
 - DTOs keep Bitkub's field names to make request/response handling predictable.
+- Official API reference: [bitkub/bitkub-official-api-docs](https://github.com/bitkub/bitkub-official-api-docs)

package/dist/v3-client.d.ts

@@ -2,26 +2,308 @@ import { BitkubBaseClient, type BitkubClientOptions } from "./base-client.js";
 import type { BalanceInfo, BankAccount, BitkubV3Response, CancelOrderRequest, CoinConvertHistoryItem, CoinConvertHistoryOptions, Depth, FiatDepositHistoryItem, FiatWithdrawHistoryItem, FiatWithdrawRequest, FiatWithdrawResponse, LimitsResponse, OpenOrder, OrderBookEntry, OrderHistoryItem, OrderHistoryOptions, OrderInfo, PlaceOrderRequest, PlaceOrderResponse, RawTrade, StatusResponse, SymbolInfo, Ticker } from "./types/v3.js";
 export declare class BitkubV3Client extends BitkubBaseClient {
     constructor(options: BitkubClientOptions);
+    /**
+     * Get Bitkub service status information.
+     *
+     * Endpoint: `GET /api/status`
+     * Auth: none
+     *
+     * Returns exchange service components and their current status.
+     *
+     * @see https://api.bitkub.com/docs
+     */
     getStatus(): Promise<StatusResponse[]>;
+    /**
+     * List tradable market symbols and symbol metadata.
+     *
+     * Endpoint: `GET /api/v3/market/symbols`
+     * Auth: none
+     *
+     * Includes symbol-level configuration such as price step, quantity step,
+     * scaling, trading status, and freeze flags.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/symbols?method=GET
+     */
     getSymbols(): Promise<BitkubV3Response<SymbolInfo[]>>;
+    /**
+     * Get 24h ticker data for one symbol or all symbols.
+     *
+     * Endpoint: `GET /api/v3/market/ticker`
+     * Auth: none
+     *
+     * Query:
+     * - `sym` optional market symbol such as `BTC_THB`
+     *
+     * Returns latest price, best bid/ask, 24h high/low, and volume fields.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/ticker?method=GET
+     */
     getTicker(symbol?: string): Promise<Ticker[]>;
+    /**
+     * List open buy orders from the public order book.
+     *
+     * Endpoint: `GET /api/v3/market/bids`
+     * Auth: none
+     *
+     * Query:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `lmt` optional number of rows to return
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/bids?method=GET
+     */
     getBids(symbol: string, limit?: number): Promise<BitkubV3Response<OrderBookEntry[]>>;
+    /**
+     * List open sell orders from the public order book.
+     *
+     * Endpoint: `GET /api/v3/market/asks`
+     * Auth: none
+     *
+     * Query:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `lmt` optional number of rows to return
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/asks?method=GET
+     */
     getAsks(symbol: string, limit?: number): Promise<BitkubV3Response<OrderBookEntry[]>>;
+    /**
+     * Get aggregated market depth for a symbol.
+     *
+     * Endpoint: `GET /api/v3/market/depth`
+     * Auth: none
+     *
+     * Query:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `lmt` optional depth size
+     *
+     * Returns bid and ask levels as `[price, size]` tuples.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/depth?method=GET
+     */
     getDepth(symbol: string, limit?: number): Promise<BitkubV3Response<Depth>>;
+    /**
+     * List recent public trades for a symbol.
+     *
+     * Endpoint: `GET /api/v3/market/trades`
+     * Auth: none
+     *
+     * Query:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `lmt` optional number of trades to return
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/trades?method=GET
+     */
     getTrades(symbol: string, limit?: number): Promise<BitkubV3Response<RawTrade[]>>;
+    /**
+     * Check the remaining trading credit balance on the account.
+     *
+     * Endpoint: `POST /api/v3/user/trading-credits`
+     * Auth: secure endpoint
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/user/trading-credits?method=POST
+     */
     getTradingCredits(): Promise<BitkubV3Response<number>>;
+    /**
+     * Get fiat and crypto deposit/withdraw limits together with current usage.
+     *
+     * Endpoint: `POST /api/v3/user/limits`
+     * Auth: secure endpoint
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/user/limits?method=POST
+     */
     getLimits(): Promise<BitkubV3Response<LimitsResponse>>;
+    /**
+     * List coin conversion history for the authenticated user.
+     *
+     * Endpoint: `GET /api/v3/user/coin-convert-history`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `p`, `lmt` pagination
+     * - `sort` sort direction
+     * - `status` conversion status
+     * - `sym` symbol filter
+     * - `start`, `end` timestamp range
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/user/coin-convert-history?method=GET
+     */
     getCoinConvertHistory(options?: CoinConvertHistoryOptions): Promise<BitkubV3Response<CoinConvertHistoryItem[]>>;
+    /**
+     * Get currently available balances by asset.
+     *
+     * Endpoint: `POST /api/v3/market/wallet`
+     * Auth: secure endpoint
+     *
+     * This endpoint returns available balances only. Use `getBalances()` for
+     * available plus reserved balances.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/wallet?method=POST
+     */
     getWallet(): Promise<BitkubV3Response<Record<string, number>>>;
+    /**
+     * Get available and reserved balances by asset.
+     *
+     * Endpoint: `POST /api/v3/market/balances`
+     * Auth: secure endpoint
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/balances?method=POST
+     */
     getBalances(): Promise<BitkubV3Response<Record<string, BalanceInfo>>>;
+    /**
+     * Create a buy order.
+     *
+     * Endpoint: `POST /api/v3/market/place-bid`
+     * Auth: secure endpoint, trading permission required
+     *
+     * Body:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `amt` quote amount to spend
+     * - `rat` order rate; use `0` for market orders
+     * - `typ` `limit` or `market` (defaults to `limit` when omitted)
+     * - `client_id` optional client reference
+     * - `post_only` optional post-only flag
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/place-bid?method=POST
+     */
     placeBid(request: PlaceOrderRequest): Promise<BitkubV3Response<PlaceOrderResponse>>;
+    /**
+     * Create a sell order.
+     *
+     * Endpoint: `POST /api/v3/market/place-ask`
+     * Auth: secure endpoint, trading permission required
+     *
+     * Body:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `amt` base asset amount to sell
+     * - `rat` order rate; use `0` for market orders
+     * - `typ` `limit` or `market` (defaults to `limit` when omitted)
+     * - `client_id` optional client reference
+     * - `post_only` optional post-only flag
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/place-ask?method=POST
+     */
     placeAsk(request: PlaceOrderRequest): Promise<BitkubV3Response<PlaceOrderResponse>>;
+    /**
+     * Cancel an existing order.
+     *
+     * Endpoint: `POST /api/v3/market/cancel-order`
+     * Auth: secure endpoint, trading permission required
+     *
+     * Body:
+     * - `sym` market symbol
+     * - `id` order id
+     * - `sd` order side: `buy` or `sell`
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/cancel-order?method=POST
+     */
     cancelOrder(request: CancelOrderRequest): Promise<BitkubV3Response<unknown>>;
+    /**
+     * List current open orders for a symbol.
+     *
+     * Endpoint: `GET /api/v3/market/my-open-orders`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `sym` market symbol such as `BTC_THB`
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/my-open-orders?method=GET
+     */
     getMyOpenOrders(symbol: string): Promise<BitkubV3Response<OpenOrder[]>>;
+    /**
+     * List the authenticated user's order history for a symbol.
+     *
+     * Endpoint: `GET /api/v3/market/my-order-history`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `p`, `lmt` page-based pagination
+     * - `cursor`, `pagination_type` cursor-based pagination
+     * - `start`, `end` date-time range
+     *
+     * Note: Bitkub announced page-based pagination deprecation for this
+     * endpoint on 2025-09-08, and order history older than 90 days is archived.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/my-order-history?method=GET
+     */
     getMyOrderHistory(symbol: string, options?: OrderHistoryOptions): Promise<BitkubV3Response<OrderHistoryItem[]>>;
+    /**
+     * Get detailed information for a specific order.
+     *
+     * Endpoint: `GET /api/v3/market/order-info`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `sym` market symbol
+     * - `id` order id
+     * - `sd` order side: `buy` or `sell`
+     *
+     * Returns order status, fill progress, remaining quantity, and fill history.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/order-info?method=GET
+     */
     getOrderInfo(symbol: string, orderId: string, side: string): Promise<BitkubV3Response<OrderInfo>>;
+    /**
+     * List approved fiat withdrawal bank accounts.
+     *
+     * Endpoint: `POST /api/v3/fiat/accounts`
+     * Auth: secure endpoint, withdraw permission typically required
+     *
+     * Query:
+     * - `p` optional page number
+     * - `lmt` optional page size
+     *
+     * Note: Bitkub announced v3 fiat endpoint deprecation on 2026-06-09 in
+     * favor of Fiat v4 endpoints.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/fiat/accounts?method=POST
+     */
     getFiatAccounts(page?: number, limit?: number): Promise<BitkubV3Response<BankAccount[]>>;
+    /**
+     * Withdraw fiat to an approved bank account.
+     *
+     * Endpoint: `POST /api/v3/fiat/withdraw`
+     * Auth: secure endpoint
+     *
+     * Body:
+     * - `id` approved bank account id
+     * - `amt` amount to withdraw
+     *
+     * Note: Bitkub announced v3 fiat endpoint deprecation on 2026-06-09 in
+     * favor of Fiat v4 endpoints.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/fiat/withdraw?method=POST
+     */
     fiatWithdraw(request: FiatWithdrawRequest): Promise<BitkubV3Response<FiatWithdrawResponse>>;
+    /**
+     * List fiat deposit history.
+     *
+     * Endpoint: `POST /api/v3/fiat/deposit-history`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `p` optional page number
+     * - `lmt` optional page size
+     *
+     * Note: Bitkub announced v3 fiat endpoint deprecation on 2026-06-09 in
+     * favor of Fiat v4 endpoints.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/fiat/deposit-history?method=POST
+     */
     getFiatDepositHistory(page?: number, limit?: number): Promise<BitkubV3Response<FiatDepositHistoryItem[]>>;
+    /**
+     * List fiat withdrawal history.
+     *
+     * Endpoint: `POST /api/v3/fiat/withdraw-history`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `p` optional page number
+     * - `lmt` optional page size
+     *
+     * Note: Bitkub announced v3 fiat endpoint deprecation on 2026-06-09 in
+     * favor of Fiat v4 endpoints.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/fiat/withdraw-history?method=POST
+     */
     getFiatWithdrawHistory(page?: number, limit?: number): Promise<BitkubV3Response<FiatWithdrawHistoryItem[]>>;
 }

package/dist/v3-client.js

@@ -3,43 +3,158 @@ export class BitkubV3Client extends BitkubBaseClient {
     constructor(options) {
         super(options);
     }
+    /**
+     * Get Bitkub service status information.
+     *
+     * Endpoint: `GET /api/status`
+     * Auth: none
+     *
+     * Returns exchange service components and their current status.
+     *
+     * @see https://api.bitkub.com/docs
+     */
     async getStatus() {
         return this.sendRequest("GET", "/api/status");
     }
+    /**
+     * List tradable market symbols and symbol metadata.
+     *
+     * Endpoint: `GET /api/v3/market/symbols`
+     * Auth: none
+     *
+     * Includes symbol-level configuration such as price step, quantity step,
+     * scaling, trading status, and freeze flags.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/symbols?method=GET
+     */
     async getSymbols() {
         return this.sendRequest("GET", "/api/v3/market/symbols");
     }
+    /**
+     * Get 24h ticker data for one symbol or all symbols.
+     *
+     * Endpoint: `GET /api/v3/market/ticker`
+     * Auth: none
+     *
+     * Query:
+     * - `sym` optional market symbol such as `BTC_THB`
+     *
+     * Returns latest price, best bid/ask, 24h high/low, and volume fields.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/ticker?method=GET
+     */
     async getTicker(symbol) {
         return this.sendRequest("GET", "/api/v3/market/ticker", {
             queryParams: symbol ? { sym: symbol } : undefined
         });
     }
+    /**
+     * List open buy orders from the public order book.
+     *
+     * Endpoint: `GET /api/v3/market/bids`
+     * Auth: none
+     *
+     * Query:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `lmt` optional number of rows to return
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/bids?method=GET
+     */
     async getBids(symbol, limit) {
         return this.sendRequest("GET", "/api/v3/market/bids", {
             queryParams: { sym: symbol, lmt: limit }
         });
     }
+    /**
+     * List open sell orders from the public order book.
+     *
+     * Endpoint: `GET /api/v3/market/asks`
+     * Auth: none
+     *
+     * Query:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `lmt` optional number of rows to return
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/asks?method=GET
+     */
     async getAsks(symbol, limit) {
         return this.sendRequest("GET", "/api/v3/market/asks", {
             queryParams: { sym: symbol, lmt: limit }
         });
     }
+    /**
+     * Get aggregated market depth for a symbol.
+     *
+     * Endpoint: `GET /api/v3/market/depth`
+     * Auth: none
+     *
+     * Query:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `lmt` optional depth size
+     *
+     * Returns bid and ask levels as `[price, size]` tuples.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/depth?method=GET
+     */
     async getDepth(symbol, limit) {
         return this.sendRequest("GET", "/api/v3/market/depth", {
             queryParams: { sym: symbol, lmt: limit }
         });
     }
+    /**
+     * List recent public trades for a symbol.
+     *
+     * Endpoint: `GET /api/v3/market/trades`
+     * Auth: none
+     *
+     * Query:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `lmt` optional number of trades to return
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/trades?method=GET
+     */
     async getTrades(symbol, limit) {
         return this.sendRequest("GET", "/api/v3/market/trades", {
             queryParams: { sym: symbol, lmt: limit }
         });
     }
+    /**
+     * Check the remaining trading credit balance on the account.
+     *
+     * Endpoint: `POST /api/v3/user/trading-credits`
+     * Auth: secure endpoint
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/user/trading-credits?method=POST
+     */
     async getTradingCredits() {
         return this.sendSecureRequest("POST", "/api/v3/user/trading-credits");
     }
+    /**
+     * Get fiat and crypto deposit/withdraw limits together with current usage.
+     *
+     * Endpoint: `POST /api/v3/user/limits`
+     * Auth: secure endpoint
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/user/limits?method=POST
+     */
     async getLimits() {
         return this.sendSecureRequest("POST", "/api/v3/user/limits");
     }
+    /**
+     * List coin conversion history for the authenticated user.
+     *
+     * Endpoint: `GET /api/v3/user/coin-convert-history`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `p`, `lmt` pagination
+     * - `sort` sort direction
+     * - `status` conversion status
+     * - `sym` symbol filter
+     * - `start`, `end` timestamp range
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/user/coin-convert-history?method=GET
+     */
     async getCoinConvertHistory(options = {}) {
         return this.sendSecureRequest("GET", "/api/v3/user/coin-convert-history", {
             queryParams: {
@@ -53,32 +168,124 @@ export class BitkubV3Client extends BitkubBaseClient {
             }
         });
     }
+    /**
+     * Get currently available balances by asset.
+     *
+     * Endpoint: `POST /api/v3/market/wallet`
+     * Auth: secure endpoint
+     *
+     * This endpoint returns available balances only. Use `getBalances()` for
+     * available plus reserved balances.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/wallet?method=POST
+     */
     async getWallet() {
         return this.sendSecureRequest("POST", "/api/v3/market/wallet");
     }
+    /**
+     * Get available and reserved balances by asset.
+     *
+     * Endpoint: `POST /api/v3/market/balances`
+     * Auth: secure endpoint
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/balances?method=POST
+     */
     async getBalances() {
         return this.sendSecureRequest("POST", "/api/v3/market/balances");
     }
+    /**
+     * Create a buy order.
+     *
+     * Endpoint: `POST /api/v3/market/place-bid`
+     * Auth: secure endpoint, trading permission required
+     *
+     * Body:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `amt` quote amount to spend
+     * - `rat` order rate; use `0` for market orders
+     * - `typ` `limit` or `market` (defaults to `limit` when omitted)
+     * - `client_id` optional client reference
+     * - `post_only` optional post-only flag
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/place-bid?method=POST
+     */
     async placeBid(request) {
         return this.sendSecureRequest("POST", "/api/v3/market/place-bid", {
             body: { typ: "limit", ...request }
         });
     }
+    /**
+     * Create a sell order.
+     *
+     * Endpoint: `POST /api/v3/market/place-ask`
+     * Auth: secure endpoint, trading permission required
+     *
+     * Body:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `amt` base asset amount to sell
+     * - `rat` order rate; use `0` for market orders
+     * - `typ` `limit` or `market` (defaults to `limit` when omitted)
+     * - `client_id` optional client reference
+     * - `post_only` optional post-only flag
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/place-ask?method=POST
+     */
     async placeAsk(request) {
         return this.sendSecureRequest("POST", "/api/v3/market/place-ask", {
             body: { typ: "limit", ...request }
         });
     }
+    /**
+     * Cancel an existing order.
+     *
+     * Endpoint: `POST /api/v3/market/cancel-order`
+     * Auth: secure endpoint, trading permission required
+     *
+     * Body:
+     * - `sym` market symbol
+     * - `id` order id
+     * - `sd` order side: `buy` or `sell`
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/cancel-order?method=POST
+     */
     async cancelOrder(request) {
         return this.sendSecureRequest("POST", "/api/v3/market/cancel-order", {
             body: request
         });
     }
+    /**
+     * List current open orders for a symbol.
+     *
+     * Endpoint: `GET /api/v3/market/my-open-orders`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `sym` market symbol such as `BTC_THB`
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/my-open-orders?method=GET
+     */
     async getMyOpenOrders(symbol) {
         return this.sendSecureRequest("GET", "/api/v3/market/my-open-orders", {
             queryParams: { sym: symbol }
         });
     }
+    /**
+     * List the authenticated user's order history for a symbol.
+     *
+     * Endpoint: `GET /api/v3/market/my-order-history`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `sym` market symbol such as `BTC_THB`
+     * - `p`, `lmt` page-based pagination
+     * - `cursor`, `pagination_type` cursor-based pagination
+     * - `start`, `end` date-time range
+     *
+     * Note: Bitkub announced page-based pagination deprecation for this
+     * endpoint on 2025-09-08, and order history older than 90 days is archived.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/my-order-history?method=GET
+     */
     async getMyOrderHistory(symbol, options = {}) {
         return this.sendSecureRequest("GET", "/api/v3/market/my-order-history", {
             queryParams: {
@@ -92,6 +299,21 @@ export class BitkubV3Client extends BitkubBaseClient {
             }
         });
     }
+    /**
+     * Get detailed information for a specific order.
+     *
+     * Endpoint: `GET /api/v3/market/order-info`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `sym` market symbol
+     * - `id` order id
+     * - `sd` order side: `buy` or `sell`
+     *
+     * Returns order status, fill progress, remaining quantity, and fill history.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/market/order-info?method=GET
+     */
     async getOrderInfo(symbol, orderId, side) {
         return this.sendSecureRequest("GET", "/api/v3/market/order-info", {
             queryParams: {
@@ -101,21 +323,81 @@ export class BitkubV3Client extends BitkubBaseClient {
             }
         });
     }
+    /**
+     * List approved fiat withdrawal bank accounts.
+     *
+     * Endpoint: `POST /api/v3/fiat/accounts`
+     * Auth: secure endpoint, withdraw permission typically required
+     *
+     * Query:
+     * - `p` optional page number
+     * - `lmt` optional page size
+     *
+     * Note: Bitkub announced v3 fiat endpoint deprecation on 2026-06-09 in
+     * favor of Fiat v4 endpoints.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/fiat/accounts?method=POST
+     */
     async getFiatAccounts(page, limit) {
         return this.sendSecureRequest("POST", "/api/v3/fiat/accounts", {
             queryParams: { p: page, lmt: limit }
         });
     }
+    /**
+     * Withdraw fiat to an approved bank account.
+     *
+     * Endpoint: `POST /api/v3/fiat/withdraw`
+     * Auth: secure endpoint
+     *
+     * Body:
+     * - `id` approved bank account id
+     * - `amt` amount to withdraw
+     *
+     * Note: Bitkub announced v3 fiat endpoint deprecation on 2026-06-09 in
+     * favor of Fiat v4 endpoints.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/fiat/withdraw?method=POST
+     */
     async fiatWithdraw(request) {
         return this.sendSecureRequest("POST", "/api/v3/fiat/withdraw", {
             body: request
         });
     }
+    /**
+     * List fiat deposit history.
+     *
+     * Endpoint: `POST /api/v3/fiat/deposit-history`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `p` optional page number
+     * - `lmt` optional page size
+     *
+     * Note: Bitkub announced v3 fiat endpoint deprecation on 2026-06-09 in
+     * favor of Fiat v4 endpoints.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/fiat/deposit-history?method=POST
+     */
     async getFiatDepositHistory(page, limit) {
         return this.sendSecureRequest("POST", "/api/v3/fiat/deposit-history", {
             queryParams: { p: page, lmt: limit }
         });
     }
+    /**
+     * List fiat withdrawal history.
+     *
+     * Endpoint: `POST /api/v3/fiat/withdraw-history`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `p` optional page number
+     * - `lmt` optional page size
+     *
+     * Note: Bitkub announced v3 fiat endpoint deprecation on 2026-06-09 in
+     * favor of Fiat v4 endpoints.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v3/fiat/withdraw-history?method=POST
+     */
     async getFiatWithdrawHistory(page, limit) {
         return this.sendSecureRequest("POST", "/api/v3/fiat/withdraw-history", {
             queryParams: { p: page, lmt: limit }

package/dist/v4-client.d.ts

@@ -2,11 +2,121 @@ import { BitkubBaseClient, type BitkubClientOptions } from "./base-client.js";
 import type { BitkubV4Response, CoinsOptions, CoinsResponse, CompensationsOptions, CompensationsResponse, CreateCryptoAddressRequest, CreateCryptoWithdrawRequest, CreateCryptoWithdrawResponse, CryptoAddress, CryptoAddressesOptions, CryptoAddressesResponse, CryptoDepositsOptions, CryptoDepositsResponse, CryptoWithdrawsOptions, CryptoWithdrawsResponse } from "./types/v4.js";
 export declare class BitkubV4Client extends BitkubBaseClient {
     constructor(options: BitkubClientOptions);
+    /**
+     * List crypto deposit addresses for the authenticated account.
+     *
+     * Endpoint: `GET /api/v4/crypto/addresses`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `page` optional page number, default `1`
+     * - `limit` optional page size, default `100`, max `200`
+     * - `symbol` optional coin symbol such as `ATOM`
+     * - `network` optional network such as `ATOM`
+     * - `memo` optional memo filter
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/addresses?method=GET
+     */
     getCryptoAddresses(options?: CryptoAddressesOptions): Promise<BitkubV4Response<CryptoAddressesResponse>>;
+    /**
+     * Generate or return an existing crypto deposit address.
+     *
+     * Endpoint: `POST /api/v4/crypto/addresses`
+     * Auth: secure endpoint, `is_deposit` permission required
+     *
+     * Body:
+     * - `symbol` coin symbol such as `ETH`
+     * - `network` network such as `ETH`
+     *
+     * Per the official docs, if an address already exists Bitkub returns the
+     * existing address instead of creating a new one.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/addresses?method=POST
+     */
     createCryptoAddress(request: CreateCryptoAddressRequest): Promise<BitkubV4Response<CryptoAddress[]>>;
+    /**
+     * List crypto deposit history.
+     *
+     * Endpoint: `GET /api/v4/crypto/deposits`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `page` optional page number
+     * - `limit` optional page size, max `200`
+     * - `symbol` optional coin symbol
+     * - `status` optional deposit status: `pending`, `rejected`, `complete`
+     * - `created_start`, `created_end` optional ISO 8601 time range
+     *
+     * Note: the official docs state only the last 90 days of deposit history are
+     * returned.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/deposits?method=GET
+     */
     getCryptoDeposits(options?: CryptoDepositsOptions): Promise<BitkubV4Response<CryptoDepositsResponse>>;
+    /**
+     * List crypto withdrawal history.
+     *
+     * Endpoint: `GET /api/v4/crypto/withdraws`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `page` optional page number
+     * - `limit` optional page size, max `200`
+     * - `symbol` optional coin symbol
+     * - `status` optional withdrawal status: `pending`, `processing`,
+     *   `reported`, `rejected`, `complete`
+     * - `created_start`, `created_end` optional ISO 8601 time range
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/withdraws?method=GET
+     */
     getCryptoWithdraws(options?: CryptoWithdrawsOptions): Promise<BitkubV4Response<CryptoWithdrawsResponse>>;
+    /**
+     * Withdraw crypto to a trusted address.
+     *
+     * Endpoint: `POST /api/v4/crypto/withdraws`
+     * Auth: secure endpoint, `is_withdraw` permission required
+     *
+     * Body:
+     * - `symbol` coin symbol such as `BTC`
+     * - `amount` amount to withdraw
+     * - `address` trusted destination address
+     * - `memo` optional memo or destination tag
+     * - `network` withdrawal network
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/withdraws?method=POST
+     */
     createCryptoWithdraw(request: CreateCryptoWithdrawRequest): Promise<BitkubV4Response<CreateCryptoWithdrawResponse>>;
+    /**
+     * List coin metadata and deposit/withdraw availability.
+     *
+     * Endpoint: `GET /api/v4/crypto/coins`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `symbol` optional coin symbol
+     * - `network` optional network
+     *
+     * Returns coin/network settings such as regex validation, explorer URL,
+     * fees, minimums, confirmations, and enablement flags.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/coins?method=GET
+     */
     getCoins(options?: CoinsOptions): Promise<BitkubV4Response<CoinsResponse>>;
+    /**
+     * List crypto compensation history.
+     *
+     * Endpoint: `GET /api/v4/crypto/compensations`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `page` optional page number
+     * - `limit` optional page size, max `200`
+     * - `symbol` optional coin symbol
+     * - `type` optional compensation type: `COMPENSATE` or `DECOMPENSATE`
+     * - `status` optional status; current docs show `complete`
+     * - `created_start`, `created_end` optional ISO 8601 time range
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/compensations?method=GET
+     */
     getCompensations(options?: CompensationsOptions): Promise<BitkubV4Response<CompensationsResponse>>;
 }

package/dist/v4-client.js

@@ -3,6 +3,21 @@ export class BitkubV4Client extends BitkubBaseClient {
     constructor(options) {
         super(options);
     }
+    /**
+     * List crypto deposit addresses for the authenticated account.
+     *
+     * Endpoint: `GET /api/v4/crypto/addresses`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `page` optional page number, default `1`
+     * - `limit` optional page size, default `100`, max `200`
+     * - `symbol` optional coin symbol such as `ATOM`
+     * - `network` optional network such as `ATOM`
+     * - `memo` optional memo filter
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/addresses?method=GET
+     */
     async getCryptoAddresses(options = {}) {
         return this.sendSecureRequest("GET", "/api/v4/crypto/addresses", {
             queryParams: {
@@ -14,11 +29,44 @@ export class BitkubV4Client extends BitkubBaseClient {
             }
         });
     }
+    /**
+     * Generate or return an existing crypto deposit address.
+     *
+     * Endpoint: `POST /api/v4/crypto/addresses`
+     * Auth: secure endpoint, `is_deposit` permission required
+     *
+     * Body:
+     * - `symbol` coin symbol such as `ETH`
+     * - `network` network such as `ETH`
+     *
+     * Per the official docs, if an address already exists Bitkub returns the
+     * existing address instead of creating a new one.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/addresses?method=POST
+     */
     async createCryptoAddress(request) {
         return this.sendSecureRequest("POST", "/api/v4/crypto/addresses", {
             body: request
         });
     }
+    /**
+     * List crypto deposit history.
+     *
+     * Endpoint: `GET /api/v4/crypto/deposits`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `page` optional page number
+     * - `limit` optional page size, max `200`
+     * - `symbol` optional coin symbol
+     * - `status` optional deposit status: `pending`, `rejected`, `complete`
+     * - `created_start`, `created_end` optional ISO 8601 time range
+     *
+     * Note: the official docs state only the last 90 days of deposit history are
+     * returned.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/deposits?method=GET
+     */
     async getCryptoDeposits(options = {}) {
         return this.sendSecureRequest("GET", "/api/v4/crypto/deposits", {
             queryParams: {
@@ -31,6 +79,22 @@ export class BitkubV4Client extends BitkubBaseClient {
             }
         });
     }
+    /**
+     * List crypto withdrawal history.
+     *
+     * Endpoint: `GET /api/v4/crypto/withdraws`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `page` optional page number
+     * - `limit` optional page size, max `200`
+     * - `symbol` optional coin symbol
+     * - `status` optional withdrawal status: `pending`, `processing`,
+     *   `reported`, `rejected`, `complete`
+     * - `created_start`, `created_end` optional ISO 8601 time range
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/withdraws?method=GET
+     */
     async getCryptoWithdraws(options = {}) {
         return this.sendSecureRequest("GET", "/api/v4/crypto/withdraws", {
             queryParams: {
@@ -43,11 +107,41 @@ export class BitkubV4Client extends BitkubBaseClient {
             }
         });
     }
+    /**
+     * Withdraw crypto to a trusted address.
+     *
+     * Endpoint: `POST /api/v4/crypto/withdraws`
+     * Auth: secure endpoint, `is_withdraw` permission required
+     *
+     * Body:
+     * - `symbol` coin symbol such as `BTC`
+     * - `amount` amount to withdraw
+     * - `address` trusted destination address
+     * - `memo` optional memo or destination tag
+     * - `network` withdrawal network
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/withdraws?method=POST
+     */
     async createCryptoWithdraw(request) {
         return this.sendSecureRequest("POST", "/api/v4/crypto/withdraws", {
             body: request
         });
     }
+    /**
+     * List coin metadata and deposit/withdraw availability.
+     *
+     * Endpoint: `GET /api/v4/crypto/coins`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `symbol` optional coin symbol
+     * - `network` optional network
+     *
+     * Returns coin/network settings such as regex validation, explorer URL,
+     * fees, minimums, confirmations, and enablement flags.
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/coins?method=GET
+     */
     async getCoins(options = {}) {
         return this.sendSecureRequest("GET", "/api/v4/crypto/coins", {
             queryParams: {
@@ -56,6 +150,22 @@ export class BitkubV4Client extends BitkubBaseClient {
             }
         });
     }
+    /**
+     * List crypto compensation history.
+     *
+     * Endpoint: `GET /api/v4/crypto/compensations`
+     * Auth: secure endpoint
+     *
+     * Query:
+     * - `page` optional page number
+     * - `limit` optional page size, max `200`
+     * - `symbol` optional coin symbol
+     * - `type` optional compensation type: `COMPENSATE` or `DECOMPENSATE`
+     * - `status` optional status; current docs show `complete`
+     * - `created_start`, `created_end` optional ISO 8601 time range
+     *
+     * @see https://api.bitkub.com/docs/endpoint/api/v4/crypto/compensations?method=GET
+     */
     async getCompensations(options = {}) {
         return this.sendSecureRequest("GET", "/api/v4/crypto/compensations", {
             queryParams: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "better-bitkub-client",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "TypeScript client for Bitkub V3 and V4 APIs",
   "license": "MIT",
   "repository": {