kucoin-universal-sdk/dist/generate/futures/market/model_get_all_symbols_data.d.ts

Official KuCoin Universal SDK.

import { Serializable } from '../../../internal/interfaces/serializable';
export declare class GetAllSymbolsData implements Serializable {
    /**
     * Symbol
     */
    symbol: string;
    /**
     * Contract group
     */
    rootSymbol: string;
    /**
     * Type of contract
     */
    type: GetAllSymbolsData.TypeEnum;
    /**
     * First Open Date (milliseconds)
     */
    firstOpenDate: number;
    /**
     * Expiration date (milliseconds) Null means it will never expire
     */
    expireDate?: number;
    /**
     * Settlement date (milliseconds) Null indicates that automatic settlement is not supported
     */
    settleDate?: number;
    /**
     * Base currency
     */
    baseCurrency: string;
    /**
     * Quote currency
     */
    quoteCurrency: string;
    /**
     * Currency used to clear and settle the trades
     */
    settleCurrency: string;
    /**
     * Maximum order quantity
     */
    maxOrderQty: number;
    /**
     * Maximum order price
     */
    maxPrice: number;
    /**
     * Minimum lot size
     */
    lotSize: number;
    /**
     * Minimum price changes
     */
    tickSize: number;
    /**
     * Index price of tick size
     */
    indexPriceTickSize: number;
    /**
     * The basic unit of the contract API is lots. For the number of coins in each lot, please refer to the param multiplier. For example, for XBTUSDTM, multiplier=0.001, which corresponds to the value of each XBTUSDTM contract being 0.001 BTC. There is also a special case. All coin-swap contracts, such as each XBTUSDM contract, correspond to 1 USD.
     */
    multiplier: number;
    /**
     * Initial margin requirement
     */
    initialMargin: number;
    /**
     * Maintenance margin requirement
     */
    maintainMargin: number;
    /**
     * Maximum risk limit (unit: XBT)
     */
    maxRiskLimit: number;
    /**
     * Minimum risk limit (unit: XBT)
     */
    minRiskLimit: number;
    /**
     * Risk limit increment value (unit: XBT)
     */
    riskStep: number;
    /**
     * Maker fee rate
     */
    makerFeeRate: number;
    /**
     * Taker fee rate
     */
    takerFeeRate: number;
    /**
     * Deprecated param
     */
    takerFixFee: number;
    /**
     * Deprecated param
     */
    makerFixFee: number;
    /**
     * Settlement fee
     */
    settlementFee?: number;
    /**
     * Enabled ADL or not
     */
    isDeleverage: boolean;
    /**
     * Deprecated param
     */
    isQuanto: boolean;
    /**
     * Whether it is a reverse contract
     */
    isInverse: boolean;
    /**
     * Marking method
     */
    markMethod: GetAllSymbolsData.MarkMethodEnum;
    /**
     * Fair price marking method; the Futures contract is null
     */
    fairMethod?: GetAllSymbolsData.FairMethodEnum;
    /**
     * Ticker symbol of the base currency
     */
    fundingBaseSymbol?: string;
    /**
     * Ticker symbol of the quote currency
     */
    fundingQuoteSymbol?: string;
    /**
     * Funding rate symbol
     */
    fundingRateSymbol?: string;
    /**
     * Index symbol
     */
    indexSymbol: string;
    /**
     * Settlement symbol
     */
    settlementSymbol: string;
    /**
     * Contract status
     */
    status: GetAllSymbolsData.StatusEnum;
    /**
     * Funding fee rate
     */
    fundingFeeRate: number;
    /**
     * Predicted funding fee rate
     */
    predictedFundingFeeRate: number;
    /**
     * Funding interval (milliseconds)
     */
    fundingRateGranularity: number;
    /**
     * Open interest (unit: lots)
     */
    openInterest: string;
    /**
     * 24-hour turnover
     */
    turnoverOf24h: number;
    /**
     * 24-hour volume
     */
    volumeOf24h: number;
    /**
     * Mark price
     */
    markPrice: number;
    /**
     * Index price
     */
    indexPrice: number;
    /**
     * Last trade price
     */
    lastTradePrice: number;
    /**
     * Next funding rate time (milliseconds)
     */
    nextFundingRateTime: number;
    /**
     * Maximum leverage
     */
    maxLeverage: number;
    /**
     * The contract index price source exchange
     */
    sourceExchanges: Array<string>;
    /**
     * Premium index symbol (1 minute)
     */
    premiumsSymbol1M: string;
    /**
     * Premium index symbol (8 hours)
     */
    premiumsSymbol8H: string;
    /**
     * Base currency interest rate symbol (1 minute)
     */
    fundingBaseSymbol1M: string;
    /**
     * Quote currency interest rate symbol (1 minute)
     */
    fundingQuoteSymbol1M: string;
    /**
     * 24-hour lowest price
     */
    lowPrice: number;
    /**
     * 24-hour highest price
     */
    highPrice: number;
    /**
     * 24-hour % price change
     */
    priceChgPct: number;
    /**
     * 24-hour price change
     */
    priceChg: number;
    /**
     *
     */
    k: number;
    /**
     *
     */
    m: number;
    /**
     *
     */
    f: number;
    /**
     *
     */
    mmrLimit: number;
    /**
     *
     */
    mmrLevConstant: number;
    /**
     * Whether support Cross Margin
     */
    supportCross: boolean;
    /**
     * The current maximum buying price allowed
     */
    buyLimit: number;
    /**
     * The current minimum selling price allowed
     */
    sellLimit: number;
    /**
     * Private constructor, please use the corresponding static methods to construct the object.
     */
    private constructor();
    /**
     * Convert the object to a JSON string.
     */
    toJson(): string;
    /**
     * Create an object from a JSON string.
     */
    static fromJson(input: string): GetAllSymbolsData;
    /**
     * Create an object from Js Object.
     */
    static fromObject(jsonObject: Object): GetAllSymbolsData;
}
export declare namespace GetAllSymbolsData {
    enum TypeEnum {
        /**
         * Standardized swap contracts, standard financial futures on swaps, expiration swap funding rates
         */
        FFWCSX,
        /**
         * Futures Contract
         */
        FFICSX
    }
    enum MarkMethodEnum {
        /**
         * FairPrice
         */
        FAIRPRICE
    }
    enum FairMethodEnum {
        /**
         * FundingRate
         */
        FUNDINGRATE
    }
    enum StatusEnum {
        /**
         * Initial
         */
        INIT,
        /**
         * Online
         */
        OPEN,
        /**
         * Settling
         */
        BEINGSETTLED,
        /**
         * Settled
         */
        SETTLED,
        /**
         * Suspended
         */
        PAUSED,
        /**
         * Offline
         */
        CLOSED,
        /**
         * Orders can only be canceled
         */
        CANCELONLY
    }
}