zklighter-perps 1.0.346 → 1.0.348

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/ReqGetAggregatedTrades.ts

@@ -0,0 +1,157 @@
+/* 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 ReqGetAggregatedTrades
+ */
+export interface ReqGetAggregatedTrades {
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetAggregatedTrades
+     */
+    account_index: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetAggregatedTrades
+     */
+    market_id?: number;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ReqGetAggregatedTrades
+     */
+    market_type?: Array<ReqGetAggregatedTradesMarketTypeEnum>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetAggregatedTrades
+     */
+    order_index_str?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetAggregatedTrades
+     */
+    cursor?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetAggregatedTrades
+     */
+    ask_filter?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetAggregatedTrades
+     */
+    role?: ReqGetAggregatedTradesRoleEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetAggregatedTrades
+     */
+    type?: ReqGetAggregatedTradesTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetAggregatedTrades
+     */
+    limit?: number;
+}
+
+
+/**
+ * @export
+ */
+export const ReqGetAggregatedTradesMarketTypeEnum = {
+    Spot: 'spot',
+    Perps: 'perps',
+    Bo: 'bo'
+} as const;
+export type ReqGetAggregatedTradesMarketTypeEnum = typeof ReqGetAggregatedTradesMarketTypeEnum[keyof typeof ReqGetAggregatedTradesMarketTypeEnum];
+
+/**
+ * @export
+ */
+export const ReqGetAggregatedTradesRoleEnum = {
+    Maker: 'maker',
+    Taker: 'taker'
+} as const;
+export type ReqGetAggregatedTradesRoleEnum = typeof ReqGetAggregatedTradesRoleEnum[keyof typeof ReqGetAggregatedTradesRoleEnum];
+
+/**
+ * @export
+ */
+export const ReqGetAggregatedTradesTypeEnum = {
+    Trade: 'trade',
+    Liquidation: 'liquidation',
+    Deleverage: 'deleverage',
+    MarketSettlement: 'market_settlement'
+} as const;
+export type ReqGetAggregatedTradesTypeEnum = typeof ReqGetAggregatedTradesTypeEnum[keyof typeof ReqGetAggregatedTradesTypeEnum];
+
+
+/**
+ * Check if a given object implements the ReqGetAggregatedTrades interface.
+ */
+export function instanceOfReqGetAggregatedTrades(value: object): value is ReqGetAggregatedTrades {
+    if (!('account_index' in value) || value['account_index'] === undefined) return false;
+    return true;
+}
+
+export function ReqGetAggregatedTradesFromJSON(json: any): ReqGetAggregatedTrades {
+    return ReqGetAggregatedTradesFromJSONTyped(json, false);
+}
+
+export function ReqGetAggregatedTradesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetAggregatedTrades {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'account_index': json['account_index'],
+        'market_id': json['market_id'] == null ? undefined : json['market_id'],
+        'market_type': json['market_type'] == null ? undefined : json['market_type'],
+        'order_index_str': json['order_index_str'] == null ? undefined : json['order_index_str'],
+        'cursor': json['cursor'] == null ? undefined : json['cursor'],
+        'ask_filter': json['ask_filter'] == null ? undefined : json['ask_filter'],
+        'role': json['role'] == null ? undefined : json['role'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'limit': json['limit'] == null ? undefined : json['limit'],
+    };
+}
+
+export function ReqGetAggregatedTradesToJSON(value?: ReqGetAggregatedTrades | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'account_index': value['account_index'],
+        'market_id': value['market_id'],
+        'market_type': value['market_type'],
+        'order_index_str': value['order_index_str'],
+        'cursor': value['cursor'],
+        'ask_filter': value['ask_filter'],
+        'role': value['role'],
+        'type': value['type'],
+        'limit': value['limit'],
+    };
+}
+

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

@@ -14,6 +14,8 @@ export * from './AccountPnLV2';
 export * from './AccountPosition';
 export * from './AccountStats';
 export * from './AccountTradeStats';
+export * from './AggregatedTrade';
+export * from './AggregatedTrades';
 export * from './AirdropAllocationItem';
 export * from './AirdropAllocations';
 export * from './Alert';
@@ -30,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';
@@ -169,6 +175,7 @@ export * from './ReqGetAccountOrders';
 export * from './ReqGetAccountPnL';
 export * from './ReqGetAccountPnLV2';
 export * from './ReqGetAccountTxs';
+export * from './ReqGetAggregatedTrades';
 export * from './ReqGetAirdropAllocations';
 export * from './ReqGetApiTokens';
 export * from './ReqGetAssetDetails';
@@ -255,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';