Skip to content

Commit

Permalink
5.4.1021
Browse files Browse the repository at this point in the history
  • Loading branch information
burakoner committed Oct 21, 2024
1 parent 999c740 commit 2dfa5ce
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
## Change Log & Release Notes

* Version 5.4.1021 - 21 Oct 2024
* Renamed OKXWebSocketApiClient to OkxWebSocketApiClient

* Version 5.4.1018 - 18 Oct 2024
* ApiSharp 3.0.3 Update

Expand Down
8 changes: 4 additions & 4 deletions OKX.Api/OKX.Api.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
<PropertyGroup>
<PackageId>OKX.Api</PackageId>
<Authors>Burak Öner</Authors>
<Version>5.4.1018</Version>
<FileVersion>5.4.1018</FileVersion>
<PackageVersion>5.4.1018</PackageVersion>
<AssemblyVersion>5.4.1018</AssemblyVersion>
<Version>5.4.1021</Version>
<FileVersion>5.4.1021</FileVersion>
<PackageVersion>5.4.1021</PackageVersion>
<AssemblyVersion>5.4.1021</AssemblyVersion>
<Description>OKX V5 Api Wrapper. Up-to-date, most-complete, well-organized, well-documented, easy-to-use, multi-task and multi-thread compatible OKX Cryptocurrency Exchange Rest and Websocket Api Wrapper</Description>
<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
<PackageTags>OKX;OKEX;Binance;BNB;BTC;Api;Client;Rest;Web;Websocket;Socket;Wrapper;Crypto;Currency;Cryptocurrency;Exchange;Trade;Trading;Bitcoin;Spot;Margin;Futures;Derivates;Stock;Options;Swap;</PackageTags>
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,12 @@ After doing either of above steps you should now be ready to actually start usin

After installing it's time to actually use it. To get started we have to add the OKX.Api namespace: `using OKX.Api;`.

OKX.Api provides two clients to interact with the OKX.Api. The `OKXRestApiClient` provides all rest API calls. The `OKXWebSocketApiClient` provides functions to interact with the websocket provided by the OKX.Api. Both clients are disposable and as such can be used in a `using`statement.
OKX.Api provides two clients to interact with the OKX.Api. The `OkxRestApiClient` provides all rest API calls. The `OkxWebSocketApiClient` provides functions to interact with the websocket provided by the OKX.Api. Both clients are disposable and as such can be used in a `using`statement.

## Rest Api Examples

```csharp
var api = new OKXRestApiClient();
var api = new OkxRestApiClient();
api.SetApiCredentials("XXXXXXXX-API-KEY-XXXXXXXX", "XXXXXXXX-API-SECRET-XXXXXXXX", "XXXXXXXX-API-PASSPHRASE-XXXXXXXX");

// Order Book Trading -> Market Data Methods (Signed)
Expand Down Expand Up @@ -507,7 +507,7 @@ var affiliate_01 = await api.Affiliate.GetInviteeAsync(1_000_000L);
The OKX.Api socket client provides several socket endpoint to which can be subscribed.

```csharp
var ws = new OKXWebSocketApiClient();
var ws = new OkxWebSocketApiClient();
ws.SetApiCredentials("XXXXXXXX-API-KEY-XXXXXXXX", "XXXXXXXX-API-SECRET-XXXXXXXX", "XXXXXXXX-API-PASSPHRASE-XXXXXXXX");

// Subscription
Expand Down

0 comments on commit 2dfa5ce

Please sign in to comment.