zklighter-perps 1.0.347 → 1.0.348

package/.openapi-generator/FILES

@@ -61,6 +61,10 @@ models/AssetStats.ts
 models/AtomicOrder.ts
 models/AtomicOrderLeg.ts
 models/Auth.ts
+models/BOSideCost.ts
+models/BOSizeCost.ts
+models/BOSymbolCosts.ts
+models/BOVenueCosts.ts
 models/BinaryOptionMarketStats.ts
 models/Block.ts
 models/Blocks.ts
@@ -287,6 +291,7 @@ models/RespCreateRFQ.ts
 models/RespCreateStrategyHeartbeat.ts
 models/RespGaslessDeposit.ts
 models/RespGetApiTokens.ts
+models/RespGetBOExecuteStats.ts
 models/RespGetBoPnL.ts
 models/RespGetBridgesByL1Addr.ts
 models/RespGetCompetitions.ts

package/apis/OrderApi.ts

@@ -24,6 +24,7 @@ import type {
   OrderBookOrders,
   OrderBooks,
   Orders,
+  RespGetBOExecuteStats,
   RespGetExchangeMetrics,
   RespGetExecuteStats,
   RespGetMarketMetrics,
@@ -49,6 +50,8 @@ import {
     OrderBooksToJSON,
     OrdersFromJSON,
     OrdersToJSON,
+    RespGetBOExecuteStatsFromJSON,
+    RespGetBOExecuteStatsToJSON,
     RespGetExchangeMetricsFromJSON,
     RespGetExchangeMetricsToJSON,
     RespGetExecuteStatsFromJSON,
@@ -552,6 +555,34 @@ export class OrderApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get the mean cost of buying Up and Down on the 15-minute BTC and ETH Up/Down rounds over the last day, per venue and size
+     * boExecuteStats
+     */
+    async boExecuteStatsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespGetBOExecuteStats>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/boExecuteStats`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespGetBOExecuteStatsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the mean cost of buying Up and Down on the 15-minute BTC and ETH Up/Down rounds over the last day, per venue and size
+     * boExecuteStats
+     */
+    async boExecuteStats(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespGetBOExecuteStats> {
+        const response = await this.boExecuteStatsRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get exchange metrics
      * exchangeMetrics

package/models/BOSideCost.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 BOSideCost
+ */
+export interface BOSideCost {
+    /**
+     *  average price per share, in dollars
+     * @type {number}
+     * @memberof BOSideCost
+     */
+    avg_price: number;
+    /**
+     *  cents per share over the mid (for Down, over 1 - mid)
+     * @type {number}
+     * @memberof BOSideCost
+     */
+    slippage_c: number;
+    /**
+     *  taker fee, cents per share
+     * @type {number}
+     * @memberof BOSideCost
+     */
+    fee_c: number;
+}
+
+/**
+ * Check if a given object implements the BOSideCost interface.
+ */
+export function instanceOfBOSideCost(value: object): value is BOSideCost {
+    if (!('avg_price' in value) || value['avg_price'] === undefined) return false;
+    if (!('slippage_c' in value) || value['slippage_c'] === undefined) return false;
+    if (!('fee_c' in value) || value['fee_c'] === undefined) return false;
+    return true;
+}
+
+export function BOSideCostFromJSON(json: any): BOSideCost {
+    return BOSideCostFromJSONTyped(json, false);
+}
+
+export function BOSideCostFromJSONTyped(json: any, ignoreDiscriminator: boolean): BOSideCost {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'avg_price': json['avg_price'],
+        'slippage_c': json['slippage_c'],
+        'fee_c': json['fee_c'],
+    };
+}
+
+export function BOSideCostToJSON(value?: BOSideCost | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'avg_price': value['avg_price'],
+        'slippage_c': value['slippage_c'],
+        'fee_c': value['fee_c'],
+    };
+}
+

package/models/BOSizeCost.ts

@@ -0,0 +1,140 @@
+/* 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 { BOSideCost } from './BOSideCost';
+import {
+    BOSideCostFromJSON,
+    BOSideCostFromJSONTyped,
+    BOSideCostToJSON,
+} from './BOSideCost';
+
+/**
+ * 
+ * @export
+ * @interface BOSizeCost
+ */
+export interface BOSizeCost {
+    /**
+     * 
+     * @type {number}
+     * @memberof BOSizeCost
+     */
+    size_usd: number;
+    /**
+     *  ok, or not_enough_data: too few samples, show N/A
+     * @type {string}
+     * @memberof BOSizeCost
+     */
+    status: string;
+    /**
+     *  30s samples averaged: every served venue was valid at that moment
+     * @type {number}
+     * @memberof BOSizeCost
+     */
+    samples: number;
+    /**
+     *  share of the venue's in-band samples where the size filled; null without any
+     * @type {number}
+     * @memberof BOSizeCost
+     */
+    fill_rate: number;
+    /**
+     * 
+     * @type {BOSideCost}
+     * @memberof BOSizeCost
+     */
+    up: BOSideCost;
+    /**
+     * 
+     * @type {BOSideCost}
+     * @memberof BOSizeCost
+     */
+    down: BOSideCost;
+    /**
+     *  cents per share, Up and Down averaged
+     * @type {number}
+     * @memberof BOSizeCost
+     */
+    total_c: number;
+    /**
+     *  % of the price paid, Up and Down averaged
+     * @type {number}
+     * @memberof BOSizeCost
+     */
+    total_pct: number;
+    /**
+     *  size_usd * total_pct / 100
+     * @type {number}
+     * @memberof BOSizeCost
+     */
+    cost_usd: number;
+}
+
+/**
+ * Check if a given object implements the BOSizeCost interface.
+ */
+export function instanceOfBOSizeCost(value: object): value is BOSizeCost {
+    if (!('size_usd' in value) || value['size_usd'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('samples' in value) || value['samples'] === undefined) return false;
+    if (!('fill_rate' in value) || value['fill_rate'] === undefined) return false;
+    if (!('up' in value) || value['up'] === undefined) return false;
+    if (!('down' in value) || value['down'] === undefined) return false;
+    if (!('total_c' in value) || value['total_c'] === undefined) return false;
+    if (!('total_pct' in value) || value['total_pct'] === undefined) return false;
+    if (!('cost_usd' in value) || value['cost_usd'] === undefined) return false;
+    return true;
+}
+
+export function BOSizeCostFromJSON(json: any): BOSizeCost {
+    return BOSizeCostFromJSONTyped(json, false);
+}
+
+export function BOSizeCostFromJSONTyped(json: any, ignoreDiscriminator: boolean): BOSizeCost {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'size_usd': json['size_usd'],
+        'status': json['status'],
+        'samples': json['samples'],
+        'fill_rate': json['fill_rate'],
+        'up': BOSideCostFromJSON(json['up']),
+        'down': BOSideCostFromJSON(json['down']),
+        'total_c': json['total_c'],
+        'total_pct': json['total_pct'],
+        'cost_usd': json['cost_usd'],
+    };
+}
+
+export function BOSizeCostToJSON(value?: BOSizeCost | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'size_usd': value['size_usd'],
+        'status': value['status'],
+        'samples': value['samples'],
+        'fill_rate': value['fill_rate'],
+        'up': BOSideCostToJSON(value['up']),
+        'down': BOSideCostToJSON(value['down']),
+        'total_c': value['total_c'],
+        'total_pct': value['total_pct'],
+        'cost_usd': value['cost_usd'],
+    };
+}
+

package/models/BOSymbolCosts.ts

@@ -0,0 +1,77 @@
+/* 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 { BOVenueCosts } from './BOVenueCosts';
+import {
+    BOVenueCostsFromJSON,
+    BOVenueCostsFromJSONTyped,
+    BOVenueCostsToJSON,
+} from './BOVenueCosts';
+
+/**
+ * 
+ * @export
+ * @interface BOSymbolCosts
+ */
+export interface BOSymbolCosts {
+    /**
+     * 
+     * @type {string}
+     * @memberof BOSymbolCosts
+     */
+    symbol: string;
+    /**
+     * 
+     * @type {Array<BOVenueCosts>}
+     * @memberof BOSymbolCosts
+     */
+    venues: Array<BOVenueCosts>;
+}
+
+/**
+ * Check if a given object implements the BOSymbolCosts interface.
+ */
+export function instanceOfBOSymbolCosts(value: object): value is BOSymbolCosts {
+    if (!('symbol' in value) || value['symbol'] === undefined) return false;
+    if (!('venues' in value) || value['venues'] === undefined) return false;
+    return true;
+}
+
+export function BOSymbolCostsFromJSON(json: any): BOSymbolCosts {
+    return BOSymbolCostsFromJSONTyped(json, false);
+}
+
+export function BOSymbolCostsFromJSONTyped(json: any, ignoreDiscriminator: boolean): BOSymbolCosts {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'symbol': json['symbol'],
+        'venues': ((json['venues'] as Array<any>).map(BOVenueCostsFromJSON)),
+    };
+}
+
+export function BOSymbolCostsToJSON(value?: BOSymbolCosts | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'symbol': value['symbol'],
+        'venues': ((value['venues'] as Array<any>).map(BOVenueCostsToJSON)),
+    };
+}
+

package/models/BOVenueCosts.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 { BOSizeCost } from './BOSizeCost';
+import {
+    BOSizeCostFromJSON,
+    BOSizeCostFromJSONTyped,
+    BOSizeCostToJSON,
+} from './BOSizeCost';
+
+/**
+ * 
+ * @export
+ * @interface BOVenueCosts
+ */
+export interface BOVenueCosts {
+    /**
+     * 
+     * @type {string}
+     * @memberof BOVenueCosts
+     */
+    venue: string;
+    /**
+     *  start_price, or fixed_threshold (Hyperliquid: not the same contract)
+     * @type {string}
+     * @memberof BOVenueCosts
+     */
+    strike_type: string;
+    /**
+     * 
+     * @type {Array<BOSizeCost>}
+     * @memberof BOVenueCosts
+     */
+    sizes: Array<BOSizeCost>;
+}
+
+/**
+ * Check if a given object implements the BOVenueCosts interface.
+ */
+export function instanceOfBOVenueCosts(value: object): value is BOVenueCosts {
+    if (!('venue' in value) || value['venue'] === undefined) return false;
+    if (!('strike_type' in value) || value['strike_type'] === undefined) return false;
+    if (!('sizes' in value) || value['sizes'] === undefined) return false;
+    return true;
+}
+
+export function BOVenueCostsFromJSON(json: any): BOVenueCosts {
+    return BOVenueCostsFromJSONTyped(json, false);
+}
+
+export function BOVenueCostsFromJSONTyped(json: any, ignoreDiscriminator: boolean): BOVenueCosts {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'venue': json['venue'],
+        'strike_type': json['strike_type'],
+        'sizes': ((json['sizes'] as Array<any>).map(BOSizeCostFromJSON)),
+    };
+}
+
+export function BOVenueCostsToJSON(value?: BOVenueCosts | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'venue': value['venue'],
+        'strike_type': value['strike_type'],
+        'sizes': ((value['sizes'] as Array<any>).map(BOSizeCostToJSON)),
+    };
+}
+

package/models/RespGetBOExecuteStats.ts

@@ -0,0 +1,95 @@
+/* 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 { BOSymbolCosts } from './BOSymbolCosts';
+import {
+    BOSymbolCostsFromJSON,
+    BOSymbolCostsFromJSONTyped,
+    BOSymbolCostsToJSON,
+} from './BOSymbolCosts';
+
+/**
+ * 
+ * @export
+ * @interface RespGetBOExecuteStats
+ */
+export interface RespGetBOExecuteStats {
+    /**
+     *  start of the first round averaged
+     * @type {number}
+     * @memberof RespGetBOExecuteStats
+     */
+    window_start: number;
+    /**
+     *  end of the last completed round
+     * @type {number}
+     * @memberof RespGetBOExecuteStats
+     */
+    window_end: number;
+    /**
+     *  rounds with data in the window
+     * @type {number}
+     * @memberof RespGetBOExecuteStats
+     */
+    rounds: number;
+    /**
+     * 
+     * @type {Array<BOSymbolCosts>}
+     * @memberof RespGetBOExecuteStats
+     */
+    symbols: Array<BOSymbolCosts>;
+}
+
+/**
+ * Check if a given object implements the RespGetBOExecuteStats interface.
+ */
+export function instanceOfRespGetBOExecuteStats(value: object): value is RespGetBOExecuteStats {
+    if (!('window_start' in value) || value['window_start'] === undefined) return false;
+    if (!('window_end' in value) || value['window_end'] === undefined) return false;
+    if (!('rounds' in value) || value['rounds'] === undefined) return false;
+    if (!('symbols' in value) || value['symbols'] === undefined) return false;
+    return true;
+}
+
+export function RespGetBOExecuteStatsFromJSON(json: any): RespGetBOExecuteStats {
+    return RespGetBOExecuteStatsFromJSONTyped(json, false);
+}
+
+export function RespGetBOExecuteStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): RespGetBOExecuteStats {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'window_start': json['window_start'],
+        'window_end': json['window_end'],
+        'rounds': json['rounds'],
+        'symbols': ((json['symbols'] as Array<any>).map(BOSymbolCostsFromJSON)),
+    };
+}
+
+export function RespGetBOExecuteStatsToJSON(value?: RespGetBOExecuteStats | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'window_start': value['window_start'],
+        'window_end': value['window_end'],
+        'rounds': value['rounds'],
+        'symbols': ((value['symbols'] as Array<any>).map(BOSymbolCostsToJSON)),
+    };
+}
+

package/models/index.ts

@@ -32,6 +32,10 @@ export * from './AssetStats';
 export * from './AtomicOrder';
 export * from './AtomicOrderLeg';
 export * from './Auth';
+export * from './BOSideCost';
+export * from './BOSizeCost';
+export * from './BOSymbolCosts';
+export * from './BOVenueCosts';
 export * from './BinaryOptionMarketStats';
 export * from './Block';
 export * from './Blocks';
@@ -258,6 +262,7 @@ export * from './RespCreateRFQ';
 export * from './RespCreateStrategyHeartbeat';
 export * from './RespGaslessDeposit';
 export * from './RespGetApiTokens';
+export * from './RespGetBOExecuteStats';
 export * from './RespGetBoPnL';
 export * from './RespGetBridgesByL1Addr';
 export * from './RespGetCompetitions';

package/openapi.json

@@ -1224,6 +1224,30 @@
         "description": "Get blocks"
       }
     },
+    "/api/v1/boExecuteStats": {
+      "get": {
+        "summary": "boExecuteStats",
+        "operationId": "boExecuteStats",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespGetBOExecuteStats"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "tags": [
+          "order"
+        ],
+        "description": "Get the mean cost of buying Up and Down on the 15-minute BTC and ETH Up/Down rounds over the last day, per venue and size"
+      }
+    },
     "/api/v1/bridges": {
       "get": {
         "summary": "bridges",
@@ -9921,6 +9945,145 @@
         "auth"
       ]
     },
+    "BOSideCost": {
+      "type": "object",
+      "properties": {
+        "avg_price": {
+          "type": "number",
+          "format": "double",
+          "example": "0.512",
+          "description": " average price per share, in dollars"
+        },
+        "slippage_c": {
+          "type": "number",
+          "format": "double",
+          "example": "0.7",
+          "description": " cents per share over the mid (for Down, over 1 - mid)"
+        },
+        "fee_c": {
+          "type": "number",
+          "format": "double",
+          "example": "0.25",
+          "description": " taker fee, cents per share"
+        }
+      },
+      "title": "BOSideCost",
+      "required": [
+        "avg_price",
+        "slippage_c",
+        "fee_c"
+      ]
+    },
+    "BOSizeCost": {
+      "type": "object",
+      "properties": {
+        "size_usd": {
+          "type": "integer",
+          "format": "int64",
+          "example": "100"
+        },
+        "status": {
+          "type": "string",
+          "example": "ok",
+          "description": " ok, or not_enough_data: too few samples, show N/A"
+        },
+        "samples": {
+          "type": "integer",
+          "format": "int64",
+          "example": "2841",
+          "description": " 30s samples averaged: every served venue was valid at that moment"
+        },
+        "fill_rate": {
+          "type": "number",
+          "format": "double",
+          "example": "0.97",
+          "description": " share of the venue's in-band samples where the size filled; null without any"
+        },
+        "up": {
+          "$ref": "#/definitions/BOSideCost",
+          "description": " mean over the samples; null unless status is ok"
+        },
+        "down": {
+          "$ref": "#/definitions/BOSideCost"
+        },
+        "total_c": {
+          "type": "number",
+          "format": "double",
+          "example": "0.75",
+          "description": " cents per share, Up and Down averaged"
+        },
+        "total_pct": {
+          "type": "number",
+          "format": "double",
+          "example": "1.47",
+          "description": " % of the price paid, Up and Down averaged"
+        },
+        "cost_usd": {
+          "type": "number",
+          "format": "double",
+          "example": "1.47",
+          "description": " size_usd * total_pct / 100"
+        }
+      },
+      "title": "BOSizeCost",
+      "required": [
+        "size_usd",
+        "status",
+        "samples",
+        "fill_rate",
+        "up",
+        "down",
+        "total_c",
+        "total_pct",
+        "cost_usd"
+      ]
+    },
+    "BOSymbolCosts": {
+      "type": "object",
+      "properties": {
+        "symbol": {
+          "type": "string",
+          "example": "btc"
+        },
+        "venues": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/BOVenueCosts"
+          }
+        }
+      },
+      "title": "BOSymbolCosts",
+      "required": [
+        "symbol",
+        "venues"
+      ]
+    },
+    "BOVenueCosts": {
+      "type": "object",
+      "properties": {
+        "venue": {
+          "type": "string",
+          "example": "lighter"
+        },
+        "strike_type": {
+          "type": "string",
+          "example": "start_price",
+          "description": " start_price, or fixed_threshold (Hyperliquid: not the same contract)"
+        },
+        "sizes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/BOSizeCost"
+          }
+        }
+      },
+      "title": "BOVenueCosts",
+      "required": [
+        "venue",
+        "strike_type",
+        "sizes"
+      ]
+    },
     "BinaryOptionMarketStats": {
       "type": "object",
       "properties": {
@@ -20768,6 +20931,42 @@
         "api_tokens"
       ]
     },
+    "RespGetBOExecuteStats": {
+      "type": "object",
+      "properties": {
+        "window_start": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1792674000000",
+          "description": " start of the first round averaged"
+        },
+        "window_end": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1792760400000",
+          "description": " end of the last completed round"
+        },
+        "rounds": {
+          "type": "integer",
+          "format": "int64",
+          "example": "96",
+          "description": " rounds with data in the window"
+        },
+        "symbols": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/BOSymbolCosts"
+          }
+        }
+      },
+      "title": "RespGetBOExecuteStats",
+      "required": [
+        "window_start",
+        "window_end",
+        "rounds",
+        "symbols"
+      ]
+    },
     "RespGetBoPnL": {
       "type": "object",
       "properties": {

package/package.json

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