binance-futures-wrapper
Version:
A comprehensive TypeScript wrapper for Binance USDT-M Futures API with full REST and WebSocket support
809 lines • 25.5 kB
TypeScript
/**
* REST API endpoints configuration for Binance Futures
*/
import { RequestOptions } from '../types';
export interface EndpointConfig extends Omit<RequestOptions, 'params'> {
path: string;
version?: string;
}
export declare const MARKET_ENDPOINTS: {
readonly PING: {
readonly method: "GET";
readonly path: "/fapi/v1/ping";
readonly endpoint: "ping";
readonly signed: false;
readonly weight: 1;
};
readonly TIME: {
readonly method: "GET";
readonly path: "/fapi/v1/time";
readonly endpoint: "time";
readonly signed: false;
readonly weight: 1;
};
readonly EXCHANGE_INFO: {
readonly method: "GET";
readonly path: "/fapi/v1/exchangeInfo";
readonly endpoint: "exchangeInfo";
readonly signed: false;
readonly weight: 1;
};
readonly ORDER_BOOK: {
readonly method: "GET";
readonly path: "/fapi/v1/depth";
readonly endpoint: "depth";
readonly signed: false;
readonly weight: 5;
};
readonly TRADES: {
readonly method: "GET";
readonly path: "/fapi/v1/trades";
readonly endpoint: "trades";
readonly signed: false;
readonly weight: 1;
};
readonly HISTORICAL_TRADES: {
readonly method: "GET";
readonly path: "/fapi/v1/historicalTrades";
readonly endpoint: "historicalTrades";
readonly signed: false;
readonly weight: 5;
};
readonly AGG_TRADES: {
readonly method: "GET";
readonly path: "/fapi/v1/aggTrades";
readonly endpoint: "aggTrades";
readonly signed: false;
readonly weight: 1;
};
readonly KLINES: {
readonly method: "GET";
readonly path: "/fapi/v1/klines";
readonly endpoint: "klines";
readonly signed: false;
readonly weight: 1;
};
readonly CONTINUOUS_KLINES: {
readonly method: "GET";
readonly path: "/fapi/v1/continuousKlines";
readonly endpoint: "continuousKlines";
readonly signed: false;
readonly weight: 1;
};
readonly INDEX_PRICE_KLINES: {
readonly method: "GET";
readonly path: "/fapi/v1/indexPriceKlines";
readonly endpoint: "indexPriceKlines";
readonly signed: false;
readonly weight: 1;
};
readonly MARK_PRICE_KLINES: {
readonly method: "GET";
readonly path: "/fapi/v1/markPriceKlines";
readonly endpoint: "markPriceKlines";
readonly signed: false;
readonly weight: 1;
};
readonly MARK_PRICE: {
readonly method: "GET";
readonly path: "/fapi/v1/premiumIndex";
readonly endpoint: "premiumIndex";
readonly signed: false;
readonly weight: 1;
};
readonly FUNDING_RATE: {
readonly method: "GET";
readonly path: "/fapi/v1/fundingRate";
readonly endpoint: "fundingRate";
readonly signed: false;
readonly weight: 1;
};
readonly TICKER_24HR: {
readonly method: "GET";
readonly path: "/fapi/v1/ticker/24hr";
readonly endpoint: "ticker/24hr";
readonly signed: false;
readonly weight: 1;
};
readonly TICKER_PRICE: {
readonly method: "GET";
readonly path: "/fapi/v1/ticker/price";
readonly endpoint: "ticker/price";
readonly signed: false;
readonly weight: 1;
};
readonly TICKER_BOOK: {
readonly method: "GET";
readonly path: "/fapi/v1/ticker/bookTicker";
readonly endpoint: "ticker/bookTicker";
readonly signed: false;
readonly weight: 1;
};
readonly OPEN_INTEREST: {
readonly method: "GET";
readonly path: "/fapi/v1/openInterest";
readonly endpoint: "openInterest";
readonly signed: false;
readonly weight: 1;
};
readonly OPEN_INTEREST_STATISTICS: {
readonly method: "GET";
readonly path: "/futures/data/openInterestHist";
readonly endpoint: "openInterestHist";
readonly signed: false;
readonly weight: 1;
};
readonly TOP_LONG_SHORT_ACCOUNT_RATIO: {
readonly method: "GET";
readonly path: "/futures/data/topLongShortAccountRatio";
readonly endpoint: "topLongShortAccountRatio";
readonly signed: false;
readonly weight: 1;
};
readonly TOP_LONG_SHORT_POSITION_RATIO: {
readonly method: "GET";
readonly path: "/futures/data/topLongShortPositionRatio";
readonly endpoint: "topLongShortPositionRatio";
readonly signed: false;
readonly weight: 1;
};
readonly GLOBAL_LONG_SHORT_ACCOUNT_RATIO: {
readonly method: "GET";
readonly path: "/futures/data/globalLongShortAccountRatio";
readonly endpoint: "globalLongShortAccountRatio";
readonly signed: false;
readonly weight: 1;
};
readonly TAKER_LONG_SHORT_RATIO: {
readonly method: "GET";
readonly path: "/futures/data/takerlongshortRatio";
readonly endpoint: "takerlongshortRatio";
readonly signed: false;
readonly weight: 1;
};
readonly BLVT_NAV_KLINES: {
readonly method: "GET";
readonly path: "/fapi/v1/lvtKlines";
readonly endpoint: "lvtKlines";
readonly signed: false;
readonly weight: 1;
};
readonly COMPOSITE_INDEX: {
readonly method: "GET";
readonly path: "/fapi/v1/indexInfo";
readonly endpoint: "indexInfo";
readonly signed: false;
readonly weight: 1;
};
readonly MULTI_ASSETS_MODE: {
readonly method: "GET";
readonly path: "/fapi/v1/assetIndex";
readonly endpoint: "assetIndex";
readonly signed: false;
readonly weight: 1;
};
};
export declare const ACCOUNT_ENDPOINTS: {
readonly POSITION_MODE: {
readonly method: "POST";
readonly path: "/fapi/v1/positionSide/dual";
readonly endpoint: "positionSide/dual";
readonly signed: true;
readonly weight: 1;
};
readonly GET_POSITION_MODE: {
readonly method: "GET";
readonly path: "/fapi/v1/positionSide/dual";
readonly endpoint: "positionSide/dual";
readonly signed: true;
readonly weight: 30;
};
readonly MULTI_ASSETS_MODE: {
readonly method: "POST";
readonly path: "/fapi/v1/multiAssetsMargin";
readonly endpoint: "multiAssetsMargin";
readonly signed: true;
readonly weight: 1;
};
readonly GET_MULTI_ASSETS_MODE: {
readonly method: "GET";
readonly path: "/fapi/v1/multiAssetsMargin";
readonly endpoint: "multiAssetsMargin";
readonly signed: true;
readonly weight: 30;
};
readonly ORDER: {
readonly method: "POST";
readonly path: "/fapi/v1/order";
readonly endpoint: "order";
readonly signed: true;
readonly weight: 1;
};
readonly MODIFY_ORDER: {
readonly method: "PUT";
readonly path: "/fapi/v1/order";
readonly endpoint: "order";
readonly signed: true;
readonly weight: 1;
};
readonly BATCH_ORDERS: {
readonly method: "POST";
readonly path: "/fapi/v1/batchOrders";
readonly endpoint: "batchOrders";
readonly signed: true;
readonly weight: 5;
};
readonly MODIFY_BATCH_ORDERS: {
readonly method: "PUT";
readonly path: "/fapi/v1/batchOrders";
readonly endpoint: "batchOrders";
readonly signed: true;
readonly weight: 5;
};
readonly GET_ORDER: {
readonly method: "GET";
readonly path: "/fapi/v1/order";
readonly endpoint: "order";
readonly signed: true;
readonly weight: 1;
};
readonly CANCEL_ORDER: {
readonly method: "DELETE";
readonly path: "/fapi/v1/order";
readonly endpoint: "order";
readonly signed: true;
readonly weight: 1;
};
readonly CANCEL_ALL_ORDERS: {
readonly method: "DELETE";
readonly path: "/fapi/v1/allOpenOrders";
readonly endpoint: "allOpenOrders";
readonly signed: true;
readonly weight: 1;
};
readonly CANCEL_BATCH_ORDERS: {
readonly method: "DELETE";
readonly path: "/fapi/v1/batchOrders";
readonly endpoint: "batchOrders";
readonly signed: true;
readonly weight: 1;
};
readonly AUTO_CANCEL_ALL_ORDERS: {
readonly method: "POST";
readonly path: "/fapi/v1/countdownCancelAll";
readonly endpoint: "countdownCancelAll";
readonly signed: true;
readonly weight: 10;
};
readonly GET_OPEN_ORDER: {
readonly method: "GET";
readonly path: "/fapi/v1/openOrder";
readonly endpoint: "openOrder";
readonly signed: true;
readonly weight: 1;
};
readonly GET_OPEN_ORDERS: {
readonly method: "GET";
readonly path: "/fapi/v1/openOrders";
readonly endpoint: "openOrders";
readonly signed: true;
readonly weight: 1;
};
readonly GET_ALL_ORDERS: {
readonly method: "GET";
readonly path: "/fapi/v1/allOrders";
readonly endpoint: "allOrders";
readonly signed: true;
readonly weight: 5;
};
readonly BALANCE: {
readonly method: "GET";
readonly path: "/fapi/v2/balance";
readonly endpoint: "balance";
readonly signed: true;
readonly weight: 1;
};
readonly ACCOUNT: {
readonly method: "GET";
readonly path: "/fapi/v2/account";
readonly endpoint: "account";
readonly signed: true;
readonly weight: 5;
};
readonly LEVERAGE: {
readonly method: "POST";
readonly path: "/fapi/v1/leverage";
readonly endpoint: "leverage";
readonly signed: true;
readonly weight: 1;
};
readonly MARGIN_TYPE: {
readonly method: "POST";
readonly path: "/fapi/v1/marginType";
readonly endpoint: "marginType";
readonly signed: true;
readonly weight: 1;
};
readonly POSITION_MARGIN: {
readonly method: "POST";
readonly path: "/fapi/v1/positionMargin";
readonly endpoint: "positionMargin";
readonly signed: true;
readonly weight: 1;
};
readonly POSITION_MARGIN_HISTORY: {
readonly method: "GET";
readonly path: "/fapi/v1/positionMargin/history";
readonly endpoint: "positionMargin/history";
readonly signed: true;
readonly weight: 1;
};
readonly POSITION_RISK: {
readonly method: "GET";
readonly path: "/fapi/v2/positionRisk";
readonly endpoint: "positionRisk";
readonly signed: true;
readonly weight: 5;
};
readonly USER_TRADES: {
readonly method: "GET";
readonly path: "/fapi/v1/userTrades";
readonly endpoint: "userTrades";
readonly signed: true;
readonly weight: 5;
};
readonly INCOME: {
readonly method: "GET";
readonly path: "/fapi/v1/income";
readonly endpoint: "income";
readonly signed: true;
readonly weight: 30;
};
readonly LEVERAGE_BRACKET: {
readonly method: "GET";
readonly path: "/fapi/v1/leverageBracket";
readonly endpoint: "leverageBracket";
readonly signed: true;
readonly weight: 1;
};
readonly ADL_QUANTILE: {
readonly method: "GET";
readonly path: "/fapi/v1/adlQuantile";
readonly endpoint: "adlQuantile";
readonly signed: true;
readonly weight: 5;
};
readonly FORCE_ORDERS: {
readonly method: "GET";
readonly path: "/fapi/v1/forceOrders";
readonly endpoint: "forceOrders";
readonly signed: true;
readonly weight: 1;
};
readonly API_TRADING_STATUS: {
readonly method: "GET";
readonly path: "/fapi/v1/apiTradingStatus";
readonly endpoint: "apiTradingStatus";
readonly signed: true;
readonly weight: 1;
};
};
export declare const USER_STREAM_ENDPOINTS: {
readonly USER_STREAM_START: {
readonly method: "POST";
readonly path: "/fapi/v1/listenKey";
readonly endpoint: "listenKey";
readonly signed: false;
readonly weight: 1;
};
readonly USER_STREAM_KEEPALIVE: {
readonly method: "PUT";
readonly path: "/fapi/v1/listenKey";
readonly endpoint: "listenKey";
readonly signed: false;
readonly weight: 1;
};
readonly USER_STREAM_CLOSE: {
readonly method: "DELETE";
readonly path: "/fapi/v1/listenKey";
readonly endpoint: "listenKey";
readonly signed: false;
readonly weight: 1;
};
};
export declare const ENDPOINTS: {
readonly USER_STREAM_START: {
readonly method: "POST";
readonly path: "/fapi/v1/listenKey";
readonly endpoint: "listenKey";
readonly signed: false;
readonly weight: 1;
};
readonly USER_STREAM_KEEPALIVE: {
readonly method: "PUT";
readonly path: "/fapi/v1/listenKey";
readonly endpoint: "listenKey";
readonly signed: false;
readonly weight: 1;
};
readonly USER_STREAM_CLOSE: {
readonly method: "DELETE";
readonly path: "/fapi/v1/listenKey";
readonly endpoint: "listenKey";
readonly signed: false;
readonly weight: 1;
};
readonly POSITION_MODE: {
readonly method: "POST";
readonly path: "/fapi/v1/positionSide/dual";
readonly endpoint: "positionSide/dual";
readonly signed: true;
readonly weight: 1;
};
readonly GET_POSITION_MODE: {
readonly method: "GET";
readonly path: "/fapi/v1/positionSide/dual";
readonly endpoint: "positionSide/dual";
readonly signed: true;
readonly weight: 30;
};
readonly MULTI_ASSETS_MODE: {
readonly method: "POST";
readonly path: "/fapi/v1/multiAssetsMargin";
readonly endpoint: "multiAssetsMargin";
readonly signed: true;
readonly weight: 1;
};
readonly GET_MULTI_ASSETS_MODE: {
readonly method: "GET";
readonly path: "/fapi/v1/multiAssetsMargin";
readonly endpoint: "multiAssetsMargin";
readonly signed: true;
readonly weight: 30;
};
readonly ORDER: {
readonly method: "POST";
readonly path: "/fapi/v1/order";
readonly endpoint: "order";
readonly signed: true;
readonly weight: 1;
};
readonly MODIFY_ORDER: {
readonly method: "PUT";
readonly path: "/fapi/v1/order";
readonly endpoint: "order";
readonly signed: true;
readonly weight: 1;
};
readonly BATCH_ORDERS: {
readonly method: "POST";
readonly path: "/fapi/v1/batchOrders";
readonly endpoint: "batchOrders";
readonly signed: true;
readonly weight: 5;
};
readonly MODIFY_BATCH_ORDERS: {
readonly method: "PUT";
readonly path: "/fapi/v1/batchOrders";
readonly endpoint: "batchOrders";
readonly signed: true;
readonly weight: 5;
};
readonly GET_ORDER: {
readonly method: "GET";
readonly path: "/fapi/v1/order";
readonly endpoint: "order";
readonly signed: true;
readonly weight: 1;
};
readonly CANCEL_ORDER: {
readonly method: "DELETE";
readonly path: "/fapi/v1/order";
readonly endpoint: "order";
readonly signed: true;
readonly weight: 1;
};
readonly CANCEL_ALL_ORDERS: {
readonly method: "DELETE";
readonly path: "/fapi/v1/allOpenOrders";
readonly endpoint: "allOpenOrders";
readonly signed: true;
readonly weight: 1;
};
readonly CANCEL_BATCH_ORDERS: {
readonly method: "DELETE";
readonly path: "/fapi/v1/batchOrders";
readonly endpoint: "batchOrders";
readonly signed: true;
readonly weight: 1;
};
readonly AUTO_CANCEL_ALL_ORDERS: {
readonly method: "POST";
readonly path: "/fapi/v1/countdownCancelAll";
readonly endpoint: "countdownCancelAll";
readonly signed: true;
readonly weight: 10;
};
readonly GET_OPEN_ORDER: {
readonly method: "GET";
readonly path: "/fapi/v1/openOrder";
readonly endpoint: "openOrder";
readonly signed: true;
readonly weight: 1;
};
readonly GET_OPEN_ORDERS: {
readonly method: "GET";
readonly path: "/fapi/v1/openOrders";
readonly endpoint: "openOrders";
readonly signed: true;
readonly weight: 1;
};
readonly GET_ALL_ORDERS: {
readonly method: "GET";
readonly path: "/fapi/v1/allOrders";
readonly endpoint: "allOrders";
readonly signed: true;
readonly weight: 5;
};
readonly BALANCE: {
readonly method: "GET";
readonly path: "/fapi/v2/balance";
readonly endpoint: "balance";
readonly signed: true;
readonly weight: 1;
};
readonly ACCOUNT: {
readonly method: "GET";
readonly path: "/fapi/v2/account";
readonly endpoint: "account";
readonly signed: true;
readonly weight: 5;
};
readonly LEVERAGE: {
readonly method: "POST";
readonly path: "/fapi/v1/leverage";
readonly endpoint: "leverage";
readonly signed: true;
readonly weight: 1;
};
readonly MARGIN_TYPE: {
readonly method: "POST";
readonly path: "/fapi/v1/marginType";
readonly endpoint: "marginType";
readonly signed: true;
readonly weight: 1;
};
readonly POSITION_MARGIN: {
readonly method: "POST";
readonly path: "/fapi/v1/positionMargin";
readonly endpoint: "positionMargin";
readonly signed: true;
readonly weight: 1;
};
readonly POSITION_MARGIN_HISTORY: {
readonly method: "GET";
readonly path: "/fapi/v1/positionMargin/history";
readonly endpoint: "positionMargin/history";
readonly signed: true;
readonly weight: 1;
};
readonly POSITION_RISK: {
readonly method: "GET";
readonly path: "/fapi/v2/positionRisk";
readonly endpoint: "positionRisk";
readonly signed: true;
readonly weight: 5;
};
readonly USER_TRADES: {
readonly method: "GET";
readonly path: "/fapi/v1/userTrades";
readonly endpoint: "userTrades";
readonly signed: true;
readonly weight: 5;
};
readonly INCOME: {
readonly method: "GET";
readonly path: "/fapi/v1/income";
readonly endpoint: "income";
readonly signed: true;
readonly weight: 30;
};
readonly LEVERAGE_BRACKET: {
readonly method: "GET";
readonly path: "/fapi/v1/leverageBracket";
readonly endpoint: "leverageBracket";
readonly signed: true;
readonly weight: 1;
};
readonly ADL_QUANTILE: {
readonly method: "GET";
readonly path: "/fapi/v1/adlQuantile";
readonly endpoint: "adlQuantile";
readonly signed: true;
readonly weight: 5;
};
readonly FORCE_ORDERS: {
readonly method: "GET";
readonly path: "/fapi/v1/forceOrders";
readonly endpoint: "forceOrders";
readonly signed: true;
readonly weight: 1;
};
readonly API_TRADING_STATUS: {
readonly method: "GET";
readonly path: "/fapi/v1/apiTradingStatus";
readonly endpoint: "apiTradingStatus";
readonly signed: true;
readonly weight: 1;
};
readonly PING: {
readonly method: "GET";
readonly path: "/fapi/v1/ping";
readonly endpoint: "ping";
readonly signed: false;
readonly weight: 1;
};
readonly TIME: {
readonly method: "GET";
readonly path: "/fapi/v1/time";
readonly endpoint: "time";
readonly signed: false;
readonly weight: 1;
};
readonly EXCHANGE_INFO: {
readonly method: "GET";
readonly path: "/fapi/v1/exchangeInfo";
readonly endpoint: "exchangeInfo";
readonly signed: false;
readonly weight: 1;
};
readonly ORDER_BOOK: {
readonly method: "GET";
readonly path: "/fapi/v1/depth";
readonly endpoint: "depth";
readonly signed: false;
readonly weight: 5;
};
readonly TRADES: {
readonly method: "GET";
readonly path: "/fapi/v1/trades";
readonly endpoint: "trades";
readonly signed: false;
readonly weight: 1;
};
readonly HISTORICAL_TRADES: {
readonly method: "GET";
readonly path: "/fapi/v1/historicalTrades";
readonly endpoint: "historicalTrades";
readonly signed: false;
readonly weight: 5;
};
readonly AGG_TRADES: {
readonly method: "GET";
readonly path: "/fapi/v1/aggTrades";
readonly endpoint: "aggTrades";
readonly signed: false;
readonly weight: 1;
};
readonly KLINES: {
readonly method: "GET";
readonly path: "/fapi/v1/klines";
readonly endpoint: "klines";
readonly signed: false;
readonly weight: 1;
};
readonly CONTINUOUS_KLINES: {
readonly method: "GET";
readonly path: "/fapi/v1/continuousKlines";
readonly endpoint: "continuousKlines";
readonly signed: false;
readonly weight: 1;
};
readonly INDEX_PRICE_KLINES: {
readonly method: "GET";
readonly path: "/fapi/v1/indexPriceKlines";
readonly endpoint: "indexPriceKlines";
readonly signed: false;
readonly weight: 1;
};
readonly MARK_PRICE_KLINES: {
readonly method: "GET";
readonly path: "/fapi/v1/markPriceKlines";
readonly endpoint: "markPriceKlines";
readonly signed: false;
readonly weight: 1;
};
readonly MARK_PRICE: {
readonly method: "GET";
readonly path: "/fapi/v1/premiumIndex";
readonly endpoint: "premiumIndex";
readonly signed: false;
readonly weight: 1;
};
readonly FUNDING_RATE: {
readonly method: "GET";
readonly path: "/fapi/v1/fundingRate";
readonly endpoint: "fundingRate";
readonly signed: false;
readonly weight: 1;
};
readonly TICKER_24HR: {
readonly method: "GET";
readonly path: "/fapi/v1/ticker/24hr";
readonly endpoint: "ticker/24hr";
readonly signed: false;
readonly weight: 1;
};
readonly TICKER_PRICE: {
readonly method: "GET";
readonly path: "/fapi/v1/ticker/price";
readonly endpoint: "ticker/price";
readonly signed: false;
readonly weight: 1;
};
readonly TICKER_BOOK: {
readonly method: "GET";
readonly path: "/fapi/v1/ticker/bookTicker";
readonly endpoint: "ticker/bookTicker";
readonly signed: false;
readonly weight: 1;
};
readonly OPEN_INTEREST: {
readonly method: "GET";
readonly path: "/fapi/v1/openInterest";
readonly endpoint: "openInterest";
readonly signed: false;
readonly weight: 1;
};
readonly OPEN_INTEREST_STATISTICS: {
readonly method: "GET";
readonly path: "/futures/data/openInterestHist";
readonly endpoint: "openInterestHist";
readonly signed: false;
readonly weight: 1;
};
readonly TOP_LONG_SHORT_ACCOUNT_RATIO: {
readonly method: "GET";
readonly path: "/futures/data/topLongShortAccountRatio";
readonly endpoint: "topLongShortAccountRatio";
readonly signed: false;
readonly weight: 1;
};
readonly TOP_LONG_SHORT_POSITION_RATIO: {
readonly method: "GET";
readonly path: "/futures/data/topLongShortPositionRatio";
readonly endpoint: "topLongShortPositionRatio";
readonly signed: false;
readonly weight: 1;
};
readonly GLOBAL_LONG_SHORT_ACCOUNT_RATIO: {
readonly method: "GET";
readonly path: "/futures/data/globalLongShortAccountRatio";
readonly endpoint: "globalLongShortAccountRatio";
readonly signed: false;
readonly weight: 1;
};
readonly TAKER_LONG_SHORT_RATIO: {
readonly method: "GET";
readonly path: "/futures/data/takerlongshortRatio";
readonly endpoint: "takerlongshortRatio";
readonly signed: false;
readonly weight: 1;
};
readonly BLVT_NAV_KLINES: {
readonly method: "GET";
readonly path: "/fapi/v1/lvtKlines";
readonly endpoint: "lvtKlines";
readonly signed: false;
readonly weight: 1;
};
readonly COMPOSITE_INDEX: {
readonly method: "GET";
readonly path: "/fapi/v1/indexInfo";
readonly endpoint: "indexInfo";
readonly signed: false;
readonly weight: 1;
};
};
export type EndpointKey = keyof typeof ENDPOINTS;
//# sourceMappingURL=endpoints.d.ts.map