bitmart-api/dist/mjs/types/response/spot.types.d.ts

Complete & robust Node.js SDK for BitMart's REST APIs and WebSockets, with TypeScript declarations.

import { OrderSide } from './shared.types.js';
export interface ServiceStatus {
    title: string;
    service_type: string;
    status: number;
    start_time: number;
    end_time: number;
}
export interface SpotCurrencyV1 {
    id: string;
    name: string;
    withdraw_enabled: boolean;
    deposit_enabled: boolean;
}
export interface SpotTradingPairDetailsV1 {
    symbol: string;
    symbol_id: string;
    base_currency: string;
    quote_currency: string;
    quote_increment: string;
    base_min_size: string;
    base_max_size: string;
    price_min_precision: number;
    price_max_precision: number;
    expiration: string;
    min_buy_amount: string;
    min_sell_amount: string;
}
/**
 * [symbol, last, v_24h, qv_24h, open_24h, high_24h, low_24h, fluctuation, bid_px, bid_sz, ask_px, ask_sz, ts]
 */
export type ArrayFormSpotTickerV3 = [
    string,
    string,
    string,
    string,
    string,
    string,
    string,
    string,
    string,
    string,
    string,
    string,
    string
];
export interface SpotTickerV3 {
    symbol: string;
    last: string;
    v_24h: string;
    qv_24h: string;
    open_24h: string;
    high_24h: string;
    low_24h: string;
    fluctuation: string;
    bid_px: string;
    bid_sz: string;
    ask_px: string;
    ask_sz: string;
    ts: string;
}
/**
 * [t,o,h,l,c,v,qv]
 */
export type ArrayFormSpotKlineV3 = [
    string,
    string,
    string,
    string,
    string,
    string,
    string
];
/**
 * [price, amount]
 */
export type BookPriceLevel = [
    string,
    string
];
export interface SpotOrderBookDepthResultV3 {
    ts: string;
    symbol: string;
    asks: BookPriceLevel[];
    bids: BookPriceLevel[];
}
/**
 * [symbol, ts, price, size, side]
 */
export type ArrayFormSpotRecentTrade = [
    string,
    string,
    string,
    string,
    OrderSide
];
export interface SpotTickerV1 {
    symbol: string;
    last_price: string;
    quote_volume_24h: string;
    base_volume_24h: string;
    high_24h: string;
    low_24h: string;
    open_24h: string;
    close_24h: string;
    best_ask: string;
    best_ask_size: string;
    best_bid: string;
    best_bid_size: string;
    fluctuation: string;
    timestamp: number;
    url: string;
}
export interface SpotKlineV1 {
    timestamp: number;
    open: string;
    high: string;
    low: string;
    close: string;
    last_price: string;
    volume: string;
    quote_volume: string;
}
export interface SpotBookLevelV1 {
    amount: string;
    total: string;
    price: string;
    count: string;
}
export interface SpotOrderBookDepthResultV1 {
    timestamp: number;
    buys: SpotBookLevelV1[];
    sells: SpotBookLevelV1[];
}
export interface AccountCurrencyV1 {
    currency: string;
    name: string;
    contract_address: string | null;
    network: string;
    withdraw_enabled: boolean;
    deposit_enabled: boolean;
    withdraw_minsize: string | null;
    withdraw_minfee: string | null;
    withdraw_fee: string | null;
    withdraw_maxsize: string | null;
}
export interface SpotWalletBalanceV1 {
    id: string;
    available: string;
    name: string;
    frozen: string;
}
export interface AccountDepositAddressV1 {
    currency: string;
    chain: string;
    address: string;
    address_memo: string;
}
export interface AccountWithdrawQuotaV1 {
    today_available_withdraw_BTC: string;
    min_withdraw: string;
    withdraw_precision: number;
    withdraw_fee: string;
}
export interface WithdrawAddressListItem {
    currency: string;
    network: string;
    address: string;
    memo: string;
    remark: string;
    addressType: number;
    verifyStatus: number;
}
export interface AccountDepositWithdrawHistoryV2 {
    withdraw_id: string;
    deposit_id: string;
    operation_type: 'deposit' | 'withdraw';
    currency: string;
    apply_time: number;
    arrival_amount: string;
    fee: string;
    status: number;
    address: string;
    address_memo: string;
    tx_id: string;
}
export interface MarginV1BaseQuote {
    currency: string;
    borrow_enabled: boolean;
    borrowed: string;
    borrow_unpaid: string;
    interest_unpaid: string;
    available: string;
    frozen: string;
    net_asset: string;
    net_assetBTC: string;
    total_asset: string;
}
export interface SymbolMarginAccountDetailsV1 {
    symbol: string;
    risk_rate: string;
    risk_level: string;
    buy_enabled: boolean;
    sell_enabled: boolean;
    liquidate_price: string;
    liquidate_rate: string;
    base: MarginV1BaseQuote;
    quote: MarginV1BaseQuote;
}
export interface BasicFeeRateV1 {
    user_rate_type: 0 | 1 | 2;
    level: string;
    taker_fee_rate_A: string;
    maker_fee_rate_A: string;
    taker_fee_rate_B: string;
    maker_fee_rate_B: string;
    taker_fee_rate_C: string;
    maker_fee_rate_C: string;
    taker_fee_rate_D: string;
    maker_fee_rate_D: string;
}
export interface ActualFeeRateV1 {
    symbol: string;
    buy_taker_fee_rate: string;
    sell_taker_fee_rate: string;
    buy_maker_fee_rate: string;
    sell_maker_fee_rate: string;
}
/**
 *
 * Spot/Margin Trading Endpoints
 *
 **/
