zklighter-perps 1.0.193 → 1.0.194

package/.openapi-generator/FILES

@@ -56,6 +56,7 @@ models/DetailedAccount.ts
 models/DetailedAccounts.ts
 models/DetailedCandlestick.ts
 models/EnrichedTx.ts
+models/ExchangeMetric.ts
 models/ExchangeStats.ts
 models/ExportData.ts
 models/Funding.ts
@@ -121,6 +122,7 @@ models/ReqGetByAccount.ts
 models/ReqGetCandles.ts
 models/ReqGetCandlesticks.ts
 models/ReqGetDepositHistory.ts
+models/ReqGetExchangeMetrics.ts
 models/ReqGetFastWithdrawInfo.ts
 models/ReqGetFundings.ts
 models/ReqGetGeckoOrderbook.ts
@@ -150,6 +152,7 @@ models/ReqIsWhitelisted.ts
 models/RespChangeAccountTier.ts
 models/RespGetApiTokens.ts
 models/RespGetBridgesByL1Addr.ts
+models/RespGetExchangeMetrics.ts
 models/RespGetFastBridgeInfo.ts
 models/RespGetFastwithdrawalInfo.ts
 models/RespGetIsNextBridgeFast.ts

package/apis/OrderApi.ts

@@ -22,6 +22,7 @@ import type {
   OrderBookOrders,
   OrderBooks,
   Orders,
+  RespGetExchangeMetrics,
   ResultCode,
   Trades,
 } from '../models/index';
