zklighter-perps 1.0.238 → 1.0.240

package/.openapi-generator/FILES

@@ -37,6 +37,7 @@ models/ApiToken.ts
 models/ApprovedIntegrator.ts
 models/Asset.ts
 models/AssetDetails.ts
+models/AssetStats.ts
 models/Auth.ts
 models/Block.ts
 models/Blocks.ts
@@ -85,6 +86,7 @@ models/Liquidation.ts
 models/LiquidationInfo.ts
 models/LiquidationInfos.ts
 models/MarketConfig.ts
+models/MarketMetricData.ts
 models/NextNonce.ts
 models/Order.ts
 models/OrderBook.ts
@@ -95,6 +97,7 @@ models/OrderBookOrders.ts
 models/OrderBookStats.ts
 models/OrderBooks.ts
 models/Orders.ts
+models/PartnerStats.ts
 models/PendingUnlock.ts
 models/PerpsMarketStats.ts
 models/PerpsOrderBookDetail.ts
@@ -146,10 +149,12 @@ models/ReqGetLeaderboard.ts
 models/ReqGetLeases.ts
 models/ReqGetLiquidationInfos.ts
 models/ReqGetMakerOnlyApiKeys.ts
+models/ReqGetMarketMetrics.ts
 models/ReqGetNextNonce.ts
 models/ReqGetOrderBookDetails.ts
 models/ReqGetOrderBookOrders.ts
 models/ReqGetOrderBooks.ts
+models/ReqGetPartnerStats.ts
 models/ReqGetPositionFunding.ts
 models/ReqGetPublicPoolsMetadata.ts
 models/ReqGetPushNotifSettings.ts
@@ -180,6 +185,7 @@ models/RespGetIsNextBridgeFast.ts
 models/RespGetLeaseOptions.ts
 models/RespGetLeases.ts
 models/RespGetMakerOnlyApiKeys.ts
+models/RespGetMarketMetrics.ts
 models/RespGetPushNotifSettings.ts
 models/RespGetRFQ.ts
 models/RespListRFQs.ts

package/apis/AccountApi.ts

