implementation_status.md

FAPI implementation status

Release status: binapi2 is feature-complete for the Binance USD-M Futures public API. Every documented endpoint is implemented and verified against the Binance testnet via scripts/testnet/*.sh (135 demo CLI commands).

Coverage summary:

• REST: 39 market data + 21 account + 29 trade + 3 convert + 3 user data stream = 95 endpoints
• WebSocket API: 16 methods (session logon, tickers, orders, positions, algo orders, listen key)
• Market streams: 22 subscriptions (per-symbol, all-symbol, meta)
• User data streams: 10 event types via std::variant dispatch
• Local order book: 2 variants (single-thread + 3-thread pipelined)

Status meanings used here:

• implemented = direct current endpoint, method, or stream support exists in the FAPI codebase
• partial = only a subset, adjacent variant, or general/reference coverage exists
• superseded = a newer API version is implemented instead (e.g. V3 replaces V2)
• informational = doc is a reference or notice, not an endpoint requiring implementation
• stub = doc is a placeholder with no endpoint specification
• TBD = no direct support exists in current FAPI code

Top-level docs

Doc	Status	Source files
general-info.md	partial	client.cpp, signing.cpp, signing.hpp
common-definition.md	implemented	types/enums.hpp, types/common.hpp
error-code.md	partial	error.hpp, result.hpp, client.hpp
websocket-api-general-info.md	implemented	ws-api/client.hpp, ws-api/client.cpp, ws-api/generated_methods.hpp
websocket-market-streams.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp
user-data-streams.md	implemented	streams/user_streams.hpp, streams/user_streams.cpp, rest/user_data_streams.hpp
convert.md	implemented	rest/convert.hpp, rest/convert.cpp, types/convert.hpp
portfolio-margin-endpoints.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp

Market data REST docs

Doc	Status	Source files
Check-Server-Time.md	implemented	rest/market_data.hpp, rest/market_data.cpp
Exchange-Information.md	implemented	rest/market_data.hpp, rest/market_data.cpp
Order-Book.md	implemented	rest/market_data.hpp, rest/market_data.cpp
Recent-Trades-List.md	implemented	rest/market_data.hpp, rest/market_data.cpp
Compressed-Aggregate-Trades-List.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Kline-Candlestick-Data.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Continuous-Contract-Kline-Candlestick-Data.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Index-Price-Kline-Candlestick-Data.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Mark-Price-Kline-Candlestick-Data.md	implemented	rest/market_data.hpp, rest/market_data.cpp
Premium-Index-Kline-Data.md	implemented	rest/market_data.hpp, rest/market_data.cpp
Mark-Price.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Get-Funding-Rate-History.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Get-Funding-Rate-Info.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Open-Interest.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Open-Interest-Statistics.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Top-Long-Short-Account-Ratio.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Top-Trader-Long-Short-Ratio.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Long-Short-Ratio.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Taker-BuySell-Volume.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp
Basis.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp, rest/generated_endpoints.hpp
24hr-Ticker-Price-Change-Statistics.md	implemented	rest/market_data.hpp, rest/market_data.cpp
Symbol-Price-Ticker.md	implemented	rest/market_data.hpp, rest/market_data.cpp
Symbol-Price-Ticker-v2.md	implemented	rest/market_data.hpp, rest/market_data.cpp, rest/generated_endpoints.hpp
Symbol-Order-Book-Ticker.md	implemented	rest/market_data.hpp, rest/market_data.cpp
Delivery-Price.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp, rest/generated_endpoints.hpp
Composite-Index-Symbol-Information.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp, rest/generated_endpoints.hpp
Index-Constituents.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp, rest/generated_endpoints.hpp
Multi-Assets-Mode-Asset-Index.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp, rest/generated_endpoints.hpp
Insurance-Fund-Balance.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp, rest/generated_endpoints.hpp
ADL-Risk.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp, rest/generated_endpoints.hpp
Order-Book-RPI.md	implemented	rest/market_data.hpp, rest/market_data.cpp, rest/generated_endpoints.hpp
Trading-Schedule.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp, rest/generated_endpoints.hpp
Delist-Schedule.md	informational	Not a separate endpoint; doc directs users to check deliveryDate in exchange_info() response.
Old-Trades-Lookup.md	implemented	rest/market_data.hpp, rest/market_data.cpp, types/market_data.hpp

Market data WebSocket API docs

Doc	Status	Source files
market-data/websocket-api	partial	Order-book RPC overview; no dedicated depth WS API method.
WS-Symbol-Order-Book-Ticker.md	implemented	ws-api/client.hpp, ws-api/client.cpp
WS-Symbol-Price-Ticker.md	implemented	ws-api/client.hpp, ws-api/client.cpp

Account REST docs

Doc	Status	Source files
account/rest-api	stub	Transfer overview page; docs contain only a placeholder with no endpoint specification.
Account-Information-V2.md	superseded	Legacy V2 endpoint superseded by V3; implemented as account_service::account_information() using /fapi/v3/account.
Account-Information-V3.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Futures-Account-Balance-V2.md	superseded	Legacy V2 endpoint superseded by V3; implemented as account_service::balances() using /fapi/v3/balance.
Futures-Account-Balance-V3.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Account-Config.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Symbol-Config.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Get-Current-Multi-Assets-Mode.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Get-Current-Position-Mode.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Get-Income-History.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Notional-and-Leverage-Brackets.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
User-Commission-Rate.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Query-Rate-Limit.md	implemented	rest/account.hpp, rest/account.cpp
Get-Future-Account-Transaction-History-List.md	stub	Docs contain only a placeholder with no endpoint specification.
Get-Download-Id-For-Futures-Transaction-History.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Get-Futures-Transaction-History-Download-Link-by-Id.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Get-Download-Id-For-Futures-Order-History.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Get-Futures-Order-History-Download-Link-by-Id.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Get-Download-Id-For-Futures-Trade-History.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Get-Futures-Trade-Download-Link-by-Id.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Get-BNB-Burn-Status.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Toggle-BNB-Burn-On-Futures-Trade.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Futures-Trading-Quantitative-Rules-Indicators.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp

Account WebSocket API docs

Doc	Status	Source files
WS-Account-Information.md	implemented	ws-api/client.hpp, ws-api/client.cpp
WS-Account-Information-V2.md	implemented	ws-api/client.hpp, ws-api/client.cpp
WS-Futures-Account-Balance.md	implemented	ws-api/client.hpp, ws-api/client.cpp

Trade REST docs

Doc	Status	Source files
New-Order-Test.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Place-Multiple-Orders.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Modify-Order.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Modify-Multiple-Orders.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Query-Order.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Cancel-Order.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Cancel-Multiple-Orders.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Cancel-All-Open-Orders.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Auto-Cancel-All-Open-Orders.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Query-Current-Open-Order.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
All-Orders.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Current-All-Open-Orders.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Position-Information-V2.md	implemented	rest/account.hpp, rest/account.cpp, types/account.hpp
Position-Information-V3.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Position-ADL-Quantile-Estimation.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Users-Force-Orders.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Account-Trade-List.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Change-Position-Mode.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Change-Multi-Assets-Mode.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Change-Initial-Leverage.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Change-Margin-Type.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Modify-Isolated-Position-Margin.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Get-Position-Margin-Change-History.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Get-Order-Modify-History.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Current-All-Algo-Open-Orders.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Cancel-All-Algo-Open-Orders.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
New-Algo-Order.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Cancel-Algo-Order.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Query-Algo-Order.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
Query-All-Algo-Orders.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp
TradFi-Perps.md	implemented	rest/trade.hpp, rest/trade.cpp, types/trade.hpp

Trade WebSocket API docs

Doc	Status	Source files
WS-New-Algo-Order.md	implemented	ws-api/client.hpp, ws-api/client.cpp, types/websocket_api.hpp
WS-Cancel-Algo-Order.md	implemented	ws-api/client.hpp, ws-api/client.cpp, types/websocket_api.hpp
WS-Modify-Order.md	implemented	ws-api/client.hpp, ws-api/client.cpp, types/websocket_api.hpp
WS-Query-Order.md	implemented	ws-api/client.hpp, ws-api/client.cpp
WS-Cancel-Order.md	implemented	ws-api/client.hpp, ws-api/client.cpp
WS-Position-Info-V2.md	implemented	ws-api/client.hpp, ws-api/client.cpp, types/websocket_api.hpp
WS-Position-Information.md	implemented	ws-api/client.hpp, ws-api/client.cpp, types/websocket_api.hpp

User-data stream docs

Doc	Status	Source files
Start-User-Data-Stream.md	implemented	rest/user_data_streams.hpp, rest/user_data_streams.cpp
Keepalive-User-Data-Stream.md	implemented	rest/user_data_streams.hpp, rest/user_data_streams.cpp
Close-User-Data-Stream.md	implemented	rest/user_data_streams.hpp, rest/user_data_streams.cpp
Start-User-Data-Stream-Wsp.md	implemented	ws-api/client.hpp, ws-api/client.cpp
Keepalive-User-Data-Stream-Wsp.md	implemented	ws-api/client.hpp, ws-api/client.cpp
Close-User-Data-Stream-Wsp.md	implemented	ws-api/client.hpp, ws-api/client.cpp
Event-Balance-and-Position-Update.md	implemented	streams/user_streams.hpp, streams/user_streams.cpp, types/streams.hpp
Event-Order-Update.md	implemented	streams/user_streams.hpp, streams/user_streams.cpp, types/streams.hpp
Event-Margin-Call.md	implemented	streams/user_streams.hpp, streams/user_streams.cpp, types/streams.hpp
Event-User-Data-Stream-Expired.md	implemented	streams/user_streams.hpp, streams/user_streams.cpp, types/streams.hpp
Event-Account-Configuration-Update.md	implemented	streams/user_streams.hpp, streams/user_streams.cpp, types/streams.hpp
Event-Algo-Order-Update.md	implemented	streams/user_streams.hpp, streams/user_streams.cpp, types/streams.hpp
Event-Conditional-Order-Trigger-Reject.md	implemented	streams/user_streams.hpp, streams/user_streams.cpp, types/streams.hpp
Event-GRID-UPDATE.md	implemented	streams/user_streams.hpp, streams/user_streams.cpp, types/streams.hpp
Event-STRATEGY-UPDATE.md	implemented	streams/user_streams.hpp, streams/user_streams.cpp, types/streams.hpp
Event-Trade-Lite.md	implemented	streams/user_streams.hpp, streams/user_streams.cpp, types/streams.hpp

WebSocket market stream docs

Doc	Status	Source files
Aggregate-Trade-Streams.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
Mark-Price-Stream.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
Individual-Symbol-Book-Ticker-Streams.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
Diff-Book-Depth-Streams.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
Mark-Price-Stream-for-All-market.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
All-Book-Tickers-Stream.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
All-Market-Liquidation-Order-Streams.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
All-Market-Mini-Tickers-Stream.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
All-Market-Tickers-Streams.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
Composite-Index-Symbol-Information-Streams.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
Continuous-Contract-Kline-Candlestick-Streams.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
Contract-Info-Stream.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
Diff-Book-Depth-Streams-RPI.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
How-to-manage-a-local-order-book-correctly.md	implemented	streams/local_order_book.hpp, streams/local_order_book.cpp
Important-WebSocket-Change-Notice.md	informational	Migration notice documenting /public, /market, /private URL split. Current code uses legacy /ws path in config.hpp.
Individual-Symbol-Mini-Ticker-Stream.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp
Individual-Symbol-Ticker-Streams.md	implemented	streams/market_streams.hpp, streams/market_streams.cpp, types/streams.hpp