v-5.4.1010

CHANGELOG.md

@@ -1,7 +1,15 @@
 ## Change Log & Release Notes
 
+* * Version 5.4.1010 - 09 Oct 2024
+  * Updated WebSocket API endpoints and models to [2024-10-04](https://www.okx.com/docs-v5/log_en/#2024-10-04) version
+  * Moved Status methods to Public Client
+  * Moved Announcement methods to Public Client
+  * Removed Market alias for Public Client
+  * Added WS / Fills channel
+  * Refactoring and performance improvements
+
 * Version 5.4.1009 - 09 Oct 2024
-  * Updated endpoints and models to [2024-10-04](https://www.okx.com/docs-v5/log_en/#2024-10-04) version
+  * Updated Rest API endpoints and models to [2024-10-04](https://www.okx.com/docs-v5/log_en/#2024-10-04) version
 
 * Version 5.4.1001 - 01 Oct 2024
   * ApiSharp 3.0.0 Update

OKX.Api.Examples/Program.cs

@@ -3,6 +3,19 @@
 internal class Program
 {
     static async Task Main(string[] args)
+    {
+        var ws = new OKXWebSocketApiClient();
+        ws.SetApiCredentials("ab69cb97-05fb-430f-b880-49940796f86e", "BCD93B0F1C9BCB9C2BE3AD3E2BE53DCE", "bo1144167AZ*");
+
+        await ws.Account.SubscribeToAccountUpdatesAsync(data =>
+        {
+            Console.WriteLine($"Account Balance: {data}");
+        }, "BTC", 100);
+
+        Console.WriteLine("Press any key to exit...");
+        Console.ReadKey();
+    }
+    static async Task Main2(string[] args)
     {
         #region Rest Api Client Examples
         var api = new OkxRestApiClient();
@@ -66,13 +79,9 @@ static async Task Main(string[] args)
         var public_40 = await api.Public.GetExchangeRateAsync();
         var public_41 = await api.Public.GetIndexComponentsAsync("BTC-USDT");
         var public_42 = await api.Public.GetEconomicCalendarDataAsync("BTC-USDT");
-
-        // Status Methods (Unsigned)
-        var system_01 = await api.Status.GetSystemUpgradeStatusAsync();
-
-        // Announcement Methods
-        var announcement_01 = await api.Announcement.GetAnnouncementTypesAsync(); // (Unsigned)
-        var announcement_02 = await api.Announcement.GetAnnouncementsAsync(); // (Signed)
+        var public_43 = await api.Public.GetAnnouncementTypesAsync();
+        var public_44 = await api.Public.GetAnnouncementsAsync();
+        var public_45 = await api.Public.GetSystemUpgradeStatusAsync();
 
         // Trading Account Methods (Signed)
         var account_01 = await api.Account.GetInstrumentsAsync(OkxInstrumentType.Spot);
@@ -578,7 +587,10 @@ await ws.Trade.SubscribeToOrderUpdatesAsync((data) =>
         {
             // ... Your logic here
         }, OkxInstrumentType.Futures, "INSTRUMENT-FAMILY", "INSTRUMENT-ID");
-
+        await ws.Trade.SubscribeToFillsAsync((data) =>
+        {
+            // ... Your logic here
+        });
         await ws.Trade.PlaceOrderAsync(new OkxTradeOrderPlaceRequest());
         await ws.Trade.PlaceOrdersAsync(new List<OkxTradeOrderPlaceRequest>());
         await ws.Trade.CancelOrderAsync(new OkxTradeOrderCancelRequest());

OKX.Api/Account/Clients/OkxAccountSocketClient.cs

@@ -6,15 +6,23 @@
 public class OkxAccountSocketClient(OKXWebSocketApiClient root)
 {
     // Internal
-    internal OKXWebSocketApiClient Root { get; } = root;
+    internal OKXWebSocketApiClient _ { get; } = root;
 
     /// <summary>
     /// Retrieve account information. Data will be pushed when triggered by events such as placing/canceling order, and will also be pushed in regular interval according to subscription granularity.
     /// </summary>
     /// <param name="onData">On Data Handler</param>
+    /// <param name="currency">Currency</param>
+    /// <param name="updateInterval">0: only push due to account events
+    /// The data will be pushed both by events and regularly if this field is omitted or set to other values than 0.
+    /// The following format should be strictly obeyed when using this field.</param>
     /// <param name="ct">Cancellation Token</param>
     /// <returns></returns>
-    public async Task<CallResult<WebSocketUpdateSubscription>> SubscribeToAccountUpdatesAsync(Action<OkxAccountBalance> onData, CancellationToken ct = default)
+    public async Task<CallResult<WebSocketUpdateSubscription>> SubscribeToAccountUpdatesAsync(
+        Action<OkxAccountBalance> onData,
+        string? currency = null,
+        int? updateInterval = null,
+        CancellationToken ct = default)
     {
         var internalHandler = new Action<WebSocketDataEvent<OkxSocketUpdateResponse<List<OkxAccountBalance>>>>(data =>
         {
@@ -24,9 +32,14 @@ public async Task<CallResult<WebSocketUpdateSubscription>> SubscribeToAccountUpd
 
         var request = new OkxSocketRequest(OkxSocketOperation.Subscribe, new OkxSocketRequestArgument
         {
-            Channel = "account"
+            Channel = "account",
+            Currency = currency,
+            ExtraParameters = updateInterval.HasValue 
+                ? new Dictionary<string, string> { { "interval", updateInterval.Value.ToOkxString() } }
+                : null
         });
-        return await Root.RootSubscribeAsync(OkxSocketEndpoint.Private, request, null, true, internalHandler, ct).ConfigureAwait(false);
+
+        return await _.RootSubscribeAsync(OkxSocketEndpoint.Private, request, null, true, internalHandler, ct).ConfigureAwait(false);
     }
 
     /// <summary>
@@ -65,7 +78,7 @@ public async Task<CallResult<WebSocketUpdateSubscription>> SubscribeToPositionUp
             InstrumentFamily = symbol.InstrumentFamily,
         });
         var request = new OkxSocketRequest(OkxSocketOperation.Subscribe, arguments);
-        return await Root.RootSubscribeAsync(OkxSocketEndpoint.Private, request, null, true, internalHandler, ct).ConfigureAwait(false);
+        return await _.RootSubscribeAsync(OkxSocketEndpoint.Private, request, null, true, internalHandler, ct).ConfigureAwait(false);
     }
 
     /// <summary>
@@ -86,7 +99,7 @@ public async Task<CallResult<WebSocketUpdateSubscription>> SubscribeToBalanceAnd
         {
             Channel = "balance_and_position"
         });
-        return await Root.RootSubscribeAsync(OkxSocketEndpoint.Private, request, null, true, internalHandler, ct).ConfigureAwait(false);
+        return await _.RootSubscribeAsync(OkxSocketEndpoint.Private, request, null, true, internalHandler, ct).ConfigureAwait(false);
     }
 
     /// <summary>
@@ -113,7 +126,7 @@ public async Task<CallResult<WebSocketUpdateSubscription>> SubscribeToPositionRi
             Channel = "liquidation-warning",
             InstrumentType = instrumentType
         });
-        return await Root.RootSubscribeAsync(OkxSocketEndpoint.Private, request, null, true, internalHandler, ct).ConfigureAwait(false);
+        return await _.RootSubscribeAsync(OkxSocketEndpoint.Private, request, null, true, internalHandler, ct).ConfigureAwait(false);
     }
 
     /// <summary>
