zklighter-perps 1.0.315 → 1.0.316

package/.openapi-generator/FILES

@@ -148,6 +148,8 @@ models/PositionFundings.ts
 models/PriceAlert.ts
 models/PriceChangeAlert.ts
 models/PriceLevel.ts
+models/PriceOracleMarket.ts
+models/PriceOraclePrice.ts
 models/PublicPoolInfo.ts
 models/PublicPoolMetadata.ts
 models/PublicPoolShare.ts
@@ -216,6 +218,7 @@ models/ReqGetOrderBooks.ts
 models/ReqGetPartnerStats.ts
 models/ReqGetPnlLeaderboard.ts
 models/ReqGetPositionFunding.ts
+models/ReqGetPriceOracleInfo.ts
 models/ReqGetPublicPoolsMetadata.ts
 models/ReqGetPushNotifSettings.ts
 models/ReqGetRFQ.ts
@@ -277,6 +280,7 @@ models/RespGuildMembership.ts
 models/RespListMarketNews.ts
 models/RespListRFQs.ts
 models/RespPostApiToken.ts
+models/RespPriceOracleInfo.ts
 models/RespPublicPoolsMetadata.ts
 models/RespRegisterEventOrderBook.ts
 models/RespResolveGuildJoinRequest.ts

package/apis/InfoApi.ts

