zklighter-perps 1.0.194 → 1.0.196

package/.openapi-generator/FILES

@@ -58,6 +58,7 @@ models/DetailedCandlestick.ts
 models/EnrichedTx.ts
 models/ExchangeMetric.ts
 models/ExchangeStats.ts
+models/ExecuteStat.ts
 models/ExportData.ts
 models/Funding.ts
 models/FundingRate.ts
@@ -123,6 +124,7 @@ models/ReqGetCandles.ts
 models/ReqGetCandlesticks.ts
 models/ReqGetDepositHistory.ts
 models/ReqGetExchangeMetrics.ts
+models/ReqGetExecuteStats.ts
 models/ReqGetFastWithdrawInfo.ts
 models/ReqGetFundings.ts
 models/ReqGetGeckoOrderbook.ts
@@ -153,6 +155,7 @@ models/RespChangeAccountTier.ts
 models/RespGetApiTokens.ts
 models/RespGetBridgesByL1Addr.ts
 models/RespGetExchangeMetrics.ts
+models/RespGetExecuteStats.ts
 models/RespGetFastBridgeInfo.ts
 models/RespGetFastwithdrawalInfo.ts
 models/RespGetIsNextBridgeFast.ts
@@ -169,6 +172,7 @@ models/RiskInfo.ts
 models/RiskParameters.ts
 models/SharePrice.ts
 models/SimpleOrder.ts
+models/SlippageResult.ts
 models/SpotMarketStats.ts
 models/SpotOrderBookDetail.ts
 models/Status.ts

package/apis/OrderApi.ts

@@ -23,6 +23,7 @@ import type {
   OrderBooks,
   Orders,
   RespGetExchangeMetrics,
+  RespGetExecuteStats,
   ResultCode,
   Trades,
 } from '../models/index';