@@ -135,6 +148,6 @@ public async Task<CallResult<WebSocketUpdateSubscription>> SubscribeToAccountGre
         {
             Channel = "account-greeks",
         });
-        return await Root.RootSubscribeAsync(OkxSocketEndpoint.Private, request, null, true, internalHandler, ct).ConfigureAwait(false);
+        return await _.RootSubscribeAsync(OkxSocketEndpoint.Private, request, null, true, internalHandler, ct).ConfigureAwait(false);
     }
 }

OKX.Api/Algo/Clients/OkxAlgoSocketClient.cs

@@ -6,7 +6,7 @@
 public class OkxAlgoSocketClient(OKXWebSocketApiClient root)
 {
     // Internal
-    internal OKXWebSocketApiClient Root { get; } = root;
+    internal OKXWebSocketApiClient _ { get; } = root;
 
     /// <summary>
     /// Retrieve algo orders (includes trigger order, oco order, conditional order). Data will not be pushed when first subscribed. Data will only be pushed when triggered by events such as placing/canceling order.
@@ -52,7 +52,7 @@ public async Task<CallResult<WebSocketUpdateSubscription>> SubscribeToAlgoOrderU
             InstrumentFamily = symbol.InstrumentFamily,
         });
         var request = new OkxSocketRequest(OkxSocketOperation.Subscribe, arguments);
