diff --git a/CHANGELOG.md b/CHANGELOG.md index b2c6ff7..170a037 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/OKX.Api/OKX.Api.csproj b/OKX.Api/OKX.Api.csproj index d582a3e..7a663fc 100644 --- a/OKX.Api/OKX.Api.csproj +++ b/OKX.Api/OKX.Api.csproj @@ -9,10 +9,10 @@ OKX.Api Burak Öner - 5.4.1018 - 5.4.1018 - 5.4.1018 - 5.4.1018 + 5.4.1021 + 5.4.1021 + 5.4.1021 + 5.4.1021 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 true 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; diff --git a/README.md b/README.md index 4f574a9..d7ffc2f 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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