@@ -40,6 +41,8 @@ import {
     OrderBooksToJSON,
     OrdersFromJSON,
     OrdersToJSON,
+    RespGetExchangeMetricsFromJSON,
+    RespGetExchangeMetricsToJSON,
     ResultCodeFromJSON,
     ResultCodeToJSON,
     TradesFromJSON,
@@ -76,6 +79,13 @@ export interface AssetDetailsRequest {
     asset_id?: number;
 }
 
+export interface ExchangeMetricsRequest {
+    period: ExchangeMetricsPeriodEnum;
+    kind: ExchangeMetricsKindEnum;
+    filter?: ExchangeMetricsFilterEnum;
+    value?: string;
+}
+
 export interface OrderBookDetailsRequest {
     market_id?: number;
     filter?: OrderBookDetailsFilterEnum;
@@ -337,6 +347,64 @@ export class OrderApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get exchange metrics
+     * exchangeMetrics
+     */
+    async exchangeMetricsRaw(requestParameters: ExchangeMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespGetExchangeMetrics>> {
+        if (requestParameters['period'] == null) {
+            throw new runtime.RequiredError(
+                'period',
+                'Required parameter "period" was null or undefined when calling exchangeMetrics().'
+            );
+        }
+
+        if (requestParameters['kind'] == null) {
+            throw new runtime.RequiredError(
+                'kind',
+                'Required parameter "kind" was null or undefined when calling exchangeMetrics().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['period'] != null) {
+            queryParameters['period'] = requestParameters['period'];
+        }
+
+        if (requestParameters['kind'] != null) {
+            queryParameters['kind'] = requestParameters['kind'];
+        }
+
+        if (requestParameters['filter'] != null) {
+            queryParameters['filter'] = requestParameters['filter'];
+        }
+
+        if (requestParameters['value'] != null) {
+            queryParameters['value'] = requestParameters['value'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/exchangeMetrics`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespGetExchangeMetricsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get exchange metrics
+     * exchangeMetrics
+     */
+    async exchangeMetrics(requestParameters: ExchangeMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespGetExchangeMetrics> {
+        const response = await this.exchangeMetricsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get exchange stats
      * exchangeStats
@@ -645,6 +713,44 @@ export const ExportTypeEnum = {
     Trade: 'trade'
 } as const;
 export type ExportTypeEnum = typeof ExportTypeEnum[keyof typeof ExportTypeEnum];
+/**
+ * @export
+ */
+export const ExchangeMetricsPeriodEnum = {
+    W: 'w',
+    M: 'm',
+    Q: 'q',
+    Y: 'y',
+    All: 'all'
+} as const;
+export type ExchangeMetricsPeriodEnum = typeof ExchangeMetricsPeriodEnum[keyof typeof ExchangeMetricsPeriodEnum];
+/**
+ * @export
+ */
+export const ExchangeMetricsKindEnum = {
+    Volume: 'volume',
+    MakerFee: 'maker_fee',
+    TakerFee: 'taker_fee',
+    LiquidationFee: 'liquidation_fee',
+    TradeCount: 'trade_count',
+    LiquidationCount: 'liquidation_count',
+    LiquidationVolume: 'liquidation_volume',
+    Inflow: 'inflow',
+    Outflow: 'outflow',
+    TransferFee: 'transfer_fee',
+    WithdrawFee: 'withdraw_fee',
+    OpenInterest: 'open_interest',
+    AccountCount: 'account_count',
+    ActiveAccountCount: 'active_account_count'
+} as const;
+export type ExchangeMetricsKindEnum = typeof ExchangeMetricsKindEnum[keyof typeof ExchangeMetricsKindEnum];
+/**
+ * @export
+ */
+export const ExchangeMetricsFilterEnum = {
+    ByMarket: 'byMarket'
+} as const;
+export type ExchangeMetricsFilterEnum = typeof ExchangeMetricsFilterEnum[keyof typeof ExchangeMetricsFilterEnum];
 /**
  * @export
  */

package/models/ExchangeMetric.ts

@@ -0,0 +1,70 @@
+/* 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 ExchangeMetric
+ */
+export interface ExchangeMetric {
+    /**
+     * 
+     * @type {number}
+     * @memberof ExchangeMetric
+     */
+    timestamp: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ExchangeMetric
+     */
+    data: number;
+}
+
+/**
+ * Check if a given object implements the ExchangeMetric interface.
+ */
+export function instanceOfExchangeMetric(value: object): value is ExchangeMetric {
+    if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function ExchangeMetricFromJSON(json: any): ExchangeMetric {
+    return ExchangeMetricFromJSONTyped(json, false);
+}
+
+export function ExchangeMetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExchangeMetric {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'timestamp': json['timestamp'],
+        'data': json['data'],
+    };
+}
+
+export function ExchangeMetricToJSON(value?: ExchangeMetric | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'timestamp': value['timestamp'],
+        'data': value['data'],
+    };
+}
+

package/models/ReqGetExchangeMetrics.ts

@@ -0,0 +1,129 @@
+/* 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 ReqGetExchangeMetrics
+ */
+export interface ReqGetExchangeMetrics {
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetExchangeMetrics
+     */
+    period: ReqGetExchangeMetricsPeriodEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetExchangeMetrics
+     */
+    kind: ReqGetExchangeMetricsKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetExchangeMetrics
+     */
+    filter?: ReqGetExchangeMetricsFilterEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetExchangeMetrics
+     */
+    value?: string;
+}
+
+
+/**
+ * @export
+ */
+export const ReqGetExchangeMetricsPeriodEnum = {
+    W: 'w',
+    M: 'm',
+    Q: 'q',
+    Y: 'y',
+    All: 'all'
+} as const;
+export type ReqGetExchangeMetricsPeriodEnum = typeof ReqGetExchangeMetricsPeriodEnum[keyof typeof ReqGetExchangeMetricsPeriodEnum];
+
+/**
+ * @export
+ */
+export const ReqGetExchangeMetricsKindEnum = {
+    Volume: 'volume',
+    MakerFee: 'maker_fee',
+    TakerFee: 'taker_fee',
+    LiquidationFee: 'liquidation_fee',
+    TradeCount: 'trade_count',
+    LiquidationCount: 'liquidation_count',
+    LiquidationVolume: 'liquidation_volume',
+    Inflow: 'inflow',
+    Outflow: 'outflow',
+    TransferFee: 'transfer_fee',
+    WithdrawFee: 'withdraw_fee',
+    OpenInterest: 'open_interest',
+    AccountCount: 'account_count',
+    ActiveAccountCount: 'active_account_count'
+} as const;
+export type ReqGetExchangeMetricsKindEnum = typeof ReqGetExchangeMetricsKindEnum[keyof typeof ReqGetExchangeMetricsKindEnum];
+
+/**
+ * @export
+ */
+export const ReqGetExchangeMetricsFilterEnum = {
+    ByMarket: 'byMarket'
+} as const;
+export type ReqGetExchangeMetricsFilterEnum = typeof ReqGetExchangeMetricsFilterEnum[keyof typeof ReqGetExchangeMetricsFilterEnum];
+
+
+/**
+ * Check if a given object implements the ReqGetExchangeMetrics interface.
+ */
+export function instanceOfReqGetExchangeMetrics(value: object): value is ReqGetExchangeMetrics {
+    if (!('period' in value) || value['period'] === undefined) return false;
+    if (!('kind' in value) || value['kind'] === undefined) return false;
+    return true;
+}
+
+export function ReqGetExchangeMetricsFromJSON(json: any): ReqGetExchangeMetrics {
+    return ReqGetExchangeMetricsFromJSONTyped(json, false);
+}
+
+export function ReqGetExchangeMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetExchangeMetrics {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'period': json['period'],
+        'kind': json['kind'],
+        'filter': json['filter'] == null ? undefined : json['filter'],
+        'value': json['value'] == null ? undefined : json['value'],
+    };
+}
+
+export function ReqGetExchangeMetricsToJSON(value?: ReqGetExchangeMetrics | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'period': value['period'],
+        'kind': value['kind'],
+        'filter': value['filter'],
+        'value': value['value'],
+    };
+}
+

package/models/RespGetExchangeMetrics.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 { ExchangeMetric } from './ExchangeMetric';
+import {
+    ExchangeMetricFromJSON,
+    ExchangeMetricFromJSONTyped,
+    ExchangeMetricToJSON,
+} from './ExchangeMetric';
+
+/**
+ * 
+ * @export
+ * @interface RespGetExchangeMetrics
+ */
+export interface RespGetExchangeMetrics {
+    /**
+     * 
+     * @type {number}
+     * @memberof RespGetExchangeMetrics
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RespGetExchangeMetrics
+     */
+    message?: string;
+    /**
+     * 
+     * @type {Array<ExchangeMetric>}
+     * @memberof RespGetExchangeMetrics
+     */
+    metrics: Array<ExchangeMetric>;
+}
+
+/**
+ * Check if a given object implements the RespGetExchangeMetrics interface.
+ */
+export function instanceOfRespGetExchangeMetrics(value: object): value is RespGetExchangeMetrics {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('metrics' in value) || value['metrics'] === undefined) return false;
+    return true;
+}
+
+export function RespGetExchangeMetricsFromJSON(json: any): RespGetExchangeMetrics {
+    return RespGetExchangeMetricsFromJSONTyped(json, false);
+}
+
+export function RespGetExchangeMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): RespGetExchangeMetrics {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'metrics': ((json['metrics'] as Array<any>).map(ExchangeMetricFromJSON)),
+    };
+}
+
+export function RespGetExchangeMetricsToJSON(value?: RespGetExchangeMetrics | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'metrics': ((value['metrics'] as Array<any>).map(ExchangeMetricToJSON)),
+    };
+}
+

package/models/index.ts

@@ -42,6 +42,7 @@ export * from './DetailedAccount';
 export * from './DetailedAccounts';
 export * from './DetailedCandlestick';
 export * from './EnrichedTx';
+export * from './ExchangeMetric';
 export * from './ExchangeStats';
 export * from './ExportData';
 export * from './Funding';
@@ -107,6 +108,7 @@ export * from './ReqGetByAccount';
 export * from './ReqGetCandles';
 export * from './ReqGetCandlesticks';
 export * from './ReqGetDepositHistory';
+export * from './ReqGetExchangeMetrics';
 export * from './ReqGetFastWithdrawInfo';
 export * from './ReqGetFundings';
 export * from './ReqGetGeckoOrderbook';
@@ -136,6 +138,7 @@ export * from './ReqIsWhitelisted';
 export * from './RespChangeAccountTier';
 export * from './RespGetApiTokens';
 export * from './RespGetBridgesByL1Addr';
+export * from './RespGetExchangeMetrics';
 export * from './RespGetFastBridgeInfo';
 export * from './RespGetFastwithdrawalInfo';
 export * from './RespGetIsNextBridgeFast';

package/openapi.json

@@ -1276,6 +1276,85 @@
         "description": "Get deposit supporting networks"
       }
     },
+    "/api/v1/exchangeMetrics": {
+      "get": {
+        "summary": "exchangeMetrics",
+        "operationId": "exchangeMetrics",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespGetExchangeMetrics"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "period",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "enum": [
+              "w",
+              "m",
+              "q",
+              "y",
+              "all"
+            ]
+          },
+          {
+            "name": "kind",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "enum": [
+              "volume",
+              "maker_fee",
+              "taker_fee",
+              "liquidation_fee",
+              "trade_count",
+              "liquidation_count",
+              "liquidation_volume",
+              "inflow",
+              "outflow",
+              "transfer_fee",
+              "withdraw_fee",
+              "open_interest",
+              "account_count",
+              "active_account_count"
+            ]
+          },
+          {
+            "name": "filter",
+            "in": "query",
+            "required": false,
+            "type": "string",
+            "enum": [
+              "byMarket"
+            ]
+          },
+          {
+            "name": "value",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "order"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get exchange metrics"
+      }
+    },
     "/api/v1/exchangeStats": {
       "get": {
         "summary": "exchangeStats",
@@ -5511,6 +5590,26 @@
         "verified_at"
       ]
     },
+    "ExchangeMetric": {
+      "type": "object",
+      "properties": {
+        "timestamp": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1640995200"
+        },
+        "data": {
+          "type": "number",
+          "format": "double",
+          "example": "93566.25"
+        }
+      },
+      "title": "ExchangeMetric",
+      "required": [
+        "timestamp",
+        "data"
+      ]
+    },
     "ExchangeStats": {
       "type": "object",
       "properties": {
@@ -8354,6 +8453,54 @@
         "l1_address"
       ]
     },
+    "ReqGetExchangeMetrics": {
+      "type": "object",
+      "properties": {
+        "period": {
+          "type": "string",
+          "enum": [
+            "w",
+            "m",
+            "q",
+            "y",
+            "all"
+          ]
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "volume",
+            "maker_fee",
+            "taker_fee",
+            "liquidation_fee",
+            "trade_count",
+            "liquidation_count",
+            "liquidation_volume",
+            "inflow",
+            "outflow",
+            "transfer_fee",
+            "withdraw_fee",
+            "open_interest",
+            "account_count",
+            "active_account_count"
+          ]
+        },
+        "filter": {
+          "type": "string",
+          "enum": [
+            "byMarket"
+          ]
+        },
+        "value": {
+          "type": "string"
+        }
+      },
+      "title": "ReqGetExchangeMetrics",
+      "required": [
+        "period",
+        "kind"
+      ]
+    },
     "ReqGetExchangeStats": {
       "type": "object",
       "title": "ReqGetExchangeStats"
@@ -9252,6 +9399,30 @@
         "bridges"
       ]
     },
+    "RespGetExchangeMetrics": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "metrics": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ExchangeMetric"
+          }
+        }
+      },
+      "title": "RespGetExchangeMetrics",
+      "required": [
+        "code",
+        "metrics"
+      ]
+    },
     "RespGetFastBridgeInfo": {
       "type": "object",
       "properties": {

package/package.json

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