-        return await Root.RootSubscribeAsync(OkxSocketEndpoint.Business, request, null, true, internalHandler, ct).ConfigureAwait(false);
+        return await _.RootSubscribeAsync(OkxSocketEndpoint.Business, request, null, true, internalHandler, ct).ConfigureAwait(false);
     }
 
 
@@ -100,7 +100,7 @@ public async Task<CallResult<WebSocketUpdateSubscription>> SubscribeToAdvanceAlg
             InstrumentFamily = symbol.InstrumentFamily,
         });
         var request = new OkxSocketRequest(OkxSocketOperation.Subscribe, arguments);
-        return await Root.RootSubscribeAsync(OkxSocketEndpoint.Business, request, null, true, internalHandler, ct).ConfigureAwait(false);
+        return await _.RootSubscribeAsync(OkxSocketEndpoint.Business, request, null, true, internalHandler, ct).ConfigureAwait(false);
     }
 
 }

OKX.Api/Base/Clients/OkxBaseRestClient.cs

@@ -6,13 +6,13 @@
 public abstract class OkxBaseRestClient : RestApiClient
 {
     internal ILogger Logger { get => _logger; }
-    internal OkxRestApiClient Root { get; }
-    internal OkxRestApiOptions Options { get { return Root.Options; } }
+    internal OkxRestApiClient _ { get; }
+    internal OkxRestApiOptions Options { get { return _.Options; } }
     internal TimeSyncState TimeSyncState { get; } = new("OKX RestApi");
 
     internal OkxBaseRestClient(OkxRestApiClient root) : base(root.Logger, root.Options)
     {
-        Root = root;
+        _ = root;
         ManualParseError = true;
 
         RequestBodyFormat = RestRequestBodyFormat.Json;
@@ -50,7 +50,7 @@ protected override Task<ServerError> TryParseErrorAsync(JToken error)
         return Task.FromResult<ServerError>(null);
     }
     /// <inheritdoc />
-    protected override Task<RestCallResult<DateTime>> GetServerTimestampAsync() => Root.Public.GetServerTimeAsync();
+    protected override Task<RestCallResult<DateTime>> GetServerTimestampAsync() => _.Public.GetServerTimeAsync();
     /// <inheritdoc />
     protected override TimeSyncInfo GetTimeSyncInfo() => new(Logger, Options.AutoTimestamp, Options.AutoTimestampInterval, TimeSyncState);
     /// <inheritdoc />

OKX.Api/Base/Requests/OkxSocketRequests.cs

@@ -130,6 +130,18 @@ public record OkxSocketRequestArgument
     [JsonProperty("channel")]
     public string? Channel { get; set; }
 
+    /// <summary>
+    /// Currency
+    /// </summary>
+    [JsonProperty("ccy", NullValueHandling = NullValueHandling.Ignore)]
+    public string? Currency { get; set; }
+
+    /// <summary>
+    /// Algo Order Id
+    /// </summary>
+    [JsonProperty("algoId", NullValueHandling = NullValueHandling.Ignore)]
+    public string? AlgoOrderId { get; set; }
+
     /// <summary>
     /// Instrument Family
     /// </summary>
@@ -149,10 +161,10 @@ public record OkxSocketRequestArgument
     public OkxInstrumentType? InstrumentType { get; set; }
 
     /// <summary>
-    /// Algo Order Id
+    /// Additional configuration
     /// </summary>
-    [JsonProperty("algoId", NullValueHandling = NullValueHandling.Ignore)]
-    public string? AlgoOrderId { get; set; }
+    [JsonProperty("extraParams", NullValueHandling = NullValueHandling.Ignore)]
+    public Dictionary<string, string>? ExtraParameters { get; set; }
 }
 
 /// <summary>

OKX.Api/Block/Clients/OkxBlockSocketClient.cs

@@ -6,11 +6,12 @@
 public class OkxBlockSocketClient(OKXWebSocketApiClient root)
 {
     // Internal
-    internal OKXWebSocketApiClient Root { get; } = root;
+    internal OKXWebSocketApiClient _ { get; } = root;
 
     // TODO: Rfqs channel
     // TODO: Quotes channel
     // TODO: Structure block trades channel
+
     // TODO: Public structure block trades channel
     // TODO: Public block trades channel
     // TODO: Block tickers channel

OKX.Api/CopyTrading/Clients/OkxCopyTradingSocketClient.cs

@@ -6,7 +6,7 @@
 public class OkxCopyTradingSocketClient(OKXWebSocketApiClient root)
 {
     // Internal
-    internal OKXWebSocketApiClient Root { get; } = root;
+    internal OKXWebSocketApiClient _ { get; } = root;
 
     // WS / Copy trading notification channel
     // WS / Lead trading notification channel

OKX.Api/Funding/Clients/OKXFundingSocketClient.cs

@@ -6,7 +6,7 @@
 public class OkxFundingSocketClient(OKXWebSocketApiClient root)
 {
     // Internal
-    internal OKXWebSocketApiClient Root { get; } = root;
+    internal OKXWebSocketApiClient _ { get; } = root;
 
     // TODO: Deposit info channel
     // TODO: Withdrawal info channel

OKX.Api/Grid/Clients/OkxGridSocketClient.cs

@@ -6,7 +6,7 @@
 public class OkxGridSocketClient(OKXWebSocketApiClient root)
 {
     // Internal
-    internal OKXWebSocketApiClient Root { get; } = root;
+    internal OKXWebSocketApiClient _ { get; } = root;
 
     // TODO: WS / Spot grid algo orders channel
     // TODO: WS / Contract grid algo orders channel

OKX.Api/OKX.Api.csproj

@@ -9,10 +9,10 @@
 	<PropertyGroup>
 		<PackageId>OKX.Api</PackageId>
 		<Authors>Burak Öner</Authors>
-		<Version>5.4.1009</Version>
-		<FileVersion>5.4.1009</FileVersion>
-		<PackageVersion>5.4.1009</PackageVersion>
-		<AssemblyVersion>5.4.1009</AssemblyVersion>
+		<Version>5.4.1010</Version>
+		<FileVersion>5.4.1010</FileVersion>
+		<PackageVersion>5.4.1010</PackageVersion>
+		<AssemblyVersion>5.4.1010</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>

OKX.Api/OKXRestApiClient.cs

@@ -55,11 +55,6 @@ public class OkxRestApiClient
     /// </summary>
     public OkxCopyTradingRestClient CopyTrading { get; }
 
-    /// <summary>
-    /// Alias for Public Client
-    /// </summary>
-    public OkxPublicRestClient Market { get => Public; }
-
     /// <summary>
     /// Block Trading Client
     /// </summary>
@@ -104,17 +99,6 @@ public class OkxRestApiClient
     /// Affiliate Client
     /// </summary>
     public OkxAffiliateRestClient Affiliate { get; }
-
-    /// <summary>
-    /// Status Client
-    /// </summary>
-    public OkxStatusRestClient Status { get; }
-
-    /// <summary>
-    /// Announcement Client
-    /// </summary>
-    public OkxAnnouncementRestClient Announcement { get; }
-
     #endregion
 
     #region Constructors
@@ -160,8 +144,6 @@ public OkxRestApiClient(ILogger? logger, OkxRestApiOptions options)
         Rubik = new OkxRubikRestClient(this);
         Broker = new OkxBrokerRestClient(this);
         Affiliate = new OkxAffiliateRestClient(this);
-        Status = new OkxStatusRestClient(this);
-        Announcement = new OkxAnnouncementRestClient(this);
     }
     #endregion
 
@@ -200,8 +182,6 @@ public void SetApiCredentials(OkxApiCredentials credentials)
         Rubik.SetApiCredentials(credentials);
         Broker.SetApiCredentials(credentials);
         Affiliate.SetApiCredentials(credentials);
-        Status.SetApiCredentials(credentials);
-        Announcement.SetApiCredentials(credentials);
     }
     #endregion
 }

OKX.Api/OKXWebSocketApiClient.cs

@@ -35,11 +35,6 @@ public class OKXWebSocketApiClient : OkxBaseSocketClient
     /// </summary>
     public OkxCopyTradingSocketClient CopyTrading { get; }
 
-    /// <summary>
-    /// Alias for Public Client
-    /// </summary>
-    public OkxPublicSocketClient Market { get => Public; }
-
     /// <summary>
     /// Block Trading Client
     /// </summary>