@@ -43,6 +44,8 @@ import {
     OrdersToJSON,
     RespGetExchangeMetricsFromJSON,
     RespGetExchangeMetricsToJSON,
+    RespGetExecuteStatsFromJSON,
+    RespGetExecuteStatsToJSON,
     ResultCodeFromJSON,
     ResultCodeToJSON,
     TradesFromJSON,
@@ -86,6 +89,10 @@ export interface ExchangeMetricsRequest {
     value?: string;
 }
 
+export interface ExecuteStatsRequest {
+    period: ExecuteStatsPeriodEnum;
+}
+
 export interface OrderBookDetailsRequest {
     market_id?: number;
     filter?: OrderBookDetailsFilterEnum;
@@ -433,6 +440,45 @@ export class OrderApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get execute stats
+     * executeStats
+     */
+    async executeStatsRaw(requestParameters: ExecuteStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespGetExecuteStats>> {
+        if (requestParameters['period'] == null) {
+            throw new runtime.RequiredError(
+                'period',
+                'Required parameter "period" was null or undefined when calling executeStats().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['period'] != null) {
+            queryParameters['period'] = requestParameters['period'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/executeStats`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespGetExecuteStatsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get execute stats
+     * executeStats
+     */
+    async executeStats(requestParameters: ExecuteStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespGetExecuteStats> {
+        const response = await this.executeStatsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get order books metadata
      * orderBookDetails
@@ -751,6 +797,18 @@ export const ExchangeMetricsFilterEnum = {
     ByMarket: 'byMarket'
 } as const;
 export type ExchangeMetricsFilterEnum = typeof ExchangeMetricsFilterEnum[keyof typeof ExchangeMetricsFilterEnum];
+/**
+ * @export
+ */
+export const ExecuteStatsPeriodEnum = {
+    D: 'd',
+    W: 'w',
+    M: 'm',
+    Q: 'q',
+    Y: 'y',
+    All: 'all'
+} as const;
+export type ExecuteStatsPeriodEnum = typeof ExecuteStatsPeriodEnum[keyof typeof ExecuteStatsPeriodEnum];
 /**
  * @export
  */

package/models/ExecuteStat.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 { SlippageResult } from './SlippageResult';
+import {
+    SlippageResultFromJSON,
+    SlippageResultFromJSONTyped,
+    SlippageResultToJSON,
+} from './SlippageResult';
+
+/**
+ * 
+ * @export
+ * @interface ExecuteStat
+ */
+export interface ExecuteStat {
+    /**
+     * 
+     * @type {number}
+     * @memberof ExecuteStat
+     */
+    timestamp: number;
+    /**
+     * 
+     * @type {Array<SlippageResult>}
+     * @memberof ExecuteStat
+     */
+    slippage: Array<SlippageResult>;
+}
+
+/**
+ * Check if a given object implements the ExecuteStat interface.
+ */
+export function instanceOfExecuteStat(value: object): value is ExecuteStat {
+    if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
+    if (!('slippage' in value) || value['slippage'] === undefined) return false;
+    return true;
+}
+
+export function ExecuteStatFromJSON(json: any): ExecuteStat {
+    return ExecuteStatFromJSONTyped(json, false);
+}
+
+export function ExecuteStatFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExecuteStat {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'timestamp': json['timestamp'],
+        'slippage': ((json['slippage'] as Array<any>).map(SlippageResultFromJSON)),
+    };
+}
+
+export function ExecuteStatToJSON(value?: ExecuteStat | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'timestamp': value['timestamp'],
+        'slippage': ((value['slippage'] as Array<any>).map(SlippageResultToJSON)),
+    };
+}
+

package/models/ReqGetExecuteStats.ts

@@ -0,0 +1,76 @@
+/* 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 ReqGetExecuteStats
+ */
+export interface ReqGetExecuteStats {
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetExecuteStats
+     */
+    period: ReqGetExecuteStatsPeriodEnum;
+}
+
+
+/**
+ * @export
+ */
+export const ReqGetExecuteStatsPeriodEnum = {
+    D: 'd',
+    W: 'w',
+    M: 'm',
+    Q: 'q',
+    Y: 'y',
+    All: 'all'
+} as const;
+export type ReqGetExecuteStatsPeriodEnum = typeof ReqGetExecuteStatsPeriodEnum[keyof typeof ReqGetExecuteStatsPeriodEnum];
+
+
+/**
+ * Check if a given object implements the ReqGetExecuteStats interface.
+ */
+export function instanceOfReqGetExecuteStats(value: object): value is ReqGetExecuteStats {
+    if (!('period' in value) || value['period'] === undefined) return false;
+    return true;
+}
+
+export function ReqGetExecuteStatsFromJSON(json: any): ReqGetExecuteStats {
+    return ReqGetExecuteStatsFromJSONTyped(json, false);
+}
+
+export function ReqGetExecuteStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetExecuteStats {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'period': json['period'],
+    };
+}
+
+export function ReqGetExecuteStatsToJSON(value?: ReqGetExecuteStats | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'period': value['period'],
+    };
+}
+

package/models/RespGetExecuteStats.ts

@@ -0,0 +1,92 @@
+/* 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 { ExecuteStat } from './ExecuteStat';
+import {
+    ExecuteStatFromJSON,
+    ExecuteStatFromJSONTyped,
+    ExecuteStatToJSON,
+} from './ExecuteStat';
+
+/**
+ * 
+ * @export
+ * @interface RespGetExecuteStats
+ */
+export interface RespGetExecuteStats {
+    /**
+     * 
+     * @type {string}
+     * @memberof RespGetExecuteStats
+     */
+    period: RespGetExecuteStatsPeriodEnum;
+    /**
+     * 
+     * @type {Array<ExecuteStat>}
+     * @memberof RespGetExecuteStats
+     */
+    result: Array<ExecuteStat>;
+}
+
+
+/**
+ * @export
+ */
+export const RespGetExecuteStatsPeriodEnum = {
+    D: 'd',
+    W: 'w',
+    M: 'm',
+    Q: 'q',
+    Y: 'y',
+    All: 'all'
+} as const;
+export type RespGetExecuteStatsPeriodEnum = typeof RespGetExecuteStatsPeriodEnum[keyof typeof RespGetExecuteStatsPeriodEnum];
+
+
+/**
+ * Check if a given object implements the RespGetExecuteStats interface.
+ */
+export function instanceOfRespGetExecuteStats(value: object): value is RespGetExecuteStats {
+    if (!('period' in value) || value['period'] === undefined) return false;
+    if (!('result' in value) || value['result'] === undefined) return false;
+    return true;
+}
+
+export function RespGetExecuteStatsFromJSON(json: any): RespGetExecuteStats {
+    return RespGetExecuteStatsFromJSONTyped(json, false);
+}
+
+export function RespGetExecuteStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): RespGetExecuteStats {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'period': json['period'],
+        'result': ((json['result'] as Array<any>).map(ExecuteStatFromJSON)),
+    };
+}
+
+export function RespGetExecuteStatsToJSON(value?: RespGetExecuteStats | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'period': value['period'],
+        'result': ((value['result'] as Array<any>).map(ExecuteStatToJSON)),
+    };
+}
+

package/models/SlippageResult.ts

@@ -0,0 +1,97 @@
+/* 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 SlippageResult
+ */
+export interface SlippageResult {
+    /**
+     * 
+     * @type {string}
+     * @memberof SlippageResult
+     */
+    exchange: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SlippageResult
+     */
+    market: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof SlippageResult
+     */
+    size_usd: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SlippageResult
+     */
+    avg_slippage: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SlippageResult
+     */
+    data_count: number;
+}
+
+/**
+ * Check if a given object implements the SlippageResult interface.
+ */
+export function instanceOfSlippageResult(value: object): value is SlippageResult {
+    if (!('exchange' in value) || value['exchange'] === undefined) return false;
+    if (!('market' in value) || value['market'] === undefined) return false;
+    if (!('size_usd' in value) || value['size_usd'] === undefined) return false;
+    if (!('avg_slippage' in value) || value['avg_slippage'] === undefined) return false;
+    if (!('data_count' in value) || value['data_count'] === undefined) return false;
+    return true;
+}
+
+export function SlippageResultFromJSON(json: any): SlippageResult {
+    return SlippageResultFromJSONTyped(json, false);
+}
+
+export function SlippageResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): SlippageResult {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'exchange': json['exchange'],
+        'market': json['market'],
+        'size_usd': json['size_usd'],
+        'avg_slippage': json['avg_slippage'],
+        'data_count': json['data_count'],
+    };
+}
+
+export function SlippageResultToJSON(value?: SlippageResult | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'exchange': value['exchange'],
+        'market': value['market'],
+        'size_usd': value['size_usd'],
+        'avg_slippage': value['avg_slippage'],
+        'data_count': value['data_count'],
+    };
+}
+

package/models/index.ts

@@ -44,6 +44,7 @@ export * from './DetailedCandlestick';
 export * from './EnrichedTx';
 export * from './ExchangeMetric';
 export * from './ExchangeStats';
+export * from './ExecuteStat';
 export * from './ExportData';
 export * from './Funding';
 export * from './FundingRate';
@@ -109,6 +110,7 @@ export * from './ReqGetCandles';
 export * from './ReqGetCandlesticks';
 export * from './ReqGetDepositHistory';
 export * from './ReqGetExchangeMetrics';
+export * from './ReqGetExecuteStats';
 export * from './ReqGetFastWithdrawInfo';
 export * from './ReqGetFundings';
 export * from './ReqGetGeckoOrderbook';
@@ -139,6 +141,7 @@ export * from './RespChangeAccountTier';
 export * from './RespGetApiTokens';
 export * from './RespGetBridgesByL1Addr';
 export * from './RespGetExchangeMetrics';
+export * from './RespGetExecuteStats';
 export * from './RespGetFastBridgeInfo';
 export * from './RespGetFastwithdrawalInfo';
 export * from './RespGetIsNextBridgeFast';
@@ -155,6 +158,7 @@ export * from './RiskInfo';
 export * from './RiskParameters';
 export * from './SharePrice';
 export * from './SimpleOrder';
+export * from './SlippageResult';
 export * from './SpotMarketStats';
 export * from './SpotOrderBookDetail';
 export * from './Status';

package/openapi.json

@@ -1379,6 +1379,49 @@
         "description": "Get exchange stats"
       }
     },
+    "/api/v1/executeStats": {
+      "get": {
+        "summary": "executeStats",
+        "operationId": "executeStats",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespGetExecuteStats"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "period",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "enum": [
+              "d",
+              "w",
+              "m",
+              "q",
+              "y",
+              "all"
+            ]
+          }
+        ],
+        "tags": [
+          "order"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get execute stats"
+      }
+    },
     "/api/v1/export": {
       "get": {
         "summary": "export",
@@ -5653,6 +5696,27 @@
         "daily_trades_count"
       ]
     },
+    "ExecuteStat": {
+      "type": "object",
+      "properties": {
+        "timestamp": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1640995200"
+        },
+        "slippage": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/SlippageResult"
+          }
+        }
+      },
+      "title": "ExecuteStat",
+      "required": [
+        "timestamp",
+        "slippage"
+      ]
+    },
     "ExportData": {
       "type": "object",
       "properties": {
@@ -8505,6 +8569,26 @@
       "type": "object",
       "title": "ReqGetExchangeStats"
     },
+    "ReqGetExecuteStats": {
+      "type": "object",
+      "properties": {
+        "period": {
+          "type": "string",
+          "enum": [
+            "d",
+            "w",
+            "m",
+            "q",
+            "y",
+            "all"
+          ]
+        }
+      },
+      "title": "ReqGetExecuteStats",
+      "required": [
+        "period"
+      ]
+    },
     "ReqGetFastWithdrawInfo": {
       "type": "object",
       "properties": {
@@ -9423,6 +9507,33 @@
         "metrics"
       ]
     },
+    "RespGetExecuteStats": {
+      "type": "object",
+      "properties": {
+        "period": {
+          "type": "string",
+          "enum": [
+            "d",
+            "w",
+            "m",
+            "q",
+            "y",
+            "all"
+          ]
+        },
+        "result": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ExecuteStat"
+          }
+        }
+      },
+      "title": "RespGetExecuteStats",
+      "required": [
+        "period",
+        "result"
+      ]
+    },
     "RespGetFastBridgeInfo": {
       "type": "object",
       "properties": {
@@ -9870,6 +9981,42 @@
         "transaction_time"
       ]
     },
+    "SlippageResult": {
+      "type": "object",
+      "properties": {
+        "exchange": {
+          "type": "string",
+          "example": "lighter"
+        },
+        "market": {
+          "type": "string",
+          "example": "ETH"
+        },
+        "size_usd": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1000"
+        },
+        "avg_slippage": {
+          "type": "number",
+          "format": "double",
+          "example": "0.5"
+        },
+        "data_count": {
+          "type": "integer",
+          "format": "int64",
+          "example": "100"
+        }
+      },
+      "title": "SlippageResult",
+      "required": [
+        "exchange",
+        "market",
+        "size_usd",
+        "avg_slippage",
+        "data_count"
+      ]
+    },
     "SpotMarketStats": {
       "type": "object",
       "properties": {

package/package.json

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