@@ -25,6 +25,7 @@ import type {
   L1Metadata,
   Leaderboard,
   LiquidationInfos,
+  PartnerStats,
   PositionFundings,
   RespChangeAccountTier,
   RespCreateRFQ,
@@ -65,6 +66,8 @@ import {
     LeaderboardToJSON,
     LiquidationInfosFromJSON,
     LiquidationInfosToJSON,
+    PartnerStatsFromJSON,
+    PartnerStatsToJSON,
     PositionFundingsFromJSON,
     PositionFundingsToJSON,
     RespChangeAccountTierFromJSON,
@@ -208,6 +211,12 @@ export interface LitLeaseRequest {
     authorization?: string;
 }
 
+export interface PartnerStatsRequest {
+    account_index: number;
+    start_timestamp?: number;
+    end_timestamp?: number;
+}
+
 export interface PnlRequest {
     by: PnlByEnum;
     value: string;
@@ -1234,6 +1243,53 @@ export class AccountApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get partner stats
+     * partnerStats
+     */
+    async partnerStatsRaw(requestParameters: PartnerStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStats>> {
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling partnerStats().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['account_index'] != null) {
+            queryParameters['account_index'] = requestParameters['account_index'];
+        }
+
+        if (requestParameters['start_timestamp'] != null) {
+            queryParameters['start_timestamp'] = requestParameters['start_timestamp'];
+        }
+
+        if (requestParameters['end_timestamp'] != null) {
+            queryParameters['end_timestamp'] = requestParameters['end_timestamp'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/partnerStats`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PartnerStatsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get partner stats
+     * partnerStats
+     */
+    async partnerStats(requestParameters: PartnerStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStats> {
+        const response = await this.partnerStatsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get account PnL chart
      * pnl

package/apis/OrderApi.ts

@@ -24,6 +24,7 @@ import type {
   Orders,
   RespGetExchangeMetrics,
   RespGetExecuteStats,
+  RespGetMarketMetrics,
   ResultCode,
   Trades,
 } from '../models/index';
@@ -46,6 +47,8 @@ import {
     RespGetExchangeMetricsToJSON,
     RespGetExecuteStatsFromJSON,
     RespGetExecuteStatsToJSON,
+    RespGetMarketMetricsFromJSON,
+    RespGetMarketMetricsToJSON,
     ResultCodeFromJSON,
     ResultCodeToJSON,
     TradesFromJSON,
@@ -100,6 +103,11 @@ export interface ExecuteStatsRequest {
     period: ExecuteStatsPeriodEnum;
 }
 
+export interface MarketMetricsRequest {
+    timestamp: number;
+    kind: MarketMetricsKindEnum;
+}
+
 export interface OrderBookDetailsRequest {
     market_id?: number;
     filter?: OrderBookDetailsFilterEnum;
@@ -508,6 +516,56 @@ export class OrderApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get market metrics for a specific timestamp, returns data for all markets
+     * marketMetrics
+     */
+    async marketMetricsRaw(requestParameters: MarketMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespGetMarketMetrics>> {
+        if (requestParameters['timestamp'] == null) {
+            throw new runtime.RequiredError(
+                'timestamp',
+                'Required parameter "timestamp" was null or undefined when calling marketMetrics().'
+            );
+        }
+
+        if (requestParameters['kind'] == null) {
+            throw new runtime.RequiredError(
+                'kind',
+                'Required parameter "kind" was null or undefined when calling marketMetrics().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['timestamp'] != null) {
+            queryParameters['timestamp'] = requestParameters['timestamp'];
+        }
+
+        if (requestParameters['kind'] != null) {
+            queryParameters['kind'] = requestParameters['kind'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/marketMetrics`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespGetMarketMetricsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get market metrics for a specific timestamp, returns data for all markets
+     * marketMetrics
+     */
+    async marketMetrics(requestParameters: MarketMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespGetMarketMetrics> {
+        const response = await this.marketMetricsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get order books metadata
      * orderBookDetails
@@ -893,6 +951,13 @@ export const ExecuteStatsPeriodEnum = {
     All: 'all'
 } as const;
 export type ExecuteStatsPeriodEnum = typeof ExecuteStatsPeriodEnum[keyof typeof ExecuteStatsPeriodEnum];
+/**
+ * @export
+ */
+export const MarketMetricsKindEnum = {
+    Volume: 'volume'
+} as const;
+export type MarketMetricsKindEnum = typeof MarketMetricsKindEnum[keyof typeof MarketMetricsKindEnum];
 /**
  * @export
  */

package/models/AccountAsset.ts

@@ -43,8 +43,31 @@ export interface AccountAsset {
      * @memberof AccountAsset
      */
     locked_balance: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AccountAsset
+     */
+    margin_mode: AccountAssetMarginModeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof AccountAsset
+     */
+    margin_balance: string;
 }
 
+
+/**
+ * @export
+ */
+export const AccountAssetMarginModeEnum = {
+    Enabled: 'enabled',
+    Disabled: 'disabled'
+} as const;
+export type AccountAssetMarginModeEnum = typeof AccountAssetMarginModeEnum[keyof typeof AccountAssetMarginModeEnum];
+
+
 /**
  * Check if a given object implements the AccountAsset interface.
  */
@@ -53,6 +76,8 @@ export function instanceOfAccountAsset(value: object): value is AccountAsset {
     if (!('asset_id' in value) || value['asset_id'] === undefined) return false;
     if (!('balance' in value) || value['balance'] === undefined) return false;
     if (!('locked_balance' in value) || value['locked_balance'] === undefined) return false;
+    if (!('margin_mode' in value) || value['margin_mode'] === undefined) return false;
+    if (!('margin_balance' in value) || value['margin_balance'] === undefined) return false;
     return true;
 }
 
@@ -70,6 +95,8 @@ export function AccountAssetFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'asset_id': json['asset_id'],
         'balance': json['balance'],
         'locked_balance': json['locked_balance'],
+        'margin_mode': json['margin_mode'],
+        'margin_balance': json['margin_balance'],
     };
 }
 
@@ -83,6 +110,8 @@ export function AccountAssetToJSON(value?: AccountAsset | null): any {
         'asset_id': value['asset_id'],
         'balance': value['balance'],
         'locked_balance': value['locked_balance'],
+        'margin_mode': value['margin_mode'],
+        'margin_balance': value['margin_balance'],
     };
 }
 

package/models/Asset.ts

@@ -67,12 +67,54 @@ export interface Asset {
      * @memberof Asset
      */
     index_price: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof Asset
+     */
+    price_decimals: number;
     /**
      * 
      * @type {string}
      * @memberof Asset
      */
     l1_address: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    loan_to_value: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    liquidation_threshold: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    liquidation_fee: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    global_supply_cap: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    user_supply_cap: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    total_supplied: string;
 }
 
 
@@ -98,7 +140,14 @@ export function instanceOfAsset(value: object): value is Asset {
     if (!('min_withdrawal_amount' in value) || value['min_withdrawal_amount'] === undefined) return false;
     if (!('margin_mode' in value) || value['margin_mode'] === undefined) return false;
     if (!('index_price' in value) || value['index_price'] === undefined) return false;
+    if (!('price_decimals' in value) || value['price_decimals'] === undefined) return false;
     if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
+    if (!('loan_to_value' in value) || value['loan_to_value'] === undefined) return false;
+    if (!('liquidation_threshold' in value) || value['liquidation_threshold'] === undefined) return false;
+    if (!('liquidation_fee' in value) || value['liquidation_fee'] === undefined) return false;
+    if (!('global_supply_cap' in value) || value['global_supply_cap'] === undefined) return false;
+    if (!('user_supply_cap' in value) || value['user_supply_cap'] === undefined) return false;
+    if (!('total_supplied' in value) || value['total_supplied'] === undefined) return false;
     return true;
 }
 
@@ -120,7 +169,14 @@ export function AssetFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ass
         'min_withdrawal_amount': json['min_withdrawal_amount'],
         'margin_mode': json['margin_mode'],
         'index_price': json['index_price'],
+        'price_decimals': json['price_decimals'],
         'l1_address': json['l1_address'],
+        'loan_to_value': json['loan_to_value'],
+        'liquidation_threshold': json['liquidation_threshold'],
+        'liquidation_fee': json['liquidation_fee'],
+        'global_supply_cap': json['global_supply_cap'],
+        'user_supply_cap': json['user_supply_cap'],
+        'total_supplied': json['total_supplied'],
     };
 }
 
@@ -138,7 +194,14 @@ export function AssetToJSON(value?: Asset | null): any {
         'min_withdrawal_amount': value['min_withdrawal_amount'],
         'margin_mode': value['margin_mode'],
         'index_price': value['index_price'],
+        'price_decimals': value['price_decimals'],
         'l1_address': value['l1_address'],
+        'loan_to_value': value['loan_to_value'],
+        'liquidation_threshold': value['liquidation_threshold'],
+        'liquidation_fee': value['liquidation_fee'],
+        'global_supply_cap': value['global_supply_cap'],
+        'user_supply_cap': value['user_supply_cap'],
+        'total_supplied': value['total_supplied'],
     };
 }
 

package/models/MarketMetricData.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 MarketMetricData
+ */
+export interface MarketMetricData {
+    /**
+     * 
+     * @type {string}
+     * @memberof MarketMetricData
+     */
+    market: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof MarketMetricData
+     */
+    data: number;
+}
+
+/**
+ * Check if a given object implements the MarketMetricData interface.
+ */
+export function instanceOfMarketMetricData(value: object): value is MarketMetricData {
+    if (!('market' in value) || value['market'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function MarketMetricDataFromJSON(json: any): MarketMetricData {
+    return MarketMetricDataFromJSONTyped(json, false);
+}
+
+export function MarketMetricDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): MarketMetricData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'market': json['market'],
+        'data': json['data'],
+    };
+}
+
+export function MarketMetricDataToJSON(value?: MarketMetricData | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'market': value['market'],
+        'data': value['data'],
+    };
+}
+

package/models/OrderBook.ts

@@ -61,12 +61,24 @@ export interface OrderBook {
      * @memberof OrderBook
      */
     taker_fee: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OrderBook
+     */
+    is_taker_fee_enabled: boolean;
     /**
      * 
      * @type {string}
      * @memberof OrderBook
      */
     maker_fee: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OrderBook
+     */
+    is_maker_fee_enabled: boolean;
     /**
      * 
      * @type {string}
@@ -142,7 +154,9 @@ export function instanceOfOrderBook(value: object): value is OrderBook {
     if (!('quote_asset_id' in value) || value['quote_asset_id'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('taker_fee' in value) || value['taker_fee'] === undefined) return false;
+    if (!('is_taker_fee_enabled' in value) || value['is_taker_fee_enabled'] === undefined) return false;
     if (!('maker_fee' in value) || value['maker_fee'] === undefined) return false;
+    if (!('is_maker_fee_enabled' in value) || value['is_maker_fee_enabled'] === undefined) return false;
     if (!('liquidation_fee' in value) || value['liquidation_fee'] === undefined) return false;
     if (!('min_base_amount' in value) || value['min_base_amount'] === undefined) return false;
     if (!('min_quote_amount' in value) || value['min_quote_amount'] === undefined) return false;
@@ -170,7 +184,9 @@ export function OrderBookFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'quote_asset_id': json['quote_asset_id'],
         'status': json['status'],
         'taker_fee': json['taker_fee'],
+        'is_taker_fee_enabled': json['is_taker_fee_enabled'],
         'maker_fee': json['maker_fee'],
+        'is_maker_fee_enabled': json['is_maker_fee_enabled'],
         'liquidation_fee': json['liquidation_fee'],
         'min_base_amount': json['min_base_amount'],
         'min_quote_amount': json['min_quote_amount'],
@@ -194,7 +210,9 @@ export function OrderBookToJSON(value?: OrderBook | null): any {
         'quote_asset_id': value['quote_asset_id'],
         'status': value['status'],
         'taker_fee': value['taker_fee'],
+        'is_taker_fee_enabled': value['is_taker_fee_enabled'],
         'maker_fee': value['maker_fee'],
+        'is_maker_fee_enabled': value['is_maker_fee_enabled'],
         'liquidation_fee': value['liquidation_fee'],
         'min_base_amount': value['min_base_amount'],
         'min_quote_amount': value['min_quote_amount'],

package/models/PartnerStats.ts

@@ -0,0 +1,159 @@
+/* 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 PartnerStats
+ */
+export interface PartnerStats {
+    /**
+     * 
+     * @type {number}
+     * @memberof PartnerStats
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PartnerStats
+     */
+    message?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PartnerStats
+     */
+    total_fees_earned: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PartnerStats
+     */
+    total_taker_fees_earned: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PartnerStats
+     */
+    total_maker_fees_earned: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PartnerStats
+     */
+    total_volume: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PartnerStats
+     */
+    total_taker_volume: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PartnerStats
+     */
+    total_maker_volume: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PartnerStats
+     */
+    total_trades: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PartnerStats
+     */
+    total_taker_trades: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PartnerStats
+     */
+    total_maker_trades: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PartnerStats
+     */
+    unique_clients: number;
+}
+
+/**
+ * Check if a given object implements the PartnerStats interface.
+ */
+export function instanceOfPartnerStats(value: object): value is PartnerStats {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('total_fees_earned' in value) || value['total_fees_earned'] === undefined) return false;
+    if (!('total_taker_fees_earned' in value) || value['total_taker_fees_earned'] === undefined) return false;
+    if (!('total_maker_fees_earned' in value) || value['total_maker_fees_earned'] === undefined) return false;
+    if (!('total_volume' in value) || value['total_volume'] === undefined) return false;
+    if (!('total_taker_volume' in value) || value['total_taker_volume'] === undefined) return false;
+    if (!('total_maker_volume' in value) || value['total_maker_volume'] === undefined) return false;
+    if (!('total_trades' in value) || value['total_trades'] === undefined) return false;
+    if (!('total_taker_trades' in value) || value['total_taker_trades'] === undefined) return false;
+    if (!('total_maker_trades' in value) || value['total_maker_trades'] === undefined) return false;
+    if (!('unique_clients' in value) || value['unique_clients'] === undefined) return false;
+    return true;
+}
+
+export function PartnerStatsFromJSON(json: any): PartnerStats {
+    return PartnerStatsFromJSONTyped(json, false);
+}
+
+export function PartnerStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerStats {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'total_fees_earned': json['total_fees_earned'],
+        'total_taker_fees_earned': json['total_taker_fees_earned'],
+        'total_maker_fees_earned': json['total_maker_fees_earned'],
+        'total_volume': json['total_volume'],
+        'total_taker_volume': json['total_taker_volume'],
+        'total_maker_volume': json['total_maker_volume'],
+        'total_trades': json['total_trades'],
+        'total_taker_trades': json['total_taker_trades'],
+        'total_maker_trades': json['total_maker_trades'],
+        'unique_clients': json['unique_clients'],
+    };
+}
+
+export function PartnerStatsToJSON(value?: PartnerStats | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'total_fees_earned': value['total_fees_earned'],
+        'total_taker_fees_earned': value['total_taker_fees_earned'],
+        'total_maker_fees_earned': value['total_maker_fees_earned'],
+        'total_volume': value['total_volume'],
+        'total_taker_volume': value['total_taker_volume'],
+        'total_maker_volume': value['total_maker_volume'],
+        'total_trades': value['total_trades'],
+        'total_taker_trades': value['total_taker_trades'],
+        'total_maker_trades': value['total_maker_trades'],
+        'unique_clients': value['unique_clients'],
+    };
+}
+