Skip to content

Latest commit

 

History

History
127 lines (105 loc) · 3.93 KB

REST-API.md

File metadata and controls

127 lines (105 loc) · 3.93 KB

REST API

This page outlines all of the general REST API endpoints available via the IBinanceClient.

User Stream Endpoints

Binance Documentation

StartUserDataStream:UserDataStreamResponse

Starts a User Data stream

IBinanceClient.StartUserDataStream()

KeepAliveUserDataStream:void

Pings a User Data stream to keep it alive. Despite this method returning the UserDataStreamResponse type the API currently doesn't return anything.

IBinanceClient.KeepAliveUserDataStream(string userDataListenKey)

CloseUserDataStream:void

Pings a User Data stream to keep it alive. Despite this method returning the UserDataStreamResponse type the API currently doesn't return anything.

IBinanceClient.KeepAliveUserDataStream(string userDataListenKey)

General Endpoints

Binance Documentation

TestConnectivity:EmptyResponse

Tests connectivity to the API

IBinanceClient.TestConnectivity()

GetServerTime:ServerTimeResponse

Gets the server time from the API, for the purposes of syncing

IBinanceClient.GetServerTime()

Market Data Endpoints

Binance Documentation

GetOrderBook:OrderBookResponse

Returns the order book for a provided symbol. Assuming a Cache was provided to the client, the call can go via it.

IBinanceClient.GetOrderBook(string symbol, bool useCache = false, int limit = 100)

GetCompressedAggregateTrades:List<CompressedAggregateTradeResponse>

Get compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated.

IBinanceClient.GetCompressedAggregateTrades(GetCompressedAggregateTradesRequest request)

GetKlinesCandlesticks:List<KlineCandleStickResponse>

Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.

IBinanceClient.GetKlinesCandlesticks(GetKlinesCandlesticksRequest request)

GetDailyTicker:SymbolPriceChangeTickerResponse

24 hour price change statistics on the provided symbol

IBinanceClient.GetDailyTicker(string symbol)

GetSymbolsPriceTicker:List<SymbolPriceResponse>

Latest price for all symbols.

IBinanceClient.GetSymbolsPriceTicker()

GetSymbolsPriceTicker:List<SymbolPriceResponse>

Latest price for all symbols.

IBinanceClient.GetSymbolOrderBookTicker()

Account Endpoints

Binance Documentation

CreateOrder:BaseCreateOrderResponse

Send in a new order.

IBinanceClient.CreateOrder(CreateOrderRequest request)

CreateTestOrder:CreateTestOrder

Send in a new test order.

IBinanceClient.CreateTestOrder(CreateOrderRequest request)

QueryOrder:OrderResponse

Check an order's status.

IBinanceClient.QueryOrder(QueryOrderRequest request, int receiveWindow = 5000)

CancelOrder:CancelOrderResponse

Check an order's status.

IBinanceClient.CancelOrder(CancelOrderRequest request, int receiveWindow = 5000)

GetCurrentOpenOrders:List<OrderResponse>

Get current open orders on the account

IBinanceClient.GetCurrentOpenOrders(CurrentOpenOrdersRequest request, int receiveWindow = 5000)

GetAllOrders:List<OrderResponse>

Get all open orders on the account; active, cancelled, or filled.

IBinanceClient.GetAllOrders(AllOrdersRequest request, int receiveWindow = 5000)

GetAccountInformation:AccountInformationResponse

Get current account information.

IBinanceClient.GetAccountInformation(int receiveWindow = 5000)

GetAccountTrades:List<AccountTradeReponse>

Get trades for a specific account and symbol.

IBinanceClient.GetAccountTrades(AllTradesRequest request, int receiveWindow = 5000)