Merge pull request #160 from tiagosiebler/historicbills

feat(v3.0.12): add endpoint for fetching bills older than 30 days

Author: tiagosiebler

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "okx-api",
-  "version": "3.0.11",
+  "version": "3.0.12",
   "description": "Complete Node.js SDK for OKX's REST APIs and WebSockets, with TypeScript & end-to-end tests",
   "scripts": {
     "test": "jest",

package.json

@@ -2395,6 +2395,9 @@ export class RestClient extends BaseRestClient {
     return this.getPrivate('/api/v5/asset/transfer-state', params);
   }
 
+  /**
+   * Query the billing record in the past month.
+   */
   getAssetBillsDetails(params?: {
     ccy?: string;
     type?: `${ASSET_BILL_TYPE}`;
@@ -2406,6 +2409,27 @@ export class RestClient extends BaseRestClient {
     return this.getPrivate('/api/v5/asset/bills', params);
   }
 
+  /**
+   * Query the billing records of all time since 1 February, 2021.
+   *
+   *  ⚠️ IMPORTANT: Data updates occur every 30 seconds. Update frequency may vary based on data volume - please be aware of potential delays during high-traffic periods.
+   *
+   * Rate Limit: 1 Requests per second
+   * @param params
+   * @returns
+   */
+  getAssetBillsHistoric(params?: {
+    ccy?: string;
+    type?: `${ASSET_BILL_TYPE}`;
+    clientId?: string;
+    after?: numberInString;
+    before?: numberInString;
+    limit?: numberInString;
+    pagingType?: '0' | '1';
+  }): Promise<AssetBillDetails[]> {
+    return this.getPrivate('/api/v5/asset/bills-history', params);
+  }
+
   getLightningDeposits(params: {
     ccy: string;
     amt: numberInString;

src/rest-client.ts

@@ -80,6 +80,7 @@ export interface AssetBillDetails {
   balChg: string;
   bal: string;
   type: `${ASSET_BILL_TYPE}`;
+  notes: string;
   ts: string;
 }