zklighter-perps 1.0.296 → 1.0.298

package/.openapi-generator/FILES

@@ -81,6 +81,7 @@ models/GeckoContracts.ts
 models/GeckoOrderbook.ts
 models/GeckoTicker.ts
 models/GeckoTickers.ts
+models/HistoricalTradesExportData.ts
 models/IsWhitelisted.ts
 models/L1Metadata.ts
 models/L1ProviderInfo.ts
@@ -117,6 +118,8 @@ models/PendingUnlock.ts
 models/PerpsMarketStats.ts
 models/PerpsOrderBookDetail.ts
 models/PnLEntry.ts
+models/PnlLeaderboard.ts
+models/PnlLeaderboardEntry.ts
 models/PositionFunding.ts
 models/PositionFundings.ts
 models/PriceAlert.ts
@@ -139,6 +142,7 @@ models/ReferralStats.ts
 models/ReferralTotals.ts
 models/ReqDoFaucet.ts
 models/ReqExportData.ts
+models/ReqExportHistoricalTrades.ts
 models/ReqGetAccount.ts
 models/ReqGetAccountActiveOrders.ts
 models/ReqGetAccountApiKeys.ts
@@ -180,6 +184,7 @@ models/ReqGetOrderBookDetails.ts
 models/ReqGetOrderBookOrders.ts
 models/ReqGetOrderBooks.ts
 models/ReqGetPartnerStats.ts
+models/ReqGetPnlLeaderboard.ts
 models/ReqGetPositionFunding.ts
 models/ReqGetPublicPoolsMetadata.ts
 models/ReqGetPushNotifSettings.ts
@@ -273,6 +278,7 @@ models/Trades.ts
 models/TransferFeeInfo.ts
 models/TransferHistory.ts
 models/TransferHistoryItem.ts
+models/TvBlockchainAddresses.ts
 models/TvError.ts
 models/TvGroup.ts
 models/TvGroups.ts

package/apis/AccountApi.ts

