zklighter-perps 1.0.188 → 1.0.189

package/.openapi-generator/FILES

@@ -40,6 +40,8 @@ models/Blocks.ts
 models/Bridge.ts
 models/BridgeSupportedNetwork.ts
 models/BridgeSupportedNetworks.ts
+models/Candle.ts
+models/Candles.ts
 models/Candlestick.ts
 models/Candlesticks.ts
 models/ContractAddress.ts
@@ -78,6 +80,7 @@ models/NextNonce.ts
 models/Order.ts
 models/OrderBook.ts
 models/OrderBookDepth.ts
+models/OrderBookDepthWithBeginNonce.ts
 models/OrderBookDetails.ts
 models/OrderBookOrders.ts
 models/OrderBookStats.ts
@@ -113,6 +116,7 @@ models/ReqGetBlock.ts
 models/ReqGetBlockTxs.ts
 models/ReqGetBridgesByL1Addr.ts
 models/ReqGetByAccount.ts
+models/ReqGetCandles.ts
 models/ReqGetCandlesticks.ts
 models/ReqGetDepositHistory.ts
 models/ReqGetFastWithdrawInfo.ts

package/apis/CandlestickApi.ts

@@ -15,11 +15,14 @@
 
 import * as runtime from '../runtime';
 import type {
+  Candles,
   Candlesticks,
   Fundings,
   ResultCode,
 } from '../models/index';
 import {
+    CandlesFromJSON,
+    CandlesToJSON,
     CandlesticksFromJSON,
     CandlesticksToJSON,
     FundingsFromJSON,
@@ -28,6 +31,15 @@ import {
     ResultCodeToJSON,
 } from '../models/index';
 
+export interface CandlesRequest {
+    market_id: number;
+    resolution: CandlesResolutionEnum;
+    start_timestamp: number;
+    end_timestamp: number;
+    count_back: number;
+    set_timestamp_to_end?: boolean;
+}
+
 export interface CandlesticksRequest {
     market_id: number;
     resolution: CandlesticksResolutionEnum;
@@ -50,6 +62,93 @@ export interface FundingsRequest {
  */
 export class CandlestickApi extends runtime.BaseAPI {
 
+    /**
+     * Get candles (optimized with shortened fields and smaller response size)
+     * candles
+     */
+    async candlesRaw(requestParameters: CandlesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Candles>> {
+        if (requestParameters['market_id'] == null) {
+            throw new runtime.RequiredError(
+                'market_id',
+                'Required parameter "market_id" was null or undefined when calling candles().'
+            );
+        }
+
+        if (requestParameters['resolution'] == null) {
+            throw new runtime.RequiredError(
+                'resolution',
+                'Required parameter "resolution" was null or undefined when calling candles().'
+            );
+        }
+
+        if (requestParameters['start_timestamp'] == null) {
+            throw new runtime.RequiredError(
+                'start_timestamp',
+                'Required parameter "start_timestamp" was null or undefined when calling candles().'
+            );
+        }
+
+        if (requestParameters['end_timestamp'] == null) {
+            throw new runtime.RequiredError(
+                'end_timestamp',
+                'Required parameter "end_timestamp" was null or undefined when calling candles().'
+            );
+        }
+
+        if (requestParameters['count_back'] == null) {
+            throw new runtime.RequiredError(
+                'count_back',
+                'Required parameter "count_back" was null or undefined when calling candles().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['market_id'] != null) {
+            queryParameters['market_id'] = requestParameters['market_id'];
+        }
+
+        if (requestParameters['resolution'] != null) {
+            queryParameters['resolution'] = requestParameters['resolution'];
+        }
+
+        if (requestParameters['start_timestamp'] != null) {
+            queryParameters['start_timestamp'] = requestParameters['start_timestamp'];
+        }
+
+        if (requestParameters['end_timestamp'] != null) {
+            queryParameters['end_timestamp'] = requestParameters['end_timestamp'];
+        }
+
+        if (requestParameters['count_back'] != null) {
+            queryParameters['count_back'] = requestParameters['count_back'];
+        }
+
+        if (requestParameters['set_timestamp_to_end'] != null) {
+            queryParameters['set_timestamp_to_end'] = requestParameters['set_timestamp_to_end'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/candles`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CandlesFromJSON(jsonValue));
+    }
+
+    /**
+     * Get candles (optimized with shortened fields and smaller response size)
+     * candles
+     */
+    async candles(requestParameters: CandlesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Candles> {
+        const response = await this.candlesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get candlesticks
      * candlesticks
@@ -222,6 +321,21 @@ export class CandlestickApi extends runtime.BaseAPI {
 
 }
 
+/**
+ * @export
+ */
+export const CandlesResolutionEnum = {
+    _1m: '1m',
+    _5m: '5m',
+    _15m: '15m',
+    _30m: '30m',
+    _1h: '1h',
+    _4h: '4h',
+    _12h: '12h',
+    _1d: '1d',
+    _1w: '1w'
+} as const;
+export type CandlesResolutionEnum = typeof CandlesResolutionEnum[keyof typeof CandlesResolutionEnum];
 /**
  * @export
  */

package/models/Account.ts

@@ -91,6 +91,12 @@ export interface Account {
      * @memberof Account
      */
     collateral: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof Account
+     */
+    transaction_time: number;
 }
 
 /**
@@ -108,6 +114,7 @@ export function instanceOfAccount(value: object): value is Account {
     if (!('available_balance' in value) || value['available_balance'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('collateral' in value) || value['collateral'] === undefined) return false;
+    if (!('transaction_time' in value) || value['transaction_time'] === undefined) return false;
     return true;
 }
 
@@ -133,6 +140,7 @@ export function AccountFromJSONTyped(json: any, ignoreDiscriminator: boolean): A
         'available_balance': json['available_balance'],
         'status': json['status'],
         'collateral': json['collateral'],
+        'transaction_time': json['transaction_time'],
     };
 }
 
@@ -154,6 +162,7 @@ export function AccountToJSON(value?: Account | null): any {
         'available_balance': value['available_balance'],
         'status': value['status'],
         'collateral': value['collateral'],
+        'transaction_time': value['transaction_time'],
     };
 }
 

package/models/ApiKey.ts

@@ -43,6 +43,12 @@ export interface ApiKey {
      * @memberof ApiKey
      */
     public_key: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiKey
+     */
+    transaction_time: number;
 }
 
 /**
@@ -53,6 +59,7 @@ export function instanceOfApiKey(value: object): value is ApiKey {
     if (!('api_key_index' in value) || value['api_key_index'] === undefined) return false;
     if (!('nonce' in value) || value['nonce'] === undefined) return false;
     if (!('public_key' in value) || value['public_key'] === undefined) return false;
+    if (!('transaction_time' in value) || value['transaction_time'] === undefined) return false;
     return true;
 }
 
@@ -70,6 +77,7 @@ export function ApiKeyFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ap
         'api_key_index': json['api_key_index'],
         'nonce': json['nonce'],
         'public_key': json['public_key'],
+        'transaction_time': json['transaction_time'],
     };
 }
 
@@ -83,6 +91,7 @@ export function ApiKeyToJSON(value?: ApiKey | null): any {
         'api_key_index': value['api_key_index'],
         'nonce': value['nonce'],
         'public_key': value['public_key'],
+        'transaction_time': value['transaction_time'],
     };
 }
 

package/models/Candle.ts

@@ -0,0 +1,160 @@
+/* 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 Candle
+ */
+export interface Candle {
+    /**
+     *  timestamp
+     * @type {number}
+     * @memberof Candle
+     */
+    t: number;
+    /**
+     *  open
+     * @type {number}
+     * @memberof Candle
+     */
+    o: number;
+    /**
+     *  high
+     * @type {number}
+     * @memberof Candle
+     */
+    h: number;
+    /**
+     *  low
+     * @type {number}
+     * @memberof Candle
+     */
+    l: number;
+    /**
+     *  close
+     * @type {number}
+     * @memberof Candle
+     */
+    c: number;
+    /**
+     *  open_raw
+     * @type {number}
+     * @memberof Candle
+     */
+    O: number;
+    /**
+     *  high_raw
+     * @type {number}
+     * @memberof Candle
+     */
+    H: number;
+    /**
+     *  low_raw
+     * @type {number}
+     * @memberof Candle
+     */
+    L: number;
+    /**
+     *  close_raw
+     * @type {number}
+     * @memberof Candle
+     */
+    C: number;
+    /**
+     *  volume0
+     * @type {number}
+     * @memberof Candle
+     */
+    v: number;
+    /**
+     *  volume1
+     * @type {number}
+     * @memberof Candle
+     */
+    V: number;
+    /**
+     *  last_trade_id
+     * @type {number}
+     * @memberof Candle
+     */
+    i: number;
+}
+
+/**
+ * Check if a given object implements the Candle interface.
+ */
+export function instanceOfCandle(value: object): value is Candle {
+    if (!('t' in value) || value['t'] === undefined) return false;
+    if (!('o' in value) || value['o'] === undefined) return false;
+    if (!('h' in value) || value['h'] === undefined) return false;
+    if (!('l' in value) || value['l'] === undefined) return false;
+    if (!('c' in value) || value['c'] === undefined) return false;
+    if (!('O' in value) || value['O'] === undefined) return false;
+    if (!('H' in value) || value['H'] === undefined) return false;
+    if (!('L' in value) || value['L'] === undefined) return false;
+    if (!('C' in value) || value['C'] === undefined) return false;
+    if (!('v' in value) || value['v'] === undefined) return false;
+    if (!('V' in value) || value['V'] === undefined) return false;
+    if (!('i' in value) || value['i'] === undefined) return false;
+    return true;
+}
+
+export function CandleFromJSON(json: any): Candle {
+    return CandleFromJSONTyped(json, false);
+}
+
+export function CandleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Candle {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        't': json['t'],
+        'o': json['o'],
+        'h': json['h'],
+        'l': json['l'],
+        'c': json['c'],
+        'O': json['O'],
+        'H': json['H'],
+        'L': json['L'],
+        'C': json['C'],
+        'v': json['v'],
+        'V': json['V'],
+        'i': json['i'],
+    };
+}
+
+export function CandleToJSON(value?: Candle | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        't': value['t'],
+        'o': value['o'],
+        'h': value['h'],
+        'l': value['l'],
+        'c': value['c'],
+        'O': value['O'],
+        'H': value['H'],
+        'L': value['L'],
+        'C': value['C'],
+        'v': value['v'],
+        'V': value['V'],
+        'i': value['i'],
+    };
+}
+

package/models/Candles.ts

@@ -0,0 +1,94 @@
+/* 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 { Candle } from './Candle';
+import {
+    CandleFromJSON,
+    CandleFromJSONTyped,
+    CandleToJSON,
+} from './Candle';
+
+/**
+ * 
+ * @export
+ * @interface Candles
+ */
+export interface Candles {
+    /**
+     * 
+     * @type {number}
+     * @memberof Candles
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Candles
+     */
+    message?: string;
+    /**
+     *  resolution
+     * @type {string}
+     * @memberof Candles
+     */
+    r: string;
+    /**
+     *  candles
+     * @type {Array<Candle>}
+     * @memberof Candles
+     */
+    c: Array<Candle>;
+}
+
+/**
+ * Check if a given object implements the Candles interface.
+ */
+export function instanceOfCandles(value: object): value is Candles {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('r' in value) || value['r'] === undefined) return false;
+    if (!('c' in value) || value['c'] === undefined) return false;
+    return true;
+}
+
+export function CandlesFromJSON(json: any): Candles {
+    return CandlesFromJSONTyped(json, false);
+}
+
+export function CandlesFromJSONTyped(json: any, ignoreDiscriminator: boolean): Candles {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'r': json['r'],
+        'c': ((json['c'] as Array<any>).map(CandleFromJSON)),
+    };
+}
+
+export function CandlesToJSON(value?: Candles | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'r': value['r'],
+        'c': ((value['c'] as Array<any>).map(CandleToJSON)),
+    };
+}
+

package/models/Candlestick.ts

@@ -91,6 +91,12 @@ export interface Candlestick {
      * @memberof Candlestick
      */
     last_trade_id: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Candlestick
+     */
+    trade_count: number;
 }
 
 /**
@@ -109,6 +115,7 @@ export function instanceOfCandlestick(value: object): value is Candlestick {
     if (!('volume0' in value) || value['volume0'] === undefined) return false;
     if (!('volume1' in value) || value['volume1'] === undefined) return false;
     if (!('last_trade_id' in value) || value['last_trade_id'] === undefined) return false;
+    if (!('trade_count' in value) || value['trade_count'] === undefined) return false;
     return true;
 }
 
@@ -134,6 +141,7 @@ export function CandlestickFromJSONTyped(json: any, ignoreDiscriminator: boolean
         'volume0': json['volume0'],
         'volume1': json['volume1'],
         'last_trade_id': json['last_trade_id'],
+        'trade_count': json['trade_count'],
     };
 }
 
@@ -155,6 +163,7 @@ export function CandlestickToJSON(value?: Candlestick | null): any {
         'volume0': value['volume0'],
         'volume1': value['volume1'],
         'last_trade_id': value['last_trade_id'],
+        'trade_count': value['trade_count'],
     };
 }
 

package/models/DetailedAccount.ts

@@ -116,6 +116,12 @@ export interface DetailedAccount {
      * @memberof DetailedAccount
      */
     collateral: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof DetailedAccount
+     */
+    transaction_time: number;
     /**
      * 
      * @type {number}
@@ -199,6 +205,7 @@ export function instanceOfDetailedAccount(value: object): value is DetailedAccou
     if (!('available_balance' in value) || value['available_balance'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('collateral' in value) || value['collateral'] === undefined) return false;
+    if (!('transaction_time' in value) || value['transaction_time'] === undefined) return false;
     if (!('account_index' in value) || value['account_index'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('description' in value) || value['description'] === undefined) return false;
@@ -235,6 +242,7 @@ export function DetailedAccountFromJSONTyped(json: any, ignoreDiscriminator: boo
         'available_balance': json['available_balance'],
         'status': json['status'],
         'collateral': json['collateral'],
+        'transaction_time': json['transaction_time'],
         'account_index': json['account_index'],
         'name': json['name'],
         'description': json['description'],
@@ -267,6 +275,7 @@ export function DetailedAccountToJSON(value?: DetailedAccount | null): any {
         'available_balance': value['available_balance'],
         'status': value['status'],
         'collateral': value['collateral'],
+        'transaction_time': value['transaction_time'],
         'account_index': value['account_index'],
         'name': value['name'],
         'description': value['description'],

package/models/EnrichedTx.ts

@@ -127,6 +127,12 @@ export interface EnrichedTx {
      * @memberof EnrichedTx
      */
     api_key_index: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof EnrichedTx
+     */
+    transaction_time: number;
     /**
      * 
      * @type {number}
@@ -162,6 +168,7 @@ export function instanceOfEnrichedTx(value: object): value is EnrichedTx {
     if (!('sequence_index' in value) || value['sequence_index'] === undefined) return false;
     if (!('parent_hash' in value) || value['parent_hash'] === undefined) return false;
     if (!('api_key_index' in value) || value['api_key_index'] === undefined) return false;
+    if (!('transaction_time' in value) || value['transaction_time'] === undefined) return false;
     if (!('committed_at' in value) || value['committed_at'] === undefined) return false;
     if (!('verified_at' in value) || value['verified_at'] === undefined) return false;
     return true;
@@ -195,6 +202,7 @@ export function EnrichedTxFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'sequence_index': json['sequence_index'],
         'parent_hash': json['parent_hash'],
         'api_key_index': json['api_key_index'],
+        'transaction_time': json['transaction_time'],
         'committed_at': json['committed_at'],
         'verified_at': json['verified_at'],
     };
@@ -224,6 +232,7 @@ export function EnrichedTxToJSON(value?: EnrichedTx | null): any {
         'sequence_index': value['sequence_index'],
         'parent_hash': value['parent_hash'],
         'api_key_index': value['api_key_index'],
+        'transaction_time': value['transaction_time'],
         'committed_at': value['committed_at'],
         'verified_at': value['verified_at'],
     };

package/models/LiqTrade.ts

@@ -43,6 +43,12 @@ export interface LiqTrade {
      * @memberof LiqTrade
      */
     maker_fee: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof LiqTrade
+     */
+    transaction_time: number;
 }
 
 /**
@@ -53,6 +59,7 @@ export function instanceOfLiqTrade(value: object): value is LiqTrade {
     if (!('size' in value) || value['size'] === undefined) return false;
     if (!('taker_fee' in value) || value['taker_fee'] === undefined) return false;
     if (!('maker_fee' in value) || value['maker_fee'] === undefined) return false;
+    if (!('transaction_time' in value) || value['transaction_time'] === undefined) return false;
     return true;
 }
 
@@ -70,6 +77,7 @@ export function LiqTradeFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'size': json['size'],
         'taker_fee': json['taker_fee'],
         'maker_fee': json['maker_fee'],
+        'transaction_time': json['transaction_time'],
     };
 }
 
@@ -83,6 +91,7 @@ export function LiqTradeToJSON(value?: LiqTrade | null): any {
         'size': value['size'],
         'taker_fee': value['taker_fee'],
         'maker_fee': value['maker_fee'],
+        'transaction_time': value['transaction_time'],
     };
 }
 

package/models/Order.ts

@@ -217,6 +217,12 @@ export interface Order {
      * @memberof Order
      */
     updated_at: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Order
+     */
+    transaction_time: number;
 }
 
 
@@ -321,6 +327,7 @@ export function instanceOfOrder(value: object): value is Order {
     if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
     if (!('created_at' in value) || value['created_at'] === undefined) return false;
     if (!('updated_at' in value) || value['updated_at'] === undefined) return false;
+    if (!('transaction_time' in value) || value['transaction_time'] === undefined) return false;
     return true;
 }
 
@@ -367,6 +374,7 @@ export function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ord
         'timestamp': json['timestamp'],
         'created_at': json['created_at'],
         'updated_at': json['updated_at'],
+        'transaction_time': json['transaction_time'],
     };
 }
 
@@ -409,6 +417,7 @@ export function OrderToJSON(value?: Order | null): any {
         'timestamp': value['timestamp'],
         'created_at': value['created_at'],
         'updated_at': value['updated_at'],
+        'transaction_time': value['transaction_time'],
     };
 }