diff --git a/docs/index.html b/docs/index.html index e21cd43..5e06472 100644 --- a/docs/index.html +++ b/docs/index.html @@ -250,7 +250,6 @@
dotnet add package CryptoClients.Net
-
dotnet add package Binance.Net
@@ -469,7 +468,7 @@ ISpotClient - An implementation of the ISpotClient interface for Binance. The ISpotClient offers basic Spot API functionality in a combined interface + An implementation of the ISpotClient interface for each exchange. The ISpotClient offers basic Spot API functionality in a combined interface
@@ -1139,7 +1138,7 @@ if (!subscribeResult.Success) } // Subscribing was successfull, the data will now be streamed into the data handler
-
+
var client = new BinanceSocketClient();
 var subscribeResult = await client.SpotApi.ExchangeData.SubscribeToAllTickerUpdatesAsync(update => {
   // Handle the data update, update.Data will contain the actual data
@@ -1381,7 +1380,7 @@ await client.UnsubscribeAllAsync();
The ExchangeRestClient (or ExchangeRestClient when used directly) can be used to easily access REST clients for different API's.

- For example, having the Binance, Bybit and Kucoin packages installed allows you to use it like this: + For example, using the Binance, Bybit and Kucoin API's can be done like this:

var exchangeRestClient = new ExchangeRestClient(); // Either construct it or inject the IExchangeRestClient into your service
 var binanceTicker = await exchangeRestClient.Binance.SpotApi.ExchangeData.GetTickersAsync();
 var bybitTicker = await exchangeRestClient.Bybit.V5Api.ExchangeData.GetTickers();
@@ -1389,7 +1388,7 @@ var kucoinTicker = await exchangeRestClient.Kucoin.SpotApi.ExchangeData.GetTicke
 		  

(I)ExchangeSocketClient
- Similarly as the (I)ExchangeRestClient this client allows you to access the different Websocket clients through a single access point. + Similarly as the (I)ExchangeRestClient this client allows you to access the different Websocket clients through a single access point.

For example accessing the Bitget, Kraken and OKX API's could be done like this:

var exchangeSocketClient = new ExchangeSocketClient(); // Either construct it or inject the ExchangeSocketClient into your service
@@ -1399,10 +1398,10 @@ var okxSub = await exchangeSocketClient.OKX.UnifiedApi.ExchangeData.SubscribeToT
 		  

ISpotClient
- The ISpotClient is a REST API client interface implemented by each library which implements a Spot trading API. It provided a common way of doing basic operations on the Spot market, for example getting ticker or trade data, but also placing and retrieving orders. Because this interface is implemented for each exchange with a Spot market the interface is relatively basic, only exposing methods that are supported by all the APIs. + The ISpotClient is a REST API client interface implemented by each library which implements a Spot trading API. It provided a common way of doing basic operations on the Spot market, for example getting ticker or trade data, but also placing and retrieving orders. Because this interface is implemented for each exchange with a Spot market the interface is relatively basic, only exposing methods that are supported by all the APIs.

- The ISpotClient is added to the service collection when using dependency injection. Alternatively it can be accessed for a specific client by calling the `CommonSpotClient` property on the Spot sub-API of a client: + The ISpotClient is added to the service collection when using dependency injection. Alternatively it can be accessed for a specific client by calling the `CommonSpotClient` property on the Spot sub-API of a client:

var spotClient = restClient.SpotApi.CommonSpotClient;

@@ -1505,8 +1504,12 @@ options.ApiCredentials = new ApiCredentials("YOUR PUBLIC KEY", "YOUR PRIVATE KEY
-
builder.Services.AddCryptoClients(globalOptions =>{
+
builder.Services.AddCryptoClients(globalOptions => {
     globalOptions.RequestTimeout = TimeSpan.FromSeconds(30);
+  },
+  // Exchange specific options can be provided as well
+  bybitRestOptions: bybitOptions => {
+    // Set options specific for the Bybit rest client here
   });
@@ -1623,7 +1626,7 @@ options.ApiCredentials = new ApiCredentials("YOUR PUBLIC KEY", "YOUR PRIVATE KEY
-
+
services.AddBinance(x =>
     x.RatelimiterEnabled = true;
     x.RateLimitingBehaviour = RateLimitingBehaviour.Wait;