zklighter-perps 1.0.314 → 1.0.316

package/.openapi-generator/FILES

@@ -24,6 +24,7 @@ apis/StockfinancialsApi.ts
 apis/TokenlistApi.ts
 apis/TransactionApi.ts
 apis/TvApi.ts
+apis/UpdownApi.ts
 apis/index.ts
 index.ts
 models/Account.ts
@@ -147,6 +148,8 @@ models/PositionFundings.ts
 models/PriceAlert.ts
 models/PriceChangeAlert.ts
 models/PriceLevel.ts
+models/PriceOracleMarket.ts
+models/PriceOraclePrice.ts
 models/PublicPoolInfo.ts
 models/PublicPoolMetadata.ts
 models/PublicPoolShare.ts
@@ -215,6 +218,7 @@ models/ReqGetOrderBooks.ts
 models/ReqGetPartnerStats.ts
 models/ReqGetPnlLeaderboard.ts
 models/ReqGetPositionFunding.ts
+models/ReqGetPriceOracleInfo.ts
 models/ReqGetPublicPoolsMetadata.ts
 models/ReqGetPushNotifSettings.ts
 models/ReqGetRFQ.ts
@@ -232,6 +236,7 @@ models/ReqGetTrades.ts
 models/ReqGetTransferFeeInfo.ts
 models/ReqGetTransferHistory.ts
 models/ReqGetTx.ts
+models/ReqGetUpDownCandles.ts
 models/ReqGetUserReferrals.ts
 models/ReqGetWithdrawHistory.ts
 models/ReqGuildByReferralCode.ts
@@ -265,6 +270,7 @@ models/RespGetMakerOnlyApiKeys.ts
 models/RespGetMarketMetrics.ts
 models/RespGetPushNotifSettings.ts
 models/RespGetRFQ.ts
+models/RespGetUpDownCandles.ts
 models/RespGuildByReferralCode.ts
 models/RespGuildInviteCodes.ts
 models/RespGuildJoinRequest.ts
@@ -274,6 +280,7 @@ models/RespGuildMembership.ts
 models/RespListMarketNews.ts
 models/RespListRFQs.ts
 models/RespPostApiToken.ts
+models/RespPriceOracleInfo.ts
 models/RespPublicPoolsMetadata.ts
 models/RespRegisterEventOrderBook.ts
 models/RespResolveGuildJoinRequest.ts
@@ -339,6 +346,7 @@ models/Tx.ts
 models/TxHash.ts
 models/TxHashes.ts
 models/Txs.ts
+models/UpDownCandle.ts
 models/UpcomingEarning.ts
 models/UpcomingEarnings.ts
 models/UserReferrals.ts

package/apis/InfoApi.ts