@@ -26,6 +26,7 @@ import type {
   Leaderboard,
   LiquidationInfos,
   PartnerStats,
+  PnlLeaderboard,
   PositionFundings,
   RespChangeAccountTier,
   RespCreateRFQ,
@@ -68,6 +69,8 @@ import {
     LiquidationInfosToJSON,
     PartnerStatsFromJSON,
     PartnerStatsToJSON,
+    PnlLeaderboardFromJSON,
+    PnlLeaderboardToJSON,
     PositionFundingsFromJSON,
     PositionFundingsToJSON,
     RespChangeAccountTierFromJSON,
@@ -242,6 +245,15 @@ export interface PnlRequest {
     ignore_transfers?: boolean;
 }
 
+export interface PnlLeaderboardRequest {
+    time_window: PnlLeaderboardTimeWindowEnum;
+    sort_by: PnlLeaderboardSortByEnum;
+    sort_dir: PnlLeaderboardSortDirEnum;
+    limit: number;
+    offset: number;
+    search?: string;
+}
+
 export interface PositionFundingRequest {
     account_index: number;
     limit: number;
@@ -1522,6 +1534,93 @@ export class AccountApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get pnl leaderboard
+     * pnlLeaderboard
+     */
+    async pnlLeaderboardRaw(requestParameters: PnlLeaderboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PnlLeaderboard>> {
+        if (requestParameters['time_window'] == null) {
+            throw new runtime.RequiredError(
+                'time_window',
+                'Required parameter "time_window" was null or undefined when calling pnlLeaderboard().'
+            );
+        }
+
+        if (requestParameters['sort_by'] == null) {
+            throw new runtime.RequiredError(
+                'sort_by',
+                'Required parameter "sort_by" was null or undefined when calling pnlLeaderboard().'
+            );
+        }
+
+        if (requestParameters['sort_dir'] == null) {
+            throw new runtime.RequiredError(
+                'sort_dir',
+                'Required parameter "sort_dir" was null or undefined when calling pnlLeaderboard().'
+            );
+        }
+
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling pnlLeaderboard().'
+            );
+        }
+
+        if (requestParameters['offset'] == null) {
+            throw new runtime.RequiredError(
+                'offset',
+                'Required parameter "offset" was null or undefined when calling pnlLeaderboard().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['time_window'] != null) {
+            queryParameters['time_window'] = requestParameters['time_window'];
+        }
+
+        if (requestParameters['sort_by'] != null) {
+            queryParameters['sort_by'] = requestParameters['sort_by'];
+        }
+
+        if (requestParameters['sort_dir'] != null) {
+            queryParameters['sort_dir'] = requestParameters['sort_dir'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        if (requestParameters['search'] != null) {
+            queryParameters['search'] = requestParameters['search'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/pnlLeaderboard`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PnlLeaderboardFromJSON(jsonValue));
+    }
+
+    /**
+     * Get pnl leaderboard
+     * pnlLeaderboard
+     */
+    async pnlLeaderboard(requestParameters: PnlLeaderboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PnlLeaderboard> {
+        const response = await this.pnlLeaderboardRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get accounts position fundings
      * positionFunding
@@ -2345,6 +2444,34 @@ export const PnlResolutionEnum = {
     _1d: '1d'
 } as const;
 export type PnlResolutionEnum = typeof PnlResolutionEnum[keyof typeof PnlResolutionEnum];
+/**
+ * @export
+ */
+export const PnlLeaderboardTimeWindowEnum = {
+    _24h: '24h',
+    _7d: '7d',
+    _30d: '30d',
+    All: 'all'
+} as const;
+export type PnlLeaderboardTimeWindowEnum = typeof PnlLeaderboardTimeWindowEnum[keyof typeof PnlLeaderboardTimeWindowEnum];
+/**
+ * @export
+ */
+export const PnlLeaderboardSortByEnum = {
+    Pnl: 'pnl',
+    Roi: 'roi',
+    Volume: 'volume',
+    AccountValue: 'account_value'
+} as const;
+export type PnlLeaderboardSortByEnum = typeof PnlLeaderboardSortByEnum[keyof typeof PnlLeaderboardSortByEnum];
+/**
+ * @export
+ */
+export const PnlLeaderboardSortDirEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type PnlLeaderboardSortDirEnum = typeof PnlLeaderboardSortDirEnum[keyof typeof PnlLeaderboardSortDirEnum];
 /**
  * @export
  */

package/apis/OrderApi.ts

@@ -18,6 +18,7 @@ import type {
   AssetDetails,
   ExchangeStats,
   ExportData,
+  HistoricalTradesExportData,
   OrderBookDetails,
   OrderBookOrders,
   OrderBooks,
@@ -35,6 +36,8 @@ import {
     ExchangeStatsToJSON,
     ExportDataFromJSON,
     ExportDataToJSON,
+    HistoricalTradesExportDataFromJSON,
+    HistoricalTradesExportDataToJSON,
     OrderBookDetailsFromJSON,
     OrderBookDetailsToJSON,
     OrderBookOrdersFromJSON,
@@ -111,6 +114,13 @@ export interface ExecuteStatsRequest {
     period: ExecuteStatsPeriodEnum;
 }
 
+export interface ExportHistoricalTradesRequest {
+    l1_address: string;
+    date: string;
+    authorization?: string;
+    auth?: string;
+}
+
 export interface MarketMetricsRequest {
     timestamp: number;
     kind: MarketMetricsKindEnum;
@@ -145,6 +155,7 @@ export interface TradesRequest {
     market_type?: TradesMarketTypeEnum;
     account_index?: number;
     order_index?: number;
+    order_index_str?: string;
     sort_dir?: TradesSortDirEnum;
     cursor?: string;
     from?: number;
@@ -581,6 +592,64 @@ export class OrderApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Export historical trades. Requires the l1_address to have enough staked LIT; returns a presigned S3 url valid for 1 hour.
+     * export_historicalTrades
+     */
+    async exportHistoricalTradesRaw(requestParameters: ExportHistoricalTradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HistoricalTradesExportData>> {
+        if (requestParameters['l1_address'] == null) {
+            throw new runtime.RequiredError(
+                'l1_address',
+                'Required parameter "l1_address" was null or undefined when calling exportHistoricalTrades().'
+            );
+        }
+
+        if (requestParameters['date'] == null) {
+            throw new runtime.RequiredError(
+                'date',
+                'Required parameter "date" was null or undefined when calling exportHistoricalTrades().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['authorization'] != null) {
+            queryParameters['authorization'] = requestParameters['authorization'];
+        }
+
+        if (requestParameters['auth'] != null) {
+            queryParameters['auth'] = requestParameters['auth'];
+        }
+
+        if (requestParameters['l1_address'] != null) {
+            queryParameters['l1_address'] = requestParameters['l1_address'];
+        }
+
+        if (requestParameters['date'] != null) {
+            queryParameters['date'] = requestParameters['date'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/export/historicalTrades`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => HistoricalTradesExportDataFromJSON(jsonValue));
+    }
+
+    /**
+     * Export historical trades. Requires the l1_address to have enough staked LIT; returns a presigned S3 url valid for 1 hour.
+     * export_historicalTrades
+     */
+    async exportHistoricalTrades(requestParameters: ExportHistoricalTradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HistoricalTradesExportData> {
+        const response = await this.exportHistoricalTradesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get market metrics for a specific timestamp, returns data for all markets
      * marketMetrics
@@ -848,6 +917,10 @@ export class OrderApi extends runtime.BaseAPI {
             queryParameters['order_index'] = requestParameters['order_index'];
         }
 
+        if (requestParameters['order_index_str'] != null) {
+            queryParameters['order_index_str'] = requestParameters['order_index_str'];
+        }
+
         if (requestParameters['sort_by'] != null) {
             queryParameters['sort_by'] = requestParameters['sort_by'];
         }

package/models/HistoricalTradesExportData.ts

@@ -0,0 +1,87 @@
+/* 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 HistoricalTradesExportData
+ */
+export interface HistoricalTradesExportData {
+    /**
+     * 
+     * @type {number}
+     * @memberof HistoricalTradesExportData
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof HistoricalTradesExportData
+     */
+    message?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HistoricalTradesExportData
+     */
+    data_url: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HistoricalTradesExportData
+     */
+    expires_at: string;
+}
+
+/**
+ * Check if a given object implements the HistoricalTradesExportData interface.
+ */
+export function instanceOfHistoricalTradesExportData(value: object): value is HistoricalTradesExportData {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('data_url' in value) || value['data_url'] === undefined) return false;
+    if (!('expires_at' in value) || value['expires_at'] === undefined) return false;
+    return true;
+}
+
+export function HistoricalTradesExportDataFromJSON(json: any): HistoricalTradesExportData {
+    return HistoricalTradesExportDataFromJSONTyped(json, false);
+}
+
+export function HistoricalTradesExportDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): HistoricalTradesExportData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'data_url': json['data_url'],
+        'expires_at': json['expires_at'],
+    };
+}
+
+export function HistoricalTradesExportDataToJSON(value?: HistoricalTradesExportData | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'data_url': value['data_url'],
+        'expires_at': value['expires_at'],
+    };
+}
+

package/models/PnlLeaderboard.ts

@@ -0,0 +1,103 @@
+/* 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 { PnlLeaderboardEntry } from './PnlLeaderboardEntry';
+import {
+    PnlLeaderboardEntryFromJSON,
+    PnlLeaderboardEntryFromJSONTyped,
+    PnlLeaderboardEntryToJSON,
+} from './PnlLeaderboardEntry';
+
+/**
+ * 
+ * @export
+ * @interface PnlLeaderboard
+ */
+export interface PnlLeaderboard {
+    /**
+     * 
+     * @type {number}
+     * @memberof PnlLeaderboard
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PnlLeaderboard
+     */
+    message?: string;
+    /**
+     * 
+     * @type {Array<PnlLeaderboardEntry>}
+     * @memberof PnlLeaderboard
+     */
+    entries: Array<PnlLeaderboardEntry>;
+    /**
+     * 
+     * @type {number}
+     * @memberof PnlLeaderboard
+     */
+    total: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PnlLeaderboard
+     */
+    updated_at: number;
+}
+
+/**
+ * Check if a given object implements the PnlLeaderboard interface.
+ */
+export function instanceOfPnlLeaderboard(value: object): value is PnlLeaderboard {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('entries' in value) || value['entries'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('updated_at' in value) || value['updated_at'] === undefined) return false;
+    return true;
+}
+
+export function PnlLeaderboardFromJSON(json: any): PnlLeaderboard {
+    return PnlLeaderboardFromJSONTyped(json, false);
+}
+
+export function PnlLeaderboardFromJSONTyped(json: any, ignoreDiscriminator: boolean): PnlLeaderboard {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'entries': ((json['entries'] as Array<any>).map(PnlLeaderboardEntryFromJSON)),
+        'total': json['total'],
+        'updated_at': json['updated_at'],
+    };
+}
+
+export function PnlLeaderboardToJSON(value?: PnlLeaderboard | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'entries': ((value['entries'] as Array<any>).map(PnlLeaderboardEntryToJSON)),
+        'total': value['total'],
+        'updated_at': value['updated_at'],
+    };
+}
+

package/models/PnlLeaderboardEntry.ts

@@ -0,0 +1,106 @@
+/* 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 PnlLeaderboardEntry
+ */
+export interface PnlLeaderboardEntry {
+    /**
+     * 
+     * @type {number}
+     * @memberof PnlLeaderboardEntry
+     */
+    rank: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PnlLeaderboardEntry
+     */
+    l1_address: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PnlLeaderboardEntry
+     */
+    account_value: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PnlLeaderboardEntry
+     */
+    pnl: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PnlLeaderboardEntry
+     */
+    roi: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PnlLeaderboardEntry
+     */
+    volume: number;
+}
+
+/**
+ * Check if a given object implements the PnlLeaderboardEntry interface.
+ */
+export function instanceOfPnlLeaderboardEntry(value: object): value is PnlLeaderboardEntry {
+    if (!('rank' in value) || value['rank'] === undefined) return false;
+    if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
+    if (!('account_value' in value) || value['account_value'] === undefined) return false;
+    if (!('pnl' in value) || value['pnl'] === undefined) return false;
+    if (!('roi' in value) || value['roi'] === undefined) return false;
+    if (!('volume' in value) || value['volume'] === undefined) return false;
+    return true;
+}
+
+export function PnlLeaderboardEntryFromJSON(json: any): PnlLeaderboardEntry {
+    return PnlLeaderboardEntryFromJSONTyped(json, false);
+}
+
+export function PnlLeaderboardEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): PnlLeaderboardEntry {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'rank': json['rank'],
+        'l1_address': json['l1_address'],
+        'account_value': json['account_value'],
+        'pnl': json['pnl'],
+        'roi': json['roi'],
+        'volume': json['volume'],
+    };
+}
+
+export function PnlLeaderboardEntryToJSON(value?: PnlLeaderboardEntry | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'rank': value['rank'],
+        'l1_address': value['l1_address'],
+        'account_value': value['account_value'],
+        'pnl': value['pnl'],
+        'roi': value['roi'],
+        'volume': value['volume'],
+    };
+}
+

package/models/ReqExportHistoricalTrades.ts

@@ -0,0 +1,78 @@
+/* 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 ReqExportHistoricalTrades
+ */
+export interface ReqExportHistoricalTrades {
+    /**
+     *  made optional to support header auth clients
+     * @type {string}
+     * @memberof ReqExportHistoricalTrades
+     */
+    auth?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqExportHistoricalTrades
+     */
+    l1_address: string;
+    /**
+     *  UTC day, YYYY-MM-DD
+     * @type {string}
+     * @memberof ReqExportHistoricalTrades
+     */
+    date: string;
+}
+
+/**
+ * Check if a given object implements the ReqExportHistoricalTrades interface.
+ */
+export function instanceOfReqExportHistoricalTrades(value: object): value is ReqExportHistoricalTrades {
+    if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
+    if (!('date' in value) || value['date'] === undefined) return false;
+    return true;
+}
+
+export function ReqExportHistoricalTradesFromJSON(json: any): ReqExportHistoricalTrades {
+    return ReqExportHistoricalTradesFromJSONTyped(json, false);
+}
+
+export function ReqExportHistoricalTradesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqExportHistoricalTrades {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'auth': json['auth'] == null ? undefined : json['auth'],
+        'l1_address': json['l1_address'],
+        'date': json['date'],
+    };
+}
+
+export function ReqExportHistoricalTradesToJSON(value?: ReqExportHistoricalTrades | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'auth': value['auth'],
+        'l1_address': value['l1_address'],
+        'date': value['date'],
+    };
+}
+