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

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

export type FuturesMarginType = 'cross' | 'isolated';
export interface FuturesContractDetails {
    symbol: string;
    product_type: number;
    open_timestamp: number;
    expire_timestamp: number;
    settle_timestamp: number;
    base_currency: string;
    quote_currency: string;
    last_price: string;
    volume_24h: string;
    turnover_24h: string;
    index_price: string;
    index_name: string;
    contract_size: string;
    min_leverage: string;
    max_leverage: string;
    price_precision: string;
    vol_precision: string;
    max_volume: string;
    min_volume: string;
    funding_rate: string;
    expected_funding_rate: string;
    open_interest: string;
    open_interest_value: string;
    high_24h: string;
    low_24h: string;
    change_24h: string;
    market_max_volume: string;
    funding_interval_hours: number;
    delist_time: number;
    status: string;
}
export interface FuturesMarketTrade {
    symbol: string;
    price: string;
    qty: string;
    quote_qty: string;
    time: number;
    is_buyer_maker: boolean;
}
export interface FuturesContractDepth {
    timestamp: number;
    symbol: string;
    asks: [string, string, string][];
    bids: [string, string, string][];
}
export interface FuturesOpenInterest {
    timestamp: number;
    symbol: string;
    open_interest: string;
    open_interest_value: string;
}
export interface FuturesFundingRate {
    timestamp: number;
    symbol: string;
    rate_value: string;
    expected_rate: string;
}
export interface FuturesKline {
    timestamp: number;
    open_price: string;
    close_price: string;
    high_price: string;
    low_price: string;
    volume: string;
}
export interface FuturesFundingRateHistory {
    symbol: string;
    funding_rate: string;
    funding_time: string;
}
export interface FuturesLeverageBracket {
    bracket: number;
    initial_leverage: number;
    notional_cap: string;
    notional_floor: string;
    maint_margin_ratio: string;
    cum: string;
}
export interface FuturesLeverageBracketRule {
    symbol: string;
    brackets: FuturesLeverageBracket[];
}
export interface FuturesAccountAsset {
    currency: string;
    position_deposit: string;
    frozen_balance: string;
    available_balance: string;
    equity: string;
    unrealized: string;
}
export interface FuturesOrderBase {
    order_id: string;
    client_order_id: string;
    size: string;
    symbol: string;
    state: 1 | 2 | 4;
    side: 1 | 2 | 3 | 4;
    leverage: string;
    open_type: FuturesMarginType;
    create_time: number;
    update_time: number;
}
export interface FuturesAccountOrder extends FuturesOrderBase {
    price: string;
    type: 'limit' | 'market' | 'liquidate' | 'bankruptcy' | 'adl';
    deal_avg_price: string;
    deal_size: string;
    activation_price?: string;
    callback_rate?: string;
    activation_price_type?: 1 | 2;
    executive_order_id?: string;
    preset_take_profit_price_type?: 1 | 2;
    preset_stop_loss_price_type?: 1 | 2;
    preset_take_profit_price?: string;
    preset_stop_loss_price?: string;
    account: string;
    position_mode?: string;
}
export interface FuturesAccountHistoricOrder extends FuturesOrderBase {
    price: string;
    type: 'limit' | 'market' | 'liquidate' | 'bankruptcy' | 'adl' | 'trailing' | 'planorder';
    deal_avg_price: string;
    deal_size: string;
    activation_price?: string;
    callback_rate?: string;
    activation_price_type?: 1 | 2;
    executive_order_id?: string;
    account?: string;
    position_mode?: string;
}
export interface FuturesAccountOpenOrder extends FuturesOrderBase {
    price: string;
    type: 'limit' | 'market' | 'trailing';
    deal_avg_price: string;
    deal_size: string;
    activation_price?: string;
    callback_rate?: string;
    activation_price_type?: 1 | 2;
    position_mode: string;
}
export interface FuturesAccountPlanOrders extends FuturesOrderBase {
    executive_price: string;
    trigger_price: string;
    mode: number;
    price_way: number;
    price_type: number;
    plan_category: 1 | 2;
    type: 'plan' | 'take_profit' | 'stop_loss';
    position_mode: string;
}
export interface FuturesAccountPosition {
    timestamp: number;
    symbol: string;
    leverage: string;
    current_fee: string;
    open_timestamp: number;
    current_value: string;
    mark_price: string;
    position_value: string;
    position_cross: string;
    maintenance_margin: string;
    close_vol: string;
    close_avg_price: string;
    open_avg_price: string;
    entry_price: string;
    current_amount: string;
    unrealized_value: string;
    realized_value: string;
    position_type: 1 | 2;
    account: string;
    position_mode: string;
}
export interface FuturesAccountPositionV2 {
    symbol: string;
    leverage: string;
    timestamp: number;
    current_fee: string;
    open_timestamp: number;
    current_value: string;
    mark_price: string;
    position_value: string;
    position_cross: string;
    maintenance_margin: string;
    close_vol: string;
    close_avg_price: string;
    open_avg_price: string;
    entry_price: string;
    current_amount: string;
    position_amount: string;
    realized_value: string;
    mark_value: string;
    account: string;
    open_type: string;
    position_side: string;
    unrealized_pnl: string;
    liquidation_price: string;
    max_notional_value: string;
    initial_margin: string;
}
export interface PositionRisk {
    symbol: string;
    position_amt: string;
    mark_price: string;
    unrealized_profit: string;
    liquidation_price: string;
    leverage: string;
    max_notional_value: string;
    margin_type: 'Cross' | 'Isolated';
    isolated_margin: string;
    position_side: 'Long' | 'Short';
    notional: string;
    update_time: number;
    account: string;
}
export interface FuturesAccountTrade {
    order_id: string;
    trade_id: string;
    symbol: string;
    side: 1 | 2 | 3 | 4;
    price: string;
    vol: string;
    exec_type: 'Taker' | 'Maker';
    profit: boolean;
    realised_profit: string;
    paid_fees: string;
    create_time: number;
    account: string;
}
export interface FuturesAccountHistoricTransaction {
    symbol: string;
    type: string;
    amount: string;
    asset: string;
    time: string;
    tran_id: string;
    account: string;
}
export interface FuturesAccountTransfer {
    transfer_id: string;
    currency: string;
    amount: string;
    type: 'spot_to_contract' | 'contract_to_spot';
    state: 'PROCESSING' | 'FINISHED' | 'FAILED';
    timestamp: number;
}
export interface FuturesOrderSubmitResult {
    order_id: number;
    price: string;
}
export interface FuturesTransferSubmitResult {
    currency: string;
    amount: string;
}
export interface FuturesAccountSetLeverageResult {
    symbol: string;
    leverage: string;
    open_type: FuturesMarginType;
    max_value: string;
}
export interface FuturesAccountSubTransfer {
    fromAccount: string;
    toAccount: string;
    toWalletType: 'future';
    fromWalletType: 'future';
    currency: string;
    amount: string;
    submissionTime: number;
}
/** Row from GET `contract/private/affiliate/rebate-inviteUser` (invite customer list). */
export interface FuturesAffiliateRebateInviteUserRow {
    rebateTotal: string;
    tradingVolTotal: string;
    cashbackRate: string;
    tradingFeeTotal: string;
    backRate: string;
    cid: number;
    status: number;
    accountAssetTotal: string;
}
/** `data` payload for GET `contract/private/affiliate/rebate-inviteUser`. */
export interface FuturesAffiliateRebateInviteUserResponse {
    list: FuturesAffiliateRebateInviteUserRow[];
    page: number;
    size: number;
    total: number;
}
/** `data` payload for GET `contract/private/affiliate/rebate-user` (single user). */
export interface FuturesAffiliateRebateUserResponse {
    cid: number;
    back_rate: string;
    trading_vol_total: string;
    trading_fee_total: string;
    rebate_total: string;
    trading_vol: string;
    trading_fee: string;
    rebate: string;
}
export interface FuturesAffiliateDepositWithdrawalListItem {
    dateTime: number;
    cid: number;
    remark: string;
    parentCid: number;
    userType: number;
    type: number;
    method: number;
    amount: string;
    coin: string;
}
export interface FuturesAffiliateDepositWithdrawalListResult {
    total: number;
    size: number;
    page: number;
    list: FuturesAffiliateDepositWithdrawalListItem[];
}
export interface FuturesAutoRepaymentRecord {
    to_coin_code: string;
    to_amount: string;
    from_coin_code: string;
    from_amount: string;
    time: string;
    type: string;
    liquidation_fee: string;
}
export interface FuturesAutoRepaymentApiResponse {
    errno: string;
    message: string;
    data: {
        list: FuturesAutoRepaymentRecord[];
        total: number;
    };
    success: boolean;
}
export interface FuturesCrossCollateralInterestLogItem {
    id: number;
    account_id: number;
    coin_code: string;
    rate: string;
    interest: string;
    liability: string;
    interest_time: number;
    created_at: string;
    updated_at: string;
    interest_free_amount: string;
}
export interface FuturesCrossCollateralInterestLogApiResponse {
    errno: string;
    message: string;
    data: {
        items: FuturesCrossCollateralInterestLogItem[];
        total: number;
    };
    success: boolean;
}
export interface FuturesAffiliateRebateApiResponse {
    api_trading_fee_total: string;
    api_rebate_total: string;
}
export interface FuturesSimulatedClaimResponse {
    currency: string;
    amount: string;
}