README.md

Rust API client for openapi

OpenAPI specification for Binance exchange - Umfutures API

Overview

This package is automatically generated by the OpenAPI Generator project.

Please do not edit the generated code manually, but rather regenerate it from OpenXAPI.

• API version: 0.3.0
• Package version: 0.3.0

Installation

Install the package using cargo:

cargo add openxapi-binance

Or add the following to your Cargo.toml:

openxapi-binance = { git = "https://github.com/openxapi/binance-rs" }

Documentation for API Endpoints

All URIs are relative to https://fapi.binance.com

Class	Method	HTTP request	Description
BinanceLinkApi	create_api_referral_customization_v1	POST /fapi/v1/apiReferral/customization	Customize Id For Client (USER DATA)(For Partner)
BinanceLinkApi	create_api_referral_user_customization_papiv1	POST /papi/v1/apiReferral/userCustomization	Customize Id For Client (USER DATA)(For client)(PAPI)
BinanceLinkApi	create_api_referral_user_customization_v1	POST /fapi/v1/apiReferral/userCustomization	Customize Id For Client (USER DATA)(For client)
BinanceLinkApi	get_api_referral_customization_v1	GET /fapi/v1/apiReferral/customization	Get Client Email Customized Id (USER DATA)
BinanceLinkApi	get_api_referral_if_new_user_papiv1	GET /papi/v1/apiReferral/ifNewUser	Query Client If The New User (USER DATA)(PAPI)
BinanceLinkApi	get_api_referral_if_new_user_v1	GET /fapi/v1/apiReferral/ifNewUser	Query Client If The New User (USER DATA)
BinanceLinkApi	get_api_referral_overview_v1	GET /fapi/v1/apiReferral/overview	Get Rebate Data Overview (USER DATA)
BinanceLinkApi	get_api_referral_rebate_vol_v1	GET /fapi/v1/apiReferral/rebateVol	Get Rebate Volume (USER DATA)
BinanceLinkApi	get_api_referral_trade_vol_v1	GET /fapi/v1/apiReferral/tradeVol	Get User Trade Volume (USER DATA)
BinanceLinkApi	get_api_referral_trader_num_v1	GET /fapi/v1/apiReferral/traderNum	Get Trader Number (USER DATA)
BinanceLinkApi	get_api_referral_trader_summary_v1	GET /fapi/v1/apiReferral/traderSummary	Get Trader Detail (USER DATA)
BinanceLinkApi	get_api_referral_user_customization_papiv1	GET /papi/v1/apiReferral/userCustomization	Get User’s Customize Id (USER DATA)(PAPI)
BinanceLinkApi	get_api_referral_user_customization_v1	GET /fapi/v1/apiReferral/userCustomization	Get User’s Customize Id (USER DATA)
BinanceLinkApi	get_income_v1	GET /fapi/v1/income	Get Income History(USER DATA)
FuturesApi	create_batch_orders_v1	POST /fapi/v1/batchOrders	Place Multiple Orders(TRADE)
FuturesApi	create_convert_accept_quote_v1	POST /fapi/v1/convert/acceptQuote	Accept the offered quote (USER_DATA)
FuturesApi	create_convert_get_quote_v1	POST /fapi/v1/convert/getQuote	Send Quote Request(USER_DATA)
FuturesApi	create_countdown_cancel_all_v1	POST /fapi/v1/countdownCancelAll	Auto-Cancel All Open Orders (TRADE)
FuturesApi	create_fee_burn_v1	POST /fapi/v1/feeBurn	Toggle BNB Burn On Futures Trade (TRADE)
FuturesApi	create_leverage_v1	POST /fapi/v1/leverage	Change Initial Leverage(TRADE)
FuturesApi	create_listen_key_v1	POST /fapi/v1/listenKey	Start User Data Stream (USER_STREAM)
FuturesApi	create_margin_type_v1	POST /fapi/v1/marginType	Change Margin Type(TRADE)
FuturesApi	create_multi_assets_margin_v1	POST /fapi/v1/multiAssetsMargin	Change Multi-Assets Mode (TRADE)
FuturesApi	create_order_test_v1	POST /fapi/v1/order/test	Test Order(TRADE)
FuturesApi	create_order_v1	POST /fapi/v1/order	New Order(TRADE)
FuturesApi	create_position_margin_v1	POST /fapi/v1/positionMargin	Modify Isolated Position Margin(TRADE)
FuturesApi	create_position_side_dual_v1	POST /fapi/v1/positionSide/dual	Change Position Mode(TRADE)
FuturesApi	delete_all_open_orders_v1	DELETE /fapi/v1/allOpenOrders	Cancel All Open Orders (TRADE)
FuturesApi	delete_batch_orders_v1	DELETE /fapi/v1/batchOrders	Cancel Multiple Orders (TRADE)
FuturesApi	delete_listen_key_v1	DELETE /fapi/v1/listenKey	Close User Data Stream (USER_STREAM)
FuturesApi	delete_order_v1	DELETE /fapi/v1/order	Cancel Order (TRADE)
FuturesApi	get_account_config_v1	GET /fapi/v1/accountConfig	Futures Account Configuration(USER_DATA)
FuturesApi	get_account_v2	GET /fapi/v2/account	Account Information V2(USER_DATA)
FuturesApi	get_account_v3	GET /fapi/v3/account	Account Information V3(USER_DATA)
FuturesApi	get_adl_quantile_v1	GET /fapi/v1/adlQuantile	Position ADL Quantile Estimation(USER_DATA)
FuturesApi	get_agg_trades_v1	GET /fapi/v1/aggTrades	Compressed/Aggregate Trades List
FuturesApi	get_all_orders_v1	GET /fapi/v1/allOrders	All Orders (USER_DATA)
FuturesApi	get_api_trading_status_v1	GET /fapi/v1/apiTradingStatus	Futures Trading Quantitative Rules Indicators (USER_DATA)
FuturesApi	get_asset_index_v1	GET /fapi/v1/assetIndex	Multi-Assets Mode Asset Index
FuturesApi	get_balance_v2	GET /fapi/v2/balance	Futures Account Balance V2 (USER_DATA)
FuturesApi	get_balance_v3	GET /fapi/v3/balance	Futures Account Balance V3 (USER_DATA)
FuturesApi	get_commission_rate_v1	GET /fapi/v1/commissionRate	User Commission Rate (USER_DATA)
FuturesApi	get_constituents_v1	GET /fapi/v1/constituents	Query Index Price Constituents
FuturesApi	get_continuous_klines_v1	GET /fapi/v1/continuousKlines	Continuous Contract Kline/Candlestick Data
FuturesApi	get_convert_exchange_info_v1	GET /fapi/v1/convert/exchangeInfo	List All Convert Pairs
FuturesApi	get_convert_order_status_v1	GET /fapi/v1/convert/orderStatus	Order status(USER_DATA)
FuturesApi	get_depth_v1	GET /fapi/v1/depth	Order Book
FuturesApi	get_exchange_info_v1	GET /fapi/v1/exchangeInfo	Exchange Information
FuturesApi	get_fee_burn_v1	GET /fapi/v1/feeBurn	Get BNB Burn Status (USER_DATA)
FuturesApi	get_force_orders_v1	GET /fapi/v1/forceOrders	User's Force Orders (USER_DATA)
FuturesApi	get_funding_info_v1	GET /fapi/v1/fundingInfo	Get Funding Rate Info
FuturesApi	get_funding_rate_v1	GET /fapi/v1/fundingRate	Get Funding Rate History
FuturesApi	get_futures_data_basis	GET /futures/data/basis	Basis
FuturesApi	get_futures_data_delivery_price	GET /futures/data/delivery-price	Quarterly Contract Settlement Price
FuturesApi	get_futures_data_global_long_short_account_ratio	GET /futures/data/globalLongShortAccountRatio	Long/Short Ratio
FuturesApi	get_futures_data_open_interest_hist	GET /futures/data/openInterestHist	Open Interest Statistics
FuturesApi	get_futures_data_takerlongshort_ratio	GET /futures/data/takerlongshortRatio	Taker Buy/Sell Volume
FuturesApi	get_futures_data_top_long_short_account_ratio	GET /futures/data/topLongShortAccountRatio	Top Trader Long/Short Ratio (Accounts)
FuturesApi	get_futures_data_top_long_short_position_ratio	GET /futures/data/topLongShortPositionRatio	Top Trader Long/Short Ratio (Positions)
FuturesApi	get_historical_trades_v1	GET /fapi/v1/historicalTrades	Old Trades Lookup (MARKET_DATA)
FuturesApi	get_income_asyn_id_v1	GET /fapi/v1/income/asyn/id	Get Futures Transaction History Download Link by Id (USER_DATA)
FuturesApi	get_income_asyn_v1	GET /fapi/v1/income/asyn	Get Download Id For Futures Transaction History(USER_DATA)
FuturesApi	get_index_info_v1	GET /fapi/v1/indexInfo	Composite Index Symbol Information
FuturesApi	get_index_price_klines_v1	GET /fapi/v1/indexPriceKlines	Index Price Kline/Candlestick Data
FuturesApi	get_klines_v1	GET /fapi/v1/klines	Kline/Candlestick Data
FuturesApi	get_leverage_bracket_v1	GET /fapi/v1/leverageBracket	Notional and Leverage Brackets (USER_DATA)
FuturesApi	get_mark_price_klines_v1	GET /fapi/v1/markPriceKlines	Mark Price Kline/Candlestick Data
FuturesApi	get_multi_assets_margin_v1	GET /fapi/v1/multiAssetsMargin	Get Current Multi-Assets Mode (USER_DATA)
FuturesApi	get_open_interest_v1	GET /fapi/v1/openInterest	Open Interest
FuturesApi	get_open_order_v1	GET /fapi/v1/openOrder	Query Current Open Order (USER_DATA)
FuturesApi	get_open_orders_v1	GET /fapi/v1/openOrders	Current All Open Orders (USER_DATA)
FuturesApi	get_order_amendment_v1	GET /fapi/v1/orderAmendment	Get Order Modify History (USER_DATA)
FuturesApi	get_order_asyn_id_v1	GET /fapi/v1/order/asyn/id	Get Futures Order History Download Link by Id (USER_DATA)
FuturesApi	get_order_asyn_v1	GET /fapi/v1/order/asyn	Get Download Id For Futures Order History (USER_DATA)
FuturesApi	get_order_v1	GET /fapi/v1/order	Query Order (USER_DATA)
FuturesApi	get_ping_v1	GET /fapi/v1/ping	Test Connectivity
FuturesApi	get_pm_account_info_v1	GET /fapi/v1/pmAccountInfo	Classic Portfolio Margin Account Information (USER_DATA)
FuturesApi	get_position_margin_history_v1	GET /fapi/v1/positionMargin/history	Get Position Margin Change History (TRADE)
FuturesApi	get_position_risk_v2	GET /fapi/v2/positionRisk	Position Information V2 (USER_DATA)
FuturesApi	get_position_risk_v3	GET /fapi/v3/positionRisk	Position Information V3 (USER_DATA)
FuturesApi	get_position_side_dual_v1	GET /fapi/v1/positionSide/dual	Get Current Position Mode(USER_DATA)
FuturesApi	get_premium_index_klines_v1	GET /fapi/v1/premiumIndexKlines	Premium index Kline Data
FuturesApi	get_premium_index_v1	GET /fapi/v1/premiumIndex	Mark Price
FuturesApi	get_rate_limit_order_v1	GET /fapi/v1/rateLimit/order	Query User Rate Limit (USER_DATA)
FuturesApi	get_symbol_config_v1	GET /fapi/v1/symbolConfig	Symbol Configuration(USER_DATA)
FuturesApi	get_ticker24hr_v1	GET /fapi/v1/ticker/24hr	24hr Ticker Price Change Statistics
FuturesApi	get_ticker_book_ticker_v1	GET /fapi/v1/ticker/bookTicker	Symbol Order Book Ticker
FuturesApi	get_ticker_price_v1	GET /fapi/v1/ticker/price	Symbol Price Ticker
FuturesApi	get_ticker_price_v2	GET /fapi/v2/ticker/price	Symbol Price Ticker V2
FuturesApi	get_time_v1	GET /fapi/v1/time	Check Server Time
FuturesApi	get_trade_asyn_id_v1	GET /fapi/v1/trade/asyn/id	Get Futures Trade Download Link by Id(USER_DATA)
FuturesApi	get_trade_asyn_v1	GET /fapi/v1/trade/asyn	Get Download Id For Futures Trade History (USER_DATA)
FuturesApi	get_trades_v1	GET /fapi/v1/trades	Recent Trades List
FuturesApi	get_user_trades_v1	GET /fapi/v1/userTrades	Account Trade List (USER_DATA)
FuturesApi	update_batch_orders_v1	PUT /fapi/v1/batchOrders	Modify Multiple Orders(TRADE)
FuturesApi	update_listen_key_v1	PUT /fapi/v1/listenKey	Keepalive User Data Stream (USER_STREAM)
FuturesApi	update_order_v1	PUT /fapi/v1/order	Modify Order (TRADE)