/**
 * order_id is only present when successful
 */
export interface SubmittedSpotBatchOrderSuccessResponseV2 {
    code: 0;
    msg: string;
    data: {
        order_id: string;
    };
}
export interface SubmittedSpotBatchOrderFailureResponseV2 {
    code: number;
    msg: string;
}
export type SubmittedSpotBatchOrderResponseV2 = SubmittedSpotBatchOrderSuccessResponseV2 | SubmittedSpotBatchOrderFailureResponseV2;
export interface SpotTradeBase {
    orderId: string;
    clientOrderId: string;
    symbol: string;
    side: OrderSide;
    orderMode: string;
    type: string;
    price: string;
    size: string;
    notional: string;
    createTime: number;
    updateTime: number;
    cancelSource: string;
}
export interface SpotOrderV4 extends SpotTradeBase {
    state: string;
    priceAvg: string;
    filledSize: string;
    filledNotional: string;
    stpmode: 'none' | 'cancel_maker' | 'cancel_taker' | 'cancel_both';
}
export interface CancelSpotBatchOrdersV4Response {
    successIds: string[];
    failIds: string[];
    totalCount: number;
    successCount: number;
    failedCount: number;
}
export interface SpotAccountTradeV4 extends SpotTradeBase {
    tradeId: string;
    fee: string;
    feeCoinName: string;
    tradeRole: 'taker' | 'maker';
    orderMode: 'spot' | 'iso_margin';
    type: 'limit' | 'market' | 'limit_maker' | 'ioc';
    stpmode: 'none' | 'cancel_maker' | 'cancel_taker' | 'cancel_both';
}
/**
 *
 * Margin Loan Endpoints (History versions)
 *
 **/
export interface MarginBorrowRecordV1 {
    borrow_id: string;
    symbol: string;
    currency: string;
    borrow_amount: string;
    daily_interest: string;
    hourly_interest: string;
    interest_amount: string;
    create_time: number;
}
export interface MarginRepayRecordV1 {
    repay_id: string;
    repay_time: number;
    symbol: string;
    currency: string;
    repaid_amount: string;
    repaid_principal: string;
    repaid_interest: string;
}
export interface MarginBaseQuoteRow {
    currency: string;
    daily_interest: string;
    hourly_interest: string;
    max_borrow_amount: string;
    min_borrow_amount: string;
    borrowable_amount: string;
}
export interface MarginBorrowingRateV1 {
    symbol: string;
    max_leverage: string;
    symbol_enabled: boolean;
    base: MarginBaseQuoteRow;
    quote: MarginBaseQuoteRow;
}
export interface SubTransferRow {
    fromAccount: string;
    fromWalletType: 'spot';
    toAccount: string;
    toWalletType: 'spot';
    currency: string;
    amount: string;
    submissionTime: number;
}
export interface SubAccountV1 {
    accountName: string;
    status: number;
}
/**
 *
 * Broker
 *
 **/
export interface SpotBrokerRebateRow {
    currency: string;
    rebate_amount: string;
}
export interface SpotBrokerRebateResult {
    rebates: {
        [date: string]: SpotBrokerRebateRow[];
    };
}