flywithu/CryptoExchange.Net
1
0
Fork 0
mirror of https://github.com/JKorf/CryptoExchange.Net synced 2025-06-07 16:06:15 +00:00
Code Issues Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Jkorf 2024-12-04 09:15:23 +01:00
parent 23a6cfff87
commit 0164cdfcc4
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/index.html
View File

@ -1184,7 +1184,7 @@
<p>All clients work with the same principles:</p> <p>All clients work with the same principles:</p>
<ul> <ul>
<li>Mandatory parameters are non-nullable while optional parameters are nullable and will have a default value of null.</li> <li>Mandatory parameters are non-nullable while optional parameters are nullable and will have a default value of null.</li>
<li>Any operation will return a form of <code>CallResult</code>. This result can and should be checked for success using the `Success` property. If `Success` is false the `Error` property will have more info.</li> <li>Any operation will return a form of <code>CallResult</code>. This result can and should be checked for success using the <code>Success</code> property. If <code>Success</code> is false the <code>Error</code> property will have more info.</li>
<li>Clients will not throw exceptions.</li> <li>Clients will not throw exceptions.</li>
</ul> </ul>
</section> </section>
@ -2201,10 +2201,10 @@ var spotSharedRestClients = whitebitRestClient.V4Api.SharedClient;
var spotSharedSocketClient = whitebitSocketClient.V4Api.SharedClient;</code></pre> var spotSharedSocketClient = whitebitSocketClient.V4Api.SharedClient;</code></pre>
</div> </div>
<div class="tab-pane fade" id="shared-xt" role="tabpanel" aria-labelledby="shared-xt-tab"> <div class="tab-pane fade" id="shared-xt" role="tabpanel" aria-labelledby="shared-xt-tab">
<pre><code>Spot API common functionality rest client <pre><code>// Spot API common functionality rest client
var spotSharedRestClients = xtRestClient.SpotApi.SharedClient; var spotSharedRestClients = xtRestClient.SpotApi.SharedClient;
Futures API common functionality rest client // Futures API common functionality rest client
var futuresSharedRestClients = xtRestClient.UsdtFuturesApi.SharedClient; var futuresSharedRestClients = xtRestClient.UsdtFuturesApi.SharedClient;
// Spot API common functionality socket client // Spot API common functionality socket client
@ -4661,7 +4661,7 @@ var binanceClient = new BinanceRestClient(new HttpClient(), logFactory, options
</code></pre> </code></pre>
</div> </div>
<div class="tab-pane fade" id="limit-whitebit" role="tabpanel" aria-labelledby="limit-whitebit-tab"> <div class="tab-pane fade" id="limit-xt" role="tabpanel" aria-labelledby="limit-xt-tab">
<pre><code>services.AddXT(x => <pre><code>services.AddXT(x =>
x.RatelimiterEnabled = true; x.RatelimiterEnabled = true;
x.RateLimitingBehaviour = RateLimitingBehaviour.Wait; x.RateLimitingBehaviour = RateLimitingBehaviour.Wait;
@ -5119,7 +5119,7 @@ var result = await htxClient.SpotApi.Account.GetBalancesAsync();</code></pre>
<div class="tab-pane fade" id="example-balances-whitebit" role="tabpanel" aria-labelledby="example-balances-whitebit-tab"> <div class="tab-pane fade" id="example-balances-whitebit" role="tabpanel" aria-labelledby="example-balances-whitebit-tab">
<pre><code>await whitebitClient.V4Api.Account.GetSpotBalancesAsync();</code></pre> <pre><code>await whitebitClient.V4Api.Account.GetSpotBalancesAsync();</code></pre>
</div> </div>
<div class="tab-pane fade" id="example-balances-whitebit" role="tabpanel" aria-labelledby="example-balances-whitebit-tab"> <div class="tab-pane fade" id="example-balances-xt" role="tabpanel" aria-labelledby="example-balances-xt-tab">
<pre><code>await xtClient.SpotApi.Account.GetBalancesAsync();</code></pre> <pre><code>await xtClient.SpotApi.Account.GetBalancesAsync();</code></pre>
</div> </div>
</div> </div>
@ -5679,7 +5679,7 @@ await xtSocketClient.SpotApi.SubscribeToBalanceUpdatesAsync(listenKey.Data, data
}); });
// The listen key will stay valid for 48 hours, after this no updates will be send anymore // The listen key will stay valid for 48 hours, after this no updates will be send anymore
// To extend the life time of the listen key it is recommended to call the KeepAliveUserStreamAsync method at a set interval // To extend the life time of the token it is recommended to call the GetWebsocketTokenAsync method at a set interval which will extend the lifetime
_ = Task.Run(async () => { _ = Task.Run(async () => {
while (true) while (true)
{ {