@coinset/bitmart
Version:
Universal BitMart API client
39 lines (38 loc) • 1.51 kB
TypeScript
import { SuccessResponse } from "./_utils.js";
export declare type SymbolDetailsResponse = SuccessResponse<{
/** Array of trading pairs */
symbols: {
/** Trading pair name */
symbol: `${string}_${string}`;
/** Trading pair id */
symbol_id: number;
/** Base currency */
base_currency: string;
/** Quote currency */
quote_currency: string;
/** The minimum order quantity is also the minimum order quantity increment */
quote_increment: number;
/** Minimum order quantity */
base_min_size: number;
/** Maximum order quantity */
base_max_size: number;
/** Minimum price accuracy (decimal places), used to query k-line and depth */
price_min_precision: number;
/** Maximum price accuracy (decimal places), used to query k-line and depth */
price_max_precision: number;
/** Expiration time of trading pair */
expiration: "NA";
/** Minimum order amount */
min_buy_amount: number;
/** Maximum order amount */
min_sell_amount: number;
}[];
}>;
/** Get a detailed list of all trading pairs on the platform.
* ```ts
* import { fetchSymbolDetails } from "https://deno.land/x/bitmart@$VERSION/mod.ts"
* await fetchSymbolDetails()
* ```
* @see https://developer-pro.bitmart.com/en/spot/basic/symbols_detail.html
*/
export declare function fetchSymbolDetails(init?: RequestInit): Promise<SymbolDetailsResponse>;