zklighter-perps 1.0.103 → 1.0.104

package/.openapi-generator/FILES

@@ -3,6 +3,7 @@ apis/AnnouncementApi.ts
 apis/BlockApi.ts
 apis/BridgeApi.ts
 apis/CandlestickApi.ts
+apis/FundingApi.ts
 apis/InfoApi.ts
 apis/NotificationApi.ts
 apis/OrderApi.ts
@@ -44,6 +45,8 @@ models/EnrichedTx.ts
 models/ExchangeStats.ts
 models/FeeBucket.ts
 models/Funding.ts
+models/FundingRate.ts
+models/FundingRates.ts
 models/Fundings.ts
 models/IsWhitelisted.ts
 models/L1ProviderInfo.ts

package/apis/FundingApi.ts

@@ -0,0 +1,61 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  FundingRates,
+  ResultCode,
+} from '../models/index';
+import {
+    FundingRatesFromJSON,
+    FundingRatesToJSON,
+    ResultCodeFromJSON,
+    ResultCodeToJSON,
+} from '../models/index';
+
+/**
+ * 
+ */
+export class FundingApi extends runtime.BaseAPI {
+
+    /**
+     * Get funding rates
+     * funding-rates
+     */
+    async fundingRatesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FundingRates>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/funding-rates`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FundingRatesFromJSON(jsonValue));
+    }
+
+    /**
+     * Get funding rates
+     * funding-rates
+     */
+    async fundingRates(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FundingRates> {
+        const response = await this.fundingRatesRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/index.ts

@@ -5,6 +5,7 @@ export * from './AnnouncementApi';
 export * from './BlockApi';
 export * from './BridgeApi';
 export * from './CandlestickApi';
+export * from './FundingApi';
 export * from './InfoApi';
 export * from './NotificationApi';
 export * from './OrderApi';

package/models/FundingRate.ts

@@ -0,0 +1,79 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface FundingRate
+ */
+export interface FundingRate {
+    /**
+     * 
+     * @type {string}
+     * @memberof FundingRate
+     */
+    exchange: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FundingRate
+     */
+    symbol: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof FundingRate
+     */
+    rate: number;
+}
+
+/**
+ * Check if a given object implements the FundingRate interface.
+ */
+export function instanceOfFundingRate(value: object): value is FundingRate {
+    if (!('exchange' in value) || value['exchange'] === undefined) return false;
+    if (!('symbol' in value) || value['symbol'] === undefined) return false;
+    if (!('rate' in value) || value['rate'] === undefined) return false;
+    return true;
+}
+
+export function FundingRateFromJSON(json: any): FundingRate {
+    return FundingRateFromJSONTyped(json, false);
+}
+
+export function FundingRateFromJSONTyped(json: any, ignoreDiscriminator: boolean): FundingRate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'exchange': json['exchange'],
+        'symbol': json['symbol'],
+        'rate': json['rate'],
+    };
+}
+
+export function FundingRateToJSON(value?: FundingRate | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'exchange': value['exchange'],
+        'symbol': value['symbol'],
+        'rate': value['rate'],
+    };
+}
+

package/models/FundingRates.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { FundingRate } from './FundingRate';
+import {
+    FundingRateFromJSON,
+    FundingRateFromJSONTyped,
+    FundingRateToJSON,
+} from './FundingRate';
+
+/**
+ * 
+ * @export
+ * @interface FundingRates
+ */
+export interface FundingRates {
+    /**
+     * 
+     * @type {number}
+     * @memberof FundingRates
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof FundingRates
+     */
+    message?: string;
+    /**
+     * 
+     * @type {Array<FundingRate>}
+     * @memberof FundingRates
+     */
+    funding_rates: Array<FundingRate>;
+}
+
+/**
+ * Check if a given object implements the FundingRates interface.
+ */
+export function instanceOfFundingRates(value: object): value is FundingRates {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('funding_rates' in value) || value['funding_rates'] === undefined) return false;
+    return true;
+}
+
+export function FundingRatesFromJSON(json: any): FundingRates {
+    return FundingRatesFromJSONTyped(json, false);
+}
+
+export function FundingRatesFromJSONTyped(json: any, ignoreDiscriminator: boolean): FundingRates {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'funding_rates': ((json['funding_rates'] as Array<any>).map(FundingRateFromJSON)),
+    };
+}
+
+export function FundingRatesToJSON(value?: FundingRates | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'funding_rates': ((value['funding_rates'] as Array<any>).map(FundingRateToJSON)),
+    };
+}
+

package/models/index.ts

@@ -33,6 +33,8 @@ export * from './EnrichedTx';
 export * from './ExchangeStats';
 export * from './FeeBucket';
 export * from './Funding';
+export * from './FundingRate';
+export * from './FundingRates';
 export * from './Fundings';
 export * from './IsWhitelisted';
 export * from './L1ProviderInfo';

package/openapi.json

@@ -1161,6 +1161,30 @@
         "description": "Get account fee bucket"
       }
     },
+    "/api/v1/funding-rates": {
+      "get": {
+        "summary": "funding-rates",
+        "operationId": "funding-rates",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/FundingRates"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "tags": [
+          "funding"
+        ],
+        "description": "Get funding rates"
+      }
+    },
     "/api/v1/fundings": {
       "get": {
         "summary": "fundings",
@@ -3812,6 +3836,51 @@
         "direction"
       ]
     },
+    "FundingRate": {
+      "type": "object",
+      "properties": {
+        "exchange": {
+          "type": "string"
+        },
+        "symbol": {
+          "type": "string"
+        },
+        "rate": {
+          "type": "number",
+          "format": "double"
+        }
+      },
+      "title": "FundingRate",
+      "required": [
+        "exchange",
+        "symbol",
+        "rate"
+      ]
+    },
+    "FundingRates": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "funding_rates": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/FundingRate"
+          }
+        }
+      },
+      "title": "FundingRates",
+      "required": [
+        "code",
+        "funding_rates"
+      ]
+    },
     "Fundings": {
       "type": "object",
       "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.103",
+  "version": "1.0.104",
   "description": "zkLighter Perps SDK",
   "main": "index.ts",
   "directories": {