@@ -16,6 +16,7 @@
 import * as runtime from '../runtime';
 import type {
   Layer1BasicInfo,
+  RespPriceOracleInfo,
   RespRollingInfo,
   RespSyntheticSpotInfo,
   RespWithdrawalDelay,
@@ -26,6 +27,8 @@ import type {
 import {
     Layer1BasicInfoFromJSON,
     Layer1BasicInfoToJSON,
+    RespPriceOracleInfoFromJSON,
+    RespPriceOracleInfoToJSON,
     RespRollingInfoFromJSON,
     RespRollingInfoToJSON,
     RespSyntheticSpotInfoFromJSON,
@@ -40,6 +43,10 @@ import {
     TransferFeeInfoToJSON,
 } from '../models/index';
 
+export interface PriceOracleInfoRequest {
+    symbol?: string;
+}
+
 export interface RollingInfoRequest {
     symbol: string;
 }
@@ -86,6 +93,38 @@ export class InfoApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get price oracle info (source in use, median exchanges, price cap) for all markets or a single symbol
+     * priceOracleInfo
+     */
+    async priceOracleInfoRaw(requestParameters: PriceOracleInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespPriceOracleInfo>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['symbol'] != null) {
+            queryParameters['symbol'] = requestParameters['symbol'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/priceOracleInfo`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespPriceOracleInfoFromJSON(jsonValue));
+    }
+
+    /**
+     * Get price oracle info (source in use, median exchanges, price cap) for all markets or a single symbol
+     * priceOracleInfo
+     */
+    async priceOracleInfo(requestParameters: PriceOracleInfoRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespPriceOracleInfo> {
+        const response = await this.priceOracleInfoRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get rolling futures info for a symbol
      * rollingInfo

package/models/PriceOracleMarket.ts

@@ -0,0 +1,86 @@
+/* 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 { PriceOraclePrice } from './PriceOraclePrice';
+import {
+    PriceOraclePriceFromJSON,
+    PriceOraclePriceFromJSONTyped,
+    PriceOraclePriceToJSON,
+} from './PriceOraclePrice';
+
+/**
+ * 
+ * @export
+ * @interface PriceOracleMarket
+ */
+export interface PriceOracleMarket {
+    /**
+     * 
+     * @type {string}
+     * @memberof PriceOracleMarket
+     */
+    symbol: string;
+    /**
+     * 
+     * @type {PriceOraclePrice}
+     * @memberof PriceOracleMarket
+     */
+    index: PriceOraclePrice;
+    /**
+     * 
+     * @type {PriceOraclePrice}
+     * @memberof PriceOracleMarket
+     */
+    mark: PriceOraclePrice;
+}
+
+/**
+ * Check if a given object implements the PriceOracleMarket interface.
+ */
+export function instanceOfPriceOracleMarket(value: object): value is PriceOracleMarket {
+    if (!('symbol' in value) || value['symbol'] === undefined) return false;
+    if (!('index' in value) || value['index'] === undefined) return false;
+    if (!('mark' in value) || value['mark'] === undefined) return false;
+    return true;
+}
+
+export function PriceOracleMarketFromJSON(json: any): PriceOracleMarket {
+    return PriceOracleMarketFromJSONTyped(json, false);
+}
+
+export function PriceOracleMarketFromJSONTyped(json: any, ignoreDiscriminator: boolean): PriceOracleMarket {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'symbol': json['symbol'],
+        'index': PriceOraclePriceFromJSON(json['index']),
+        'mark': PriceOraclePriceFromJSON(json['mark']),
+    };
+}
+
+export function PriceOracleMarketToJSON(value?: PriceOracleMarket | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'symbol': value['symbol'],
+        'index': PriceOraclePriceToJSON(value['index']),
+        'mark': PriceOraclePriceToJSON(value['mark']),
+    };
+}
+

package/models/PriceOraclePrice.ts

@@ -0,0 +1,106 @@
+/* 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 PriceOraclePrice
+ */
+export interface PriceOraclePrice {
+    /**
+     * 
+     * @type {string}
+     * @memberof PriceOraclePrice
+     */
+    source: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PriceOraclePrice
+     */
+    using_median: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PriceOraclePrice
+     */
+    using_internal_price: boolean;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof PriceOraclePrice
+     */
+    median_sources: Array<string>;
+    /**
+     * 
+     * @type {number}
+     * @memberof PriceOraclePrice
+     */
+    price_cap_bps: number;
+    /**
+     *  cap bounds: ref * (1 -/+ bps / 10000)
+     * @type {number}
+     * @memberof PriceOraclePrice
+     */
+    price_cap_reference_price: number;
+}
+
+/**
+ * Check if a given object implements the PriceOraclePrice interface.
+ */
+export function instanceOfPriceOraclePrice(value: object): value is PriceOraclePrice {
+    if (!('source' in value) || value['source'] === undefined) return false;
+    if (!('using_median' in value) || value['using_median'] === undefined) return false;
+    if (!('using_internal_price' in value) || value['using_internal_price'] === undefined) return false;
+    if (!('median_sources' in value) || value['median_sources'] === undefined) return false;
+    if (!('price_cap_bps' in value) || value['price_cap_bps'] === undefined) return false;
+    if (!('price_cap_reference_price' in value) || value['price_cap_reference_price'] === undefined) return false;
+    return true;
+}
+
+export function PriceOraclePriceFromJSON(json: any): PriceOraclePrice {
+    return PriceOraclePriceFromJSONTyped(json, false);
+}
+
+export function PriceOraclePriceFromJSONTyped(json: any, ignoreDiscriminator: boolean): PriceOraclePrice {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'source': json['source'],
+        'using_median': json['using_median'],
+        'using_internal_price': json['using_internal_price'],
+        'median_sources': json['median_sources'],
+        'price_cap_bps': json['price_cap_bps'],
+        'price_cap_reference_price': json['price_cap_reference_price'],
+    };
+}
+
+export function PriceOraclePriceToJSON(value?: PriceOraclePrice | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'source': value['source'],
+        'using_median': value['using_median'],
+        'using_internal_price': value['using_internal_price'],
+        'median_sources': value['median_sources'],
+        'price_cap_bps': value['price_cap_bps'],
+        'price_cap_reference_price': value['price_cap_reference_price'],
+    };
+}
+

package/models/ReqGetPriceOracleInfo.ts

@@ -0,0 +1,60 @@
+/* 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 ReqGetPriceOracleInfo
+ */
+export interface ReqGetPriceOracleInfo {
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetPriceOracleInfo
+     */
+    symbol?: string;
+}
+
+/**
+ * Check if a given object implements the ReqGetPriceOracleInfo interface.
+ */
+export function instanceOfReqGetPriceOracleInfo(value: object): value is ReqGetPriceOracleInfo {
+    return true;
+}
+
+export function ReqGetPriceOracleInfoFromJSON(json: any): ReqGetPriceOracleInfo {
+    return ReqGetPriceOracleInfoFromJSONTyped(json, false);
+}
+
+export function ReqGetPriceOracleInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetPriceOracleInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'symbol': json['symbol'] == null ? undefined : json['symbol'],
+    };
+}
+
+export function ReqGetPriceOracleInfoToJSON(value?: ReqGetPriceOracleInfo | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'symbol': value['symbol'],
+    };
+}
+

package/models/RespPriceOracleInfo.ts

@@ -0,0 +1,94 @@
+/* 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 { PriceOracleMarket } from './PriceOracleMarket';
+import {
+    PriceOracleMarketFromJSON,
+    PriceOracleMarketFromJSONTyped,
+    PriceOracleMarketToJSON,
+} from './PriceOracleMarket';
+
+/**
+ * 
+ * @export
+ * @interface RespPriceOracleInfo
+ */
+export interface RespPriceOracleInfo {
+    /**
+     * 
+     * @type {number}
+     * @memberof RespPriceOracleInfo
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RespPriceOracleInfo
+     */
+    message?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RespPriceOracleInfo
+     */
+    computed_at_ms: number;
+    /**
+     * 
+     * @type {Array<PriceOracleMarket>}
+     * @memberof RespPriceOracleInfo
+     */
+    markets: Array<PriceOracleMarket>;
+}
+
+/**
+ * Check if a given object implements the RespPriceOracleInfo interface.
+ */
+export function instanceOfRespPriceOracleInfo(value: object): value is RespPriceOracleInfo {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('computed_at_ms' in value) || value['computed_at_ms'] === undefined) return false;
+    if (!('markets' in value) || value['markets'] === undefined) return false;
+    return true;
+}
+
+export function RespPriceOracleInfoFromJSON(json: any): RespPriceOracleInfo {
+    return RespPriceOracleInfoFromJSONTyped(json, false);
+}
+
+export function RespPriceOracleInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): RespPriceOracleInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'computed_at_ms': json['computed_at_ms'],
+        'markets': ((json['markets'] as Array<any>).map(PriceOracleMarketFromJSON)),
+    };
+}
+
+export function RespPriceOracleInfoToJSON(value?: RespPriceOracleInfo | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'computed_at_ms': value['computed_at_ms'],
+        'markets': ((value['markets'] as Array<any>).map(PriceOracleMarketToJSON)),
+    };
+}
+

package/models/index.ts

@@ -121,6 +121,8 @@ export * from './PositionFundings';
 export * from './PriceAlert';
 export * from './PriceChangeAlert';
 export * from './PriceLevel';
+export * from './PriceOracleMarket';
+export * from './PriceOraclePrice';
 export * from './PublicPoolInfo';
 export * from './PublicPoolMetadata';
 export * from './PublicPoolShare';
@@ -189,6 +191,7 @@ export * from './ReqGetOrderBooks';
 export * from './ReqGetPartnerStats';
 export * from './ReqGetPnlLeaderboard';
 export * from './ReqGetPositionFunding';
+export * from './ReqGetPriceOracleInfo';
 export * from './ReqGetPublicPoolsMetadata';
 export * from './ReqGetPushNotifSettings';
 export * from './ReqGetRFQ';
@@ -250,6 +253,7 @@ export * from './RespGuildMembership';
 export * from './RespListMarketNews';
 export * from './RespListRFQs';
 export * from './RespPostApiToken';
+export * from './RespPriceOracleInfo';
 export * from './RespPublicPoolsMetadata';
 export * from './RespRegisterEventOrderBook';
 export * from './RespResolveGuildJoinRequest';

package/openapi.json

@@ -4903,6 +4903,41 @@
         "description": "Get accounts position fundings"
       }
     },
+    "/api/v1/priceOracleInfo": {
+      "get": {
+        "summary": "priceOracleInfo",
+        "operationId": "priceOracleInfo",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespPriceOracleInfo"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "symbol",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "info"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get price oracle info (source in use, median exchanges, price cap) for all markets or a single symbol"
+      }
+    },
     "/api/v1/publicPoolsMetadata": {
       "get": {
         "summary": "publicPoolsMetadata",
@@ -13553,6 +13588,66 @@
         "size"
       ]
     },
+    "PriceOracleMarket": {
+      "type": "object",
+      "properties": {
+        "symbol": {
+          "type": "string"
+        },
+        "index": {
+          "$ref": "#/definitions/PriceOraclePrice"
+        },
+        "mark": {
+          "$ref": "#/definitions/PriceOraclePrice"
+        }
+      },
+      "title": "PriceOracleMarket",
+      "required": [
+        "symbol",
+        "index",
+        "mark"
+      ]
+    },
+    "PriceOraclePrice": {
+      "type": "object",
+      "properties": {
+        "source": {
+          "type": "string"
+        },
+        "using_median": {
+          "type": "boolean",
+          "format": "boolean"
+        },
+        "using_internal_price": {
+          "type": "boolean",
+          "format": "boolean"
+        },
+        "median_sources": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "price_cap_bps": {
+          "type": "number",
+          "format": "double"
+        },
+        "price_cap_reference_price": {
+          "type": "number",
+          "format": "double",
+          "description": " cap bounds: ref * (1 -/+ bps / 10000)"
+        }
+      },
+      "title": "PriceOraclePrice",
+      "required": [
+        "source",
+        "using_median",
+        "using_internal_price",
+        "median_sources",
+        "price_cap_bps",
+        "price_cap_reference_price"
+      ]
+    },
     "PublicPoolInfo": {
       "type": "object",
       "properties": {
@@ -16048,6 +16143,15 @@
         "limit"
       ]
     },
+    "ReqGetPriceOracleInfo": {
+      "type": "object",
+      "properties": {
+        "symbol": {
+          "type": "string"
+        }
+      },
+      "title": "ReqGetPriceOracleInfo"
+    },
     "ReqGetPublicPoolsMetadata": {
       "type": "object",
       "properties": {
@@ -18435,6 +18539,35 @@
         "scopes"
       ]
     },
+    "RespPriceOracleInfo": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "computed_at_ms": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "markets": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PriceOracleMarket"
+          }
+        }
+      },
+      "title": "RespPriceOracleInfo",
+      "required": [
+        "code",
+        "computed_at_ms",
+        "markets"
+      ]
+    },
     "RespPublicPoolsMetadata": {
       "type": "object",
       "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.315",
+  "version": "1.0.316",
   "description": "Lighter Perps SDK",
   "main": "index.ts",
   "directories": {