Documentation For Models

• ApiError
• CreateApiReferralCustomizationV1Resp
• CreateApiReferralUserCustomizationV1Resp
• CreateConvertAcceptQuoteV1Resp
• CreateConvertGetQuoteV1Resp
• CreateFeeBurnV1Resp
• CreateLeverageV1Resp
• CreateListenKeyV1Resp
• CreateMarginTypeV1Resp
• CreateMultiAssetsMarginV1Resp
• CreateOrderTestV1Resp
• CreateOrderV1Resp
• CreatePositionMarginV1Resp
• CreatePositionSideDualV1Resp
• DeleteAllOpenOrdersV1Resp
• DeleteOrderV1Resp
• GetAccountConfigV1Resp
• GetAccountV2Resp
• GetAccountV2RespAssetsInner
• GetAccountV2RespPositionsInner
• GetAccountV3Resp
• GetAccountV3RespAssetsInner
• GetAccountV3RespPositionsInner
• GetAdlQuantileV1RespItem
• GetAdlQuantileV1RespItemAdlQuantile
• GetAllOrdersV1RespItem
• GetApiReferralCustomizationV1RespItem
• GetApiReferralIfNewUserV1Resp
• GetApiReferralOverviewV1Resp
• GetApiReferralRebateVolV1RespItem
• GetApiReferralTradeVolV1RespItem
• GetApiReferralTraderNumV1RespItem
• GetApiReferralTraderSummaryV1RespItem
• GetApiReferralUserCustomizationV1Resp
• GetBalanceV2RespItem
• GetBalanceV3RespItem
• GetCommissionRateV1Resp
• GetConstituentsV1Resp
• GetConstituentsV1RespConstituentsInner
• GetConvertExchangeInfoV1RespItem
• GetConvertOrderStatusV1Resp
• GetDepthV1Resp
• GetFeeBurnV1Resp
• GetForceOrdersV1RespItem
• GetFundingInfoV1RespItem
• GetFundingRateV1RespItem
• GetFuturesDataBasisRespItem
• GetFuturesDataGlobalLongShortAccountRatioRespItem
• GetFuturesDataOpenInterestHistRespItem
• GetFuturesDataTakerlongshortRatioRespItem
• GetFuturesDataTopLongShortAccountRatioRespItem
• GetFuturesDataTopLongShortPositionRatioRespItem
• GetHistoricalTradesV1RespItem
• GetIncomeAsynIdV1Resp
• GetIncomeAsynV1Resp
• GetIncomeV1RespItem
• GetIndexInfoV1RespItem
• GetIndexInfoV1RespItemBaseAssetListInner
• GetMultiAssetsMarginV1Resp
• GetOpenInterestV1Resp
• GetOpenOrderV1Resp
• GetOpenOrdersV1RespItem
• GetOrderAmendmentV1RespItem
• GetOrderAmendmentV1RespItemAmendment
• GetOrderAmendmentV1RespItemAmendmentOrigQty
• GetOrderAsynIdV1Resp
• GetOrderV1Resp
• GetPmAccountInfoV1Resp
• GetPositionMarginHistoryV1RespItem
• GetPositionRiskV2RespItem
• GetPositionRiskV3RespItem
• GetPositionSideDualV1Resp
• GetRateLimitOrderV1RespItem
• GetSymbolConfigV1RespItem
• GetTimeV1Resp
• GetTradeAsynIdV1Resp
• GetTradeAsynV1Resp
• GetTradesV1RespItem
• GetUserTradesV1RespItem
• UmfuturesCreateBatchOrdersV1ReqBatchOrdersItem
• UmfuturesCreateBatchOrdersV1RespInner
• UmfuturesCreateBatchOrdersV1RespItem
• UmfuturesCreateCountdownCancelAllV1Req
• UmfuturesCreateCountdownCancelAllV1Resp
• UmfuturesDeleteBatchOrdersV1RespInner
• UmfuturesDeleteBatchOrdersV1RespItem
• UmfuturesGetAggTradesV1RespItem
• UmfuturesGetApiTradingStatusV1Resp
• UmfuturesGetAssetIndexV1Resp
• UmfuturesGetAssetIndexV1RespItem
• UmfuturesGetContinuousKlinesV1RespInnerInner
• UmfuturesGetExchangeInfoV1Resp
• UmfuturesGetExchangeInfoV1RespAssetsInner
• UmfuturesGetExchangeInfoV1RespRateLimitsInner
• UmfuturesGetExchangeInfoV1RespSymbolsInner
• UmfuturesGetExchangeInfoV1RespSymbolsInnerFiltersInner
• UmfuturesGetFuturesDataDeliveryPriceRespItem
• UmfuturesGetLeverageBracketV1Resp
• UmfuturesGetLeverageBracketV1RespItem
• UmfuturesGetLeverageBracketV1RespItemBracketsInner
• UmfuturesGetOrderAsynV1Resp
• UmfuturesGetPremiumIndexV1Resp
• UmfuturesGetPremiumIndexV1RespItem
• UmfuturesGetTicker24hrV1Resp
• UmfuturesGetTicker24hrV1RespItem
• UmfuturesGetTickerBookTickerV1Resp
• UmfuturesGetTickerBookTickerV1RespItem
• UmfuturesGetTickerPriceV1Resp
• UmfuturesGetTickerPriceV1RespItem
• UmfuturesGetTickerPriceV2Resp
• UmfuturesGetTickerPriceV2RespItem
• UmfuturesUpdateBatchOrdersV1ReqBatchOrdersItem
• UmfuturesUpdateBatchOrdersV1RespItem
• UpdateListenKeyV1Resp
• UpdateOrderV1Resp

To get access to the crate's generated documentation, use:

cargo doc --open

Author