From bb4199620e573f93b871f712b5bf49623c447dcb Mon Sep 17 00:00:00 2001 From: JKorf Date: Wed, 26 Jun 2024 15:33:31 +0200 Subject: [PATCH] Added caching docs --- docs/index.html | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/index.html b/docs/index.html index 9a19813..9b48b13 100644 --- a/docs/index.html +++ b/docs/index.html @@ -100,6 +100,7 @@
  • Orderbooks
  • Logging
  • Ratelimiting
    • +
  • Caching
  • Examples @@ -1956,6 +1957,16 @@ var client = new OKXRestClient(); The interval of how often the time synchronization between client and server should be executed TimeSpan.FromHours(1) + + CachingEnabled + Whether or not client side caching should be enabled for GET requests, see Caching + false + + + CachingMaxAge + The max age of data to return from the cache. If the same data is requested and the data is available in the client side cache and not older than this value the cached value is returned, else a new request will be done + TimeSpan.FromSeconds(5) + [API].ApiCredentials Same as the in the base options, allows overriding per sub-API @@ -2474,6 +2485,30 @@ var binanceClient = new BinanceRestClient(new HttpClient(), logFactory, options + + +
    +

    Caching

    +

    + Every REST API client based on the CryptoExchange.Net base library automatically supports caching of GET HTTP requests. A few advantages of caching: +

      +
    1. Performance improvement, data response will be much faster as no roundtrip to the server is needed
      2. +
    2. Reduced resource usage, returning data from the cache uses less resources than reading the server response, though there is some memory overhead
      3. +
    3. Prevent rate limiting, the cache can be queried as many times as you like without having to worry about getting rate limited by the server
      4. +
    + +
    Caching is only applied for successful GET requests as GET requests by definition should not change state. Other HTTP method (POST, DELETE, etc) generally do change state, so caching those call would prevent an action being executed.
    + +

    +

    + To enable caching for GET requests set CachingEnabled to true in the client options. Optionally set the CachingMaxAge option to the desired value (default is 5 seconds). +

    +

    + To determine whether a request has gotten the data from the server or from the local cache the DataSource property on the call result can inspected: + 

    var result = await bitfinexRestClient.SpotApi.Account.Get30DaySummaryAndFeesAsync();
+var responseSource = result.DataSource;
    +

    +