pmxtjs 2.42.2 → 2.42.3

package/generated/src/apis/DataFeedsApi.ts

@@ -0,0 +1,624 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * PMXT Sidecar API
+ * A unified local sidecar API for prediction markets (Polymarket, Kalshi, Limitless). This API acts as a JSON-RPC-style gateway. Each endpoint corresponds to a specific method on the generic exchange implementation.
+ *
+ * The version of the OpenAPI document: 0.4.4
+ * 
+ *
+ * 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 {
+  FeedFetchHistoricalPrices200Response,
+  FeedFetchOHLCV200Response,
+  FeedFetchOracleHistory200Response,
+  FeedFetchOracleRound200Response,
+  FeedFetchOrderBook200Response,
+  FeedFetchTicker200Response,
+  FeedFetchTickers200Response,
+  FeedList200Response,
+  FeedLoadMarkets200Response,
+} from '../models/index';
+import {
+    FeedFetchHistoricalPrices200ResponseFromJSON,
+    FeedFetchHistoricalPrices200ResponseToJSON,
+    FeedFetchOHLCV200ResponseFromJSON,
+    FeedFetchOHLCV200ResponseToJSON,
+    FeedFetchOracleHistory200ResponseFromJSON,
+    FeedFetchOracleHistory200ResponseToJSON,
+    FeedFetchOracleRound200ResponseFromJSON,
+    FeedFetchOracleRound200ResponseToJSON,
+    FeedFetchOrderBook200ResponseFromJSON,
+    FeedFetchOrderBook200ResponseToJSON,
+    FeedFetchTicker200ResponseFromJSON,
+    FeedFetchTicker200ResponseToJSON,
+    FeedFetchTickers200ResponseFromJSON,
+    FeedFetchTickers200ResponseToJSON,
+    FeedList200ResponseFromJSON,
+    FeedList200ResponseToJSON,
+    FeedLoadMarkets200ResponseFromJSON,
+    FeedLoadMarkets200ResponseToJSON,
+} from '../models/index';
+
+export interface FeedFetchHistoricalPricesRequest {
+    feed: FeedFetchHistoricalPricesFeedEnum;
+    symbol: string;
+    fromTimestamp?: number;
+    untilTimestamp?: number;
+    maxSize?: number;
+    order?: FeedFetchHistoricalPricesOrderEnum;
+}
+
+export interface FeedFetchOHLCVRequest {
+    feed: FeedFetchOHLCVFeedEnum;
+    symbol: string;
+    timeframe?: string;
+    since?: number;
+    limit?: number;
+}
+
+export interface FeedFetchOracleHistoryRequest {
+    feed: FeedFetchOracleHistoryFeedEnum;
+    feed2: string;
+    limit?: number;
+}
+
+export interface FeedFetchOracleRoundRequest {
+    feed: FeedFetchOracleRoundFeedEnum;
+    feed2: string;
+}
+
+export interface FeedFetchOrderBookRequest {
+    feed: FeedFetchOrderBookFeedEnum;
+    symbol: string;
+    limit?: number;
+}
+
+export interface FeedFetchTickerRequest {
+    feed: FeedFetchTickerFeedEnum;
+    symbol: string;
+}
+
+export interface FeedFetchTickersRequest {
+    feed: FeedFetchTickersFeedEnum;
+    symbols?: string;
+}
+
+export interface FeedLoadMarketsRequest {
+    feed: FeedLoadMarketsFeedEnum;
+}
+
+/**
+ * 
+ */
+export class DataFeedsApi extends runtime.BaseAPI {
+
+    /**
+     * Returns historical price data as tickers within a time range.
+     * Fetch Historical Prices
+     */
+    async feedFetchHistoricalPricesRaw(requestParameters: FeedFetchHistoricalPricesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedFetchHistoricalPrices200Response>> {
+        if (requestParameters['feed'] == null) {
+            throw new runtime.RequiredError(
+                'feed',
+                'Required parameter "feed" was null or undefined when calling feedFetchHistoricalPrices().'
+            );
+        }
+
+        if (requestParameters['symbol'] == null) {
+            throw new runtime.RequiredError(
+                'symbol',
+                'Required parameter "symbol" was null or undefined when calling feedFetchHistoricalPrices().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['symbol'] != null) {
+            queryParameters['symbol'] = requestParameters['symbol'];
+        }
+
+        if (requestParameters['fromTimestamp'] != null) {
+            queryParameters['fromTimestamp'] = requestParameters['fromTimestamp'];
+        }
+
+        if (requestParameters['untilTimestamp'] != null) {
+            queryParameters['untilTimestamp'] = requestParameters['untilTimestamp'];
+        }
+
+        if (requestParameters['maxSize'] != null) {
+            queryParameters['maxSize'] = requestParameters['maxSize'];
+        }
+
+        if (requestParameters['order'] != null) {
+            queryParameters['order'] = requestParameters['order'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/feeds/{feed}/fetchHistoricalPrices`;
+        urlPath = urlPath.replace(`{${"feed"}}`, encodeURIComponent(String(requestParameters['feed'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FeedFetchHistoricalPrices200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns historical price data as tickers within a time range.
+     * Fetch Historical Prices
+     */
+    async feedFetchHistoricalPrices(requestParameters: FeedFetchHistoricalPricesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedFetchHistoricalPrices200Response> {
+        const response = await this.feedFetchHistoricalPricesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns OHLCV candle data for a symbol.
+     * Fetch OHLCV
+     */
+    async feedFetchOHLCVRaw(requestParameters: FeedFetchOHLCVRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedFetchOHLCV200Response>> {
+        if (requestParameters['feed'] == null) {
+            throw new runtime.RequiredError(
+                'feed',
+                'Required parameter "feed" was null or undefined when calling feedFetchOHLCV().'
+            );
+        }
+
+        if (requestParameters['symbol'] == null) {
+            throw new runtime.RequiredError(
+                'symbol',
+                'Required parameter "symbol" was null or undefined when calling feedFetchOHLCV().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['symbol'] != null) {
+            queryParameters['symbol'] = requestParameters['symbol'];
+        }
+
+        if (requestParameters['timeframe'] != null) {
+            queryParameters['timeframe'] = requestParameters['timeframe'];
+        }
+
+        if (requestParameters['since'] != null) {
+            queryParameters['since'] = requestParameters['since'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/feeds/{feed}/fetchOHLCV`;
+        urlPath = urlPath.replace(`{${"feed"}}`, encodeURIComponent(String(requestParameters['feed'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FeedFetchOHLCV200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns OHLCV candle data for a symbol.
+     * Fetch OHLCV
+     */
+    async feedFetchOHLCV(requestParameters: FeedFetchOHLCVRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedFetchOHLCV200Response> {
+        const response = await this.feedFetchOHLCVRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns historical Chainlink oracle rounds for a price feed.
+     * Fetch Oracle History
+     */
+    async feedFetchOracleHistoryRaw(requestParameters: FeedFetchOracleHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedFetchOracleHistory200Response>> {
+        if (requestParameters['feed'] == null) {
+            throw new runtime.RequiredError(
+                'feed',
+                'Required parameter "feed" was null or undefined when calling feedFetchOracleHistory().'
+            );
+        }
+
+        if (requestParameters['feed2'] == null) {
+            throw new runtime.RequiredError(
+                'feed2',
+                'Required parameter "feed2" was null or undefined when calling feedFetchOracleHistory().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['feed2'] != null) {
+            queryParameters['feed'] = requestParameters['feed2'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/feeds/{feed}/fetchOracleHistory`;
+        urlPath = urlPath.replace(`{${"feed"}}`, encodeURIComponent(String(requestParameters['feed'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FeedFetchOracleHistory200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns historical Chainlink oracle rounds for a price feed.
+     * Fetch Oracle History
+     */
+    async feedFetchOracleHistory(requestParameters: FeedFetchOracleHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedFetchOracleHistory200Response> {
+        const response = await this.feedFetchOracleHistoryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns the latest Chainlink oracle round for a price feed.
+     * Fetch Oracle Round
+     */
+    async feedFetchOracleRoundRaw(requestParameters: FeedFetchOracleRoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedFetchOracleRound200Response>> {
+        if (requestParameters['feed'] == null) {
+            throw new runtime.RequiredError(
+                'feed',
+                'Required parameter "feed" was null or undefined when calling feedFetchOracleRound().'
+            );
+        }
+
+        if (requestParameters['feed2'] == null) {
+            throw new runtime.RequiredError(
+                'feed2',
+                'Required parameter "feed2" was null or undefined when calling feedFetchOracleRound().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['feed2'] != null) {
+            queryParameters['feed'] = requestParameters['feed2'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/feeds/{feed}/fetchOracleRound`;
+        urlPath = urlPath.replace(`{${"feed"}}`, encodeURIComponent(String(requestParameters['feed'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FeedFetchOracleRound200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the latest Chainlink oracle round for a price feed.
+     * Fetch Oracle Round
+     */
+    async feedFetchOracleRound(requestParameters: FeedFetchOracleRoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedFetchOracleRound200Response> {
+        const response = await this.feedFetchOracleRoundRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns the current order book for a symbol (where supported).
+     * Fetch Order Book
+     */
+    async feedFetchOrderBookRaw(requestParameters: FeedFetchOrderBookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedFetchOrderBook200Response>> {
+        if (requestParameters['feed'] == null) {
+            throw new runtime.RequiredError(
+                'feed',
+                'Required parameter "feed" was null or undefined when calling feedFetchOrderBook().'
+            );
+        }
+
+        if (requestParameters['symbol'] == null) {
+            throw new runtime.RequiredError(
+                'symbol',
+                'Required parameter "symbol" was null or undefined when calling feedFetchOrderBook().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['symbol'] != null) {
+            queryParameters['symbol'] = requestParameters['symbol'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/feeds/{feed}/fetchOrderBook`;
+        urlPath = urlPath.replace(`{${"feed"}}`, encodeURIComponent(String(requestParameters['feed'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FeedFetchOrderBook200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the current order book for a symbol (where supported).
+     * Fetch Order Book
+     */
+    async feedFetchOrderBook(requestParameters: FeedFetchOrderBookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedFetchOrderBook200Response> {
+        const response = await this.feedFetchOrderBookRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns the latest ticker for a single symbol.
+     * Fetch Ticker
+     */
+    async feedFetchTickerRaw(requestParameters: FeedFetchTickerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedFetchTicker200Response>> {
+        if (requestParameters['feed'] == null) {
+            throw new runtime.RequiredError(
+                'feed',
+                'Required parameter "feed" was null or undefined when calling feedFetchTicker().'
+            );
+        }
+
+        if (requestParameters['symbol'] == null) {
+            throw new runtime.RequiredError(
+                'symbol',
+                'Required parameter "symbol" was null or undefined when calling feedFetchTicker().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['symbol'] != null) {
+            queryParameters['symbol'] = requestParameters['symbol'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/feeds/{feed}/fetchTicker`;
+        urlPath = urlPath.replace(`{${"feed"}}`, encodeURIComponent(String(requestParameters['feed'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FeedFetchTicker200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the latest ticker for a single symbol.
+     * Fetch Ticker
+     */
+    async feedFetchTicker(requestParameters: FeedFetchTickerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedFetchTicker200Response> {
+        const response = await this.feedFetchTickerRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns the latest tickers for all symbols, or a filtered subset.
+     * Fetch Tickers
+     */
+    async feedFetchTickersRaw(requestParameters: FeedFetchTickersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedFetchTickers200Response>> {
+        if (requestParameters['feed'] == null) {
+            throw new runtime.RequiredError(
+                'feed',
+                'Required parameter "feed" was null or undefined when calling feedFetchTickers().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['symbols'] != null) {
+            queryParameters['symbols'] = requestParameters['symbols'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/feeds/{feed}/fetchTickers`;
+        urlPath = urlPath.replace(`{${"feed"}}`, encodeURIComponent(String(requestParameters['feed'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FeedFetchTickers200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the latest tickers for all symbols, or a filtered subset.
+     * Fetch Tickers
+     */
+    async feedFetchTickers(requestParameters: FeedFetchTickersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedFetchTickers200Response> {
+        const response = await this.feedFetchTickersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns the list of available data feed providers.
+     * List Available Feeds
+     */
+    async feedListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedList200Response>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/feeds`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FeedList200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the list of available data feed providers.
+     * List Available Feeds
+     */
+    async feedList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedList200Response> {
+        const response = await this.feedListRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns all trading pairs supported by this feed.
+     * Load Feed Markets
+     */
+    async feedLoadMarketsRaw(requestParameters: FeedLoadMarketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedLoadMarkets200Response>> {
+        if (requestParameters['feed'] == null) {
+            throw new runtime.RequiredError(
+                'feed',
+                'Required parameter "feed" was null or undefined when calling feedLoadMarkets().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/feeds/{feed}/loadMarkets`;
+        urlPath = urlPath.replace(`{${"feed"}}`, encodeURIComponent(String(requestParameters['feed'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FeedLoadMarkets200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns all trading pairs supported by this feed.
+     * Load Feed Markets
+     */
+    async feedLoadMarkets(requestParameters: FeedLoadMarketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedLoadMarkets200Response> {
+        const response = await this.feedLoadMarketsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const FeedFetchHistoricalPricesFeedEnum = {
+    Binance: 'binance',
+    Chainlink: 'chainlink'
+} as const;
+export type FeedFetchHistoricalPricesFeedEnum = typeof FeedFetchHistoricalPricesFeedEnum[keyof typeof FeedFetchHistoricalPricesFeedEnum];
+/**
+ * @export
+ */
+export const FeedFetchHistoricalPricesOrderEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type FeedFetchHistoricalPricesOrderEnum = typeof FeedFetchHistoricalPricesOrderEnum[keyof typeof FeedFetchHistoricalPricesOrderEnum];
+/**
+ * @export
+ */
+export const FeedFetchOHLCVFeedEnum = {
+    Binance: 'binance',
+    Chainlink: 'chainlink'
+} as const;
+export type FeedFetchOHLCVFeedEnum = typeof FeedFetchOHLCVFeedEnum[keyof typeof FeedFetchOHLCVFeedEnum];
+/**
+ * @export
+ */
+export const FeedFetchOracleHistoryFeedEnum = {
+    Binance: 'binance',
+    Chainlink: 'chainlink'
+} as const;
+export type FeedFetchOracleHistoryFeedEnum = typeof FeedFetchOracleHistoryFeedEnum[keyof typeof FeedFetchOracleHistoryFeedEnum];
+/**
+ * @export
+ */
+export const FeedFetchOracleRoundFeedEnum = {
+    Binance: 'binance',
+    Chainlink: 'chainlink'
+} as const;
+export type FeedFetchOracleRoundFeedEnum = typeof FeedFetchOracleRoundFeedEnum[keyof typeof FeedFetchOracleRoundFeedEnum];
+/**
+ * @export
+ */
+export const FeedFetchOrderBookFeedEnum = {
+    Binance: 'binance',
+    Chainlink: 'chainlink'
+} as const;
+export type FeedFetchOrderBookFeedEnum = typeof FeedFetchOrderBookFeedEnum[keyof typeof FeedFetchOrderBookFeedEnum];
+/**
+ * @export
+ */
+export const FeedFetchTickerFeedEnum = {
+    Binance: 'binance',
+    Chainlink: 'chainlink'
+} as const;
+export type FeedFetchTickerFeedEnum = typeof FeedFetchTickerFeedEnum[keyof typeof FeedFetchTickerFeedEnum];
+/**
+ * @export
+ */
+export const FeedFetchTickersFeedEnum = {
+    Binance: 'binance',
+    Chainlink: 'chainlink'
+} as const;
+export type FeedFetchTickersFeedEnum = typeof FeedFetchTickersFeedEnum[keyof typeof FeedFetchTickersFeedEnum];
+/**
+ * @export
+ */
+export const FeedLoadMarketsFeedEnum = {
+    Binance: 'binance',
+    Chainlink: 'chainlink'
+} as const;
+export type FeedLoadMarketsFeedEnum = typeof FeedLoadMarketsFeedEnum[keyof typeof FeedLoadMarketsFeedEnum];

package/generated/src/apis/index.ts

@@ -1,3 +1,4 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './DataFeedsApi';
 export * from './DefaultApi';