@@ -16,6 +16,7 @@
 import * as runtime from '../runtime';
 import type {
   Layer1BasicInfo,
+  RespPriceOracleInfo,
   RespRollingInfo,
   RespSyntheticSpotInfo,
   RespWithdrawalDelay,
@@ -26,6 +27,8 @@ import type {
 import {
     Layer1BasicInfoFromJSON,
     Layer1BasicInfoToJSON,
+    RespPriceOracleInfoFromJSON,
+    RespPriceOracleInfoToJSON,
     RespRollingInfoFromJSON,
     RespRollingInfoToJSON,
     RespSyntheticSpotInfoFromJSON,
@@ -40,6 +43,10 @@ import {
     TransferFeeInfoToJSON,
 } from '../models/index';
 
+export interface PriceOracleInfoRequest {
+    symbol?: string;
+}
+
 export interface RollingInfoRequest {
     symbol: string;
 }
@@ -86,6 +93,38 @@ export class InfoApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get price oracle info (source in use, median exchanges, price cap) for all markets or a single symbol
+     * priceOracleInfo
+     */
+    async priceOracleInfoRaw(requestParameters: PriceOracleInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespPriceOracleInfo>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['symbol'] != null) {
+            queryParameters['symbol'] = requestParameters['symbol'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/priceOracleInfo`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespPriceOracleInfoFromJSON(jsonValue));
+    }
+
+    /**
+     * Get price oracle info (source in use, median exchanges, price cap) for all markets or a single symbol
+     * priceOracleInfo
+     */
+    async priceOracleInfo(requestParameters: PriceOracleInfoRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespPriceOracleInfo> {
+        const response = await this.priceOracleInfoRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get rolling futures info for a symbol
      * rollingInfo

package/apis/UpdownApi.ts

@@ -0,0 +1,131 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  RespGetUpDownCandles,
+  ResultCode,
+} from '../models/index';
+import {
+    RespGetUpDownCandlesFromJSON,
+    RespGetUpDownCandlesToJSON,
+    ResultCodeFromJSON,
+    ResultCodeToJSON,
+} from '../models/index';
+
+export interface UpDownCandlesRequest {
+    symbol: string;
+    duration: string;
+    start_timestamp: number;
+    end_timestamp: number;
+    resolution?: UpDownCandlesResolutionEnum;
+    limit?: number;
+}
+
+/**
+ * 
+ */
+export class UpdownApi extends runtime.BaseAPI {
+
+    /**
+     * Get the OHLC candles (1s = the exact price observations, or 30s) of an up/down market series (symbol + duration, e.g. btc/5m) in a bounded time range (at most 24h), oldest first. Pass next_cursor as start_timestamp to page forward; live candles are on the up_down_candle/<symbol>/<duration>/<resolution> websocket channel.
+     * upDownCandles
+     */
+    async upDownCandlesRaw(requestParameters: UpDownCandlesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespGetUpDownCandles>> {
+        if (requestParameters['symbol'] == null) {
+            throw new runtime.RequiredError(
+                'symbol',
+                'Required parameter "symbol" was null or undefined when calling upDownCandles().'
+            );
+        }
+
+        if (requestParameters['duration'] == null) {
+            throw new runtime.RequiredError(
+                'duration',
+                'Required parameter "duration" was null or undefined when calling upDownCandles().'
+            );
+        }
+
+        if (requestParameters['start_timestamp'] == null) {
+            throw new runtime.RequiredError(
+                'start_timestamp',
+                'Required parameter "start_timestamp" was null or undefined when calling upDownCandles().'
+            );
+        }
+
+        if (requestParameters['end_timestamp'] == null) {
+            throw new runtime.RequiredError(
+                'end_timestamp',
+                'Required parameter "end_timestamp" was null or undefined when calling upDownCandles().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['symbol'] != null) {
+            queryParameters['symbol'] = requestParameters['symbol'];
+        }
+
+        if (requestParameters['duration'] != null) {
+            queryParameters['duration'] = requestParameters['duration'];
+        }
+
+        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['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/upDownCandles`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespGetUpDownCandlesFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the OHLC candles (1s = the exact price observations, or 30s) of an up/down market series (symbol + duration, e.g. btc/5m) in a bounded time range (at most 24h), oldest first. Pass next_cursor as start_timestamp to page forward; live candles are on the up_down_candle/<symbol>/<duration>/<resolution> websocket channel.
+     * upDownCandles
+     */
+    async upDownCandles(requestParameters: UpDownCandlesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespGetUpDownCandles> {
+        const response = await this.upDownCandlesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const UpDownCandlesResolutionEnum = {
+    _1s: '1s',
+    _30s: '30s'
+} as const;
+export type UpDownCandlesResolutionEnum = typeof UpDownCandlesResolutionEnum[keyof typeof UpDownCandlesResolutionEnum];

package/apis/index.ts

@@ -26,3 +26,4 @@ export * from './StockfinancialsApi';
 export * from './TokenlistApi';
 export * from './TransactionApi';
 export * from './TvApi';
+export * from './UpdownApi';

package/models/AccountBinaryOptionsPosition.ts

@@ -42,7 +42,7 @@ export interface AccountBinaryOptionsPosition {
      * @type {number}
      * @memberof AccountBinaryOptionsPosition
      */
-    sign: number;
+    sign: AccountBinaryOptionsPositionSignEnum;
     /**
      *  magnitude only; combine with sign
      * @type {string}
@@ -51,6 +51,17 @@ export interface AccountBinaryOptionsPosition {
     size: string;
 }
 
+
+/**
+ * @export
+ */
+export const AccountBinaryOptionsPositionSignEnum = {
+    No: -1,
+    Yes: 1
+} as const;
+export type AccountBinaryOptionsPositionSignEnum = typeof AccountBinaryOptionsPositionSignEnum[keyof typeof AccountBinaryOptionsPositionSignEnum];
+
+
 /**
  * Check if a given object implements the AccountBinaryOptionsPosition interface.
  */

package/models/AccountPosition.ts

@@ -60,7 +60,7 @@ export interface AccountPosition {
      * @type {number}
      * @memberof AccountPosition
      */
-    sign: number;
+    sign: AccountPositionSignEnum;
     /**
      * 
      * @type {string}
@@ -130,6 +130,15 @@ export interface AccountPosition {
 }
 
 
+/**
+ * @export
+ */
+export const AccountPositionSignEnum = {
+    Short: -1,
+    Long: 1
+} as const;
+export type AccountPositionSignEnum = typeof AccountPositionSignEnum[keyof typeof AccountPositionSignEnum];
+
 /**
  * @export
  */

package/models/PriceOracleMarket.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 { PriceOraclePrice } from './PriceOraclePrice';
+import {
+    PriceOraclePriceFromJSON,
+    PriceOraclePriceFromJSONTyped,
+    PriceOraclePriceToJSON,
+} from './PriceOraclePrice';
+
+/**
+ * 
+ * @export
+ * @interface PriceOracleMarket
+ */
+export interface PriceOracleMarket {
+    /**
+     * 
+     * @type {string}
+     * @memberof PriceOracleMarket
+     */
+    symbol: string;
+    /**
+     * 
+     * @type {PriceOraclePrice}
+     * @memberof PriceOracleMarket
+     */
+    index: PriceOraclePrice;
+    /**
+     * 
+     * @type {PriceOraclePrice}
+     * @memberof PriceOracleMarket
+     */
+    mark: PriceOraclePrice;
+}
+
+/**
+ * Check if a given object implements the PriceOracleMarket interface.
+ */
+export function instanceOfPriceOracleMarket(value: object): value is PriceOracleMarket {
+    if (!('symbol' in value) || value['symbol'] === undefined) return false;
+    if (!('index' in value) || value['index'] === undefined) return false;
+    if (!('mark' in value) || value['mark'] === undefined) return false;
+    return true;
+}
+
+export function PriceOracleMarketFromJSON(json: any): PriceOracleMarket {
+    return PriceOracleMarketFromJSONTyped(json, false);
+}
+
+export function PriceOracleMarketFromJSONTyped(json: any, ignoreDiscriminator: boolean): PriceOracleMarket {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'symbol': json['symbol'],
+        'index': PriceOraclePriceFromJSON(json['index']),
+        'mark': PriceOraclePriceFromJSON(json['mark']),
+    };
+}
+
+export function PriceOracleMarketToJSON(value?: PriceOracleMarket | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'symbol': value['symbol'],
+        'index': PriceOraclePriceToJSON(value['index']),
+        'mark': PriceOraclePriceToJSON(value['mark']),
+    };
+}
+

package/models/PriceOraclePrice.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 PriceOraclePrice
+ */
+export interface PriceOraclePrice {
+    /**
+     * 
+     * @type {string}
+     * @memberof PriceOraclePrice
+     */
+    source: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PriceOraclePrice
+     */
+    using_median: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PriceOraclePrice
+     */
+    using_internal_price: boolean;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof PriceOraclePrice
+     */
+    median_sources: Array<string>;
+    /**
+     * 
+     * @type {number}
+     * @memberof PriceOraclePrice
+     */
+    price_cap_bps: number;
+    /**
+     *  cap bounds: ref * (1 -/+ bps / 10000)
+     * @type {number}
+     * @memberof PriceOraclePrice
+     */
+    price_cap_reference_price: number;
+}
+
+/**
+ * Check if a given object implements the PriceOraclePrice interface.
+ */
+export function instanceOfPriceOraclePrice(value: object): value is PriceOraclePrice {
+    if (!('source' in value) || value['source'] === undefined) return false;
+    if (!('using_median' in value) || value['using_median'] === undefined) return false;
+    if (!('using_internal_price' in value) || value['using_internal_price'] === undefined) return false;
+    if (!('median_sources' in value) || value['median_sources'] === undefined) return false;
+    if (!('price_cap_bps' in value) || value['price_cap_bps'] === undefined) return false;
+    if (!('price_cap_reference_price' in value) || value['price_cap_reference_price'] === undefined) return false;
+    return true;
+}
+
+export function PriceOraclePriceFromJSON(json: any): PriceOraclePrice {
+    return PriceOraclePriceFromJSONTyped(json, false);
+}
+
+export function PriceOraclePriceFromJSONTyped(json: any, ignoreDiscriminator: boolean): PriceOraclePrice {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'source': json['source'],
+        'using_median': json['using_median'],
+        'using_internal_price': json['using_internal_price'],
+        'median_sources': json['median_sources'],
+        'price_cap_bps': json['price_cap_bps'],
+        'price_cap_reference_price': json['price_cap_reference_price'],
+    };
+}
+
+export function PriceOraclePriceToJSON(value?: PriceOraclePrice | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'source': value['source'],
+        'using_median': value['using_median'],
+        'using_internal_price': value['using_internal_price'],
+        'median_sources': value['median_sources'],
+        'price_cap_bps': value['price_cap_bps'],
+        'price_cap_reference_price': value['price_cap_reference_price'],
+    };
+}
+

package/models/ReqGetPriceOracleInfo.ts

@@ -0,0 +1,60 @@
+/* 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 ReqGetPriceOracleInfo
+ */
+export interface ReqGetPriceOracleInfo {
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetPriceOracleInfo
+     */
+    symbol?: string;
+}
+
+/**
+ * Check if a given object implements the ReqGetPriceOracleInfo interface.
+ */
+export function instanceOfReqGetPriceOracleInfo(value: object): value is ReqGetPriceOracleInfo {
+    return true;
+}
+
+export function ReqGetPriceOracleInfoFromJSON(json: any): ReqGetPriceOracleInfo {
+    return ReqGetPriceOracleInfoFromJSONTyped(json, false);
+}
+
+export function ReqGetPriceOracleInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetPriceOracleInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'symbol': json['symbol'] == null ? undefined : json['symbol'],
+    };
+}
+
+export function ReqGetPriceOracleInfoToJSON(value?: ReqGetPriceOracleInfo | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'symbol': value['symbol'],
+    };
+}
+

package/models/ReqGetUpDownCandles.ts

@@ -0,0 +1,115 @@
+/* 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 ReqGetUpDownCandles
+ */
+export interface ReqGetUpDownCandles {
+    /**
+     *  market series: underlying (case-insensitive) ...
+     * @type {string}
+     * @memberof ReqGetUpDownCandles
+     */
+    symbol: string;
+    /**
+     *  ... and market duration, e.g. 30s or 5m
+     * @type {string}
+     * @memberof ReqGetUpDownCandles
+     */
+    duration: string;
+    /**
+     *  1s candles are the observations themselves
+     * @type {string}
+     * @memberof ReqGetUpDownCandles
+     */
+    resolution?: ReqGetUpDownCandlesResolutionEnum;
+    /**
+     *  inclusive bucket start, seconds
+     * @type {number}
+     * @memberof ReqGetUpDownCandles
+     */
+    start_timestamp: number;
+    /**
+     *  inclusive, seconds; at most 24h after start_timestamp
+     * @type {number}
+     * @memberof ReqGetUpDownCandles
+     */
+    end_timestamp: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetUpDownCandles
+     */
+    limit?: number;
+}
+
+
+/**
+ * @export
+ */
+export const ReqGetUpDownCandlesResolutionEnum = {
+    _1s: '1s',
+    _30s: '30s'
+} as const;
+export type ReqGetUpDownCandlesResolutionEnum = typeof ReqGetUpDownCandlesResolutionEnum[keyof typeof ReqGetUpDownCandlesResolutionEnum];
+
+
+/**
+ * Check if a given object implements the ReqGetUpDownCandles interface.
+ */
+export function instanceOfReqGetUpDownCandles(value: object): value is ReqGetUpDownCandles {
+    if (!('symbol' in value) || value['symbol'] === undefined) return false;
+    if (!('duration' in value) || value['duration'] === undefined) return false;
+    if (!('start_timestamp' in value) || value['start_timestamp'] === undefined) return false;
+    if (!('end_timestamp' in value) || value['end_timestamp'] === undefined) return false;
+    return true;
+}
+
+export function ReqGetUpDownCandlesFromJSON(json: any): ReqGetUpDownCandles {
+    return ReqGetUpDownCandlesFromJSONTyped(json, false);
+}
+
+export function ReqGetUpDownCandlesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetUpDownCandles {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'symbol': json['symbol'],
+        'duration': json['duration'],
+        'resolution': json['resolution'] == null ? undefined : json['resolution'],
+        'start_timestamp': json['start_timestamp'],
+        'end_timestamp': json['end_timestamp'],
+        'limit': json['limit'] == null ? undefined : json['limit'],
+    };
+}
+
+export function ReqGetUpDownCandlesToJSON(value?: ReqGetUpDownCandles | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'symbol': value['symbol'],
+        'duration': value['duration'],
+        'resolution': value['resolution'],
+        'start_timestamp': value['start_timestamp'],
+        'end_timestamp': value['end_timestamp'],
+        'limit': value['limit'],
+    };
+}
+