From 3b80a945eef9c42de8b19850b2e0fe45f2d6caa0 Mon Sep 17 00:00:00 2001 From: Jkorf Date: Tue, 15 Feb 2022 11:34:50 +0100 Subject: [PATCH] docs --- docs/FAQ.md | 16 ++++++++++++++++ docs/Options.md | 2 +- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 58e8c67..24410e0 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -45,4 +45,20 @@ private void SomeMethod() }); } +``` + +### Can I use the TestNet/US/other API with this library +Yes, generally these are all supported and can be configured by setting the BaseAddress in the client options. Some known API addresses should be available in the [Exchange]ApiAddresses class. For example: +```csharp +var client = new BinanceClient(new BinanceClientOptions +{ + SpotApiOptions = new BinanceApiClientOptions + { + BaseAddress = BinanceApiAddresses.TestNet.RestClientAddress + }, + UsdFuturesApiOptions = new BinanceApiClientOptions + { + BaseAddress = BinanceApiAddresses.TestNet.UsdFuturesRestClientAddress + } +}); ``` \ No newline at end of file diff --git a/docs/Options.md b/docs/Options.md index e7a12fa..facd43d 100644 --- a/docs/Options.md +++ b/docs/Options.md @@ -109,7 +109,7 @@ All clients have access to the following options, specific implementations might |Option|Description|Default| |------|-----------|-------| |`ApiCredentials`|The API credentials to use for this specific API client. Will override any credentials provided in the base client options| -|`BaseAddress`|The base address to the API. All calls to the API will use this base address as basis for the endpoints. This allows for swapping to test API's or swapping to a different cluster for example.|Depends on implementation +|`BaseAddress`|The base address to the API. All calls to the API will use this base address as basis for the endpoints. This allows for swapping to test API's or swapping to a different cluster for example. Available base addresses are defined in the [Library]ApiAddresses helper class, for example `KucoinApiAddresses`|Depends on implementation **Options for Rest Api Client (extension of base api client options)**