pmxtjs 2.41.7 → 2.42.3

package/generated/docs/DataFeedsApi.md

@@ -0,0 +1,660 @@
+# DataFeedsApi
+
+All URIs are relative to *http://localhost:3847*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**feedFetchHistoricalPrices**](DataFeedsApi.md#feedfetchhistoricalprices) | **GET** /api/feeds/{feed}/fetchHistoricalPrices | Fetch Historical Prices |
+| [**feedFetchOHLCV**](DataFeedsApi.md#feedfetchohlcv) | **GET** /api/feeds/{feed}/fetchOHLCV | Fetch OHLCV |
+| [**feedFetchOracleHistory**](DataFeedsApi.md#feedfetchoraclehistory) | **GET** /api/feeds/{feed}/fetchOracleHistory | Fetch Oracle History |
+| [**feedFetchOracleRound**](DataFeedsApi.md#feedfetchoracleround) | **GET** /api/feeds/{feed}/fetchOracleRound | Fetch Oracle Round |
+| [**feedFetchOrderBook**](DataFeedsApi.md#feedfetchorderbook) | **GET** /api/feeds/{feed}/fetchOrderBook | Fetch Order Book |
+| [**feedFetchTicker**](DataFeedsApi.md#feedfetchticker) | **GET** /api/feeds/{feed}/fetchTicker | Fetch Ticker |
+| [**feedFetchTickers**](DataFeedsApi.md#feedfetchtickers) | **GET** /api/feeds/{feed}/fetchTickers | Fetch Tickers |
+| [**feedList**](DataFeedsApi.md#feedlist) | **GET** /api/feeds | List Available Feeds |
+| [**feedLoadMarkets**](DataFeedsApi.md#feedloadmarkets) | **GET** /api/feeds/{feed}/loadMarkets | Load Feed Markets |
+
+
+
+## feedFetchHistoricalPrices
+
+> FeedFetchHistoricalPrices200Response feedFetchHistoricalPrices(feed, symbol, fromTimestamp, untilTimestamp, maxSize, order)
+
+Fetch Historical Prices
+
+Returns historical price data as tickers within a time range.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataFeedsApi,
+} from 'pmxtjs';
+import type { FeedFetchHistoricalPricesRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DataFeedsApi();
+
+  const body = {
+    // 'binance' | 'chainlink' | The data feed provider.
+    feed: feed_example,
+    // string | Trading pair (e.g. BTC/USD)
+    symbol: symbol_example,
+    // number | Start unix timestamp (seconds) (optional)
+    fromTimestamp: 56,
+    // number | End unix timestamp (seconds) (optional)
+    untilTimestamp: 56,
+    // number | Max records to return (optional)
+    maxSize: 56,
+    // 'asc' | 'desc' | Sort order (optional)
+    order: order_example,
+  } satisfies FeedFetchHistoricalPricesRequest;
+
+  try {
+    const data = await api.feedFetchHistoricalPrices(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **feed** | `binance`, `chainlink` | The data feed provider. | [Defaults to `undefined`] [Enum: binance, chainlink] |
+| **symbol** | `string` | Trading pair (e.g. BTC/USD) | [Defaults to `undefined`] |
+| **fromTimestamp** | `number` | Start unix timestamp (seconds) | [Optional] [Defaults to `undefined`] |
+| **untilTimestamp** | `number` | End unix timestamp (seconds) | [Optional] [Defaults to `undefined`] |
+| **maxSize** | `number` | Max records to return | [Optional] [Defaults to `undefined`] |
+| **order** | `asc`, `desc` | Sort order | [Optional] [Defaults to `undefined`] [Enum: asc, desc] |
+
+### Return type
+
+[**FeedFetchHistoricalPrices200Response**](FeedFetchHistoricalPrices200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## feedFetchOHLCV
+
+> FeedFetchOHLCV200Response feedFetchOHLCV(feed, symbol, timeframe, since, limit)
+
+Fetch OHLCV
+
+Returns OHLCV candle data for a symbol.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataFeedsApi,
+} from 'pmxtjs';
+import type { FeedFetchOHLCVRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DataFeedsApi();
+
+  const body = {
+    // 'binance' | 'chainlink' | The data feed provider.
+    feed: feed_example,
+    // string | Trading pair
+    symbol: symbol_example,
+    // string | Candle interval (e.g. 1m, 5m, 1h, 1d) (optional)
+    timeframe: timeframe_example,
+    // number | Start timestamp in ms (optional)
+    since: 56,
+    // number | Max candles to return (optional)
+    limit: 56,
+  } satisfies FeedFetchOHLCVRequest;
+
+  try {
+    const data = await api.feedFetchOHLCV(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **feed** | `binance`, `chainlink` | The data feed provider. | [Defaults to `undefined`] [Enum: binance, chainlink] |
+| **symbol** | `string` | Trading pair | [Defaults to `undefined`] |
+| **timeframe** | `string` | Candle interval (e.g. 1m, 5m, 1h, 1d) | [Optional] [Defaults to `'1h'`] |
+| **since** | `number` | Start timestamp in ms | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` | Max candles to return | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**FeedFetchOHLCV200Response**](FeedFetchOHLCV200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## feedFetchOracleHistory
+
+> FeedFetchOracleHistory200Response feedFetchOracleHistory(feed, feed2, limit)
+
+Fetch Oracle History
+
+Returns historical Chainlink oracle rounds for a price feed.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataFeedsApi,
+} from 'pmxtjs';
+import type { FeedFetchOracleHistoryRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DataFeedsApi();
+
+  const body = {
+    // 'binance' | 'chainlink' | The data feed provider.
+    feed: feed_example,
+    // string | Price feed pair (e.g. BTC/USD)
+    feed2: feed_example,
+    // number | Max rounds to return (default 500) (optional)
+    limit: 56,
+  } satisfies FeedFetchOracleHistoryRequest;
+
+  try {
+    const data = await api.feedFetchOracleHistory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **feed** | `binance`, `chainlink` | The data feed provider. | [Defaults to `undefined`] [Enum: binance, chainlink] |
+| **feed2** | `string` | Price feed pair (e.g. BTC/USD) | [Defaults to `undefined`] |
+| **limit** | `number` | Max rounds to return (default 500) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**FeedFetchOracleHistory200Response**](FeedFetchOracleHistory200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## feedFetchOracleRound
+
+> FeedFetchOracleRound200Response feedFetchOracleRound(feed, feed2)
+
+Fetch Oracle Round
+
+Returns the latest Chainlink oracle round for a price feed.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataFeedsApi,
+} from 'pmxtjs';
+import type { FeedFetchOracleRoundRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DataFeedsApi();
+
+  const body = {
+    // 'binance' | 'chainlink' | The data feed provider.
+    feed: feed_example,
+    // string | Price feed pair (e.g. BTC/USD)
+    feed2: feed_example,
+  } satisfies FeedFetchOracleRoundRequest;
+
+  try {
+    const data = await api.feedFetchOracleRound(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **feed** | `binance`, `chainlink` | The data feed provider. | [Defaults to `undefined`] [Enum: binance, chainlink] |
+| **feed2** | `string` | Price feed pair (e.g. BTC/USD) | [Defaults to `undefined`] |
+
+### Return type
+
+[**FeedFetchOracleRound200Response**](FeedFetchOracleRound200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## feedFetchOrderBook
+
+> FeedFetchOrderBook200Response feedFetchOrderBook(feed, symbol, limit)
+
+Fetch Order Book
+
+Returns the current order book for a symbol (where supported).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataFeedsApi,
+} from 'pmxtjs';
+import type { FeedFetchOrderBookRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DataFeedsApi();
+
+  const body = {
+    // 'binance' | 'chainlink' | The data feed provider.
+    feed: feed_example,
+    // string | Trading pair
+    symbol: symbol_example,
+    // number | Depth limit (optional)
+    limit: 56,
+  } satisfies FeedFetchOrderBookRequest;
+
+  try {
+    const data = await api.feedFetchOrderBook(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **feed** | `binance`, `chainlink` | The data feed provider. | [Defaults to `undefined`] [Enum: binance, chainlink] |
+| **symbol** | `string` | Trading pair | [Defaults to `undefined`] |
+| **limit** | `number` | Depth limit | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**FeedFetchOrderBook200Response**](FeedFetchOrderBook200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## feedFetchTicker
+
+> FeedFetchTicker200Response feedFetchTicker(feed, symbol)
+
+Fetch Ticker
+
+Returns the latest ticker for a single symbol.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataFeedsApi,
+} from 'pmxtjs';
+import type { FeedFetchTickerRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DataFeedsApi();
+
+  const body = {
+    // 'binance' | 'chainlink' | The data feed provider.
+    feed: feed_example,
+    // string | Trading pair (e.g. BTC/USD, BTC/USDT)
+    symbol: symbol_example,
+  } satisfies FeedFetchTickerRequest;
+
+  try {
+    const data = await api.feedFetchTicker(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **feed** | `binance`, `chainlink` | The data feed provider. | [Defaults to `undefined`] [Enum: binance, chainlink] |
+| **symbol** | `string` | Trading pair (e.g. BTC/USD, BTC/USDT) | [Defaults to `undefined`] |
+
+### Return type
+
+[**FeedFetchTicker200Response**](FeedFetchTicker200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## feedFetchTickers
+
+> FeedFetchTickers200Response feedFetchTickers(feed, symbols)
+
+Fetch Tickers
+
+Returns the latest tickers for all symbols, or a filtered subset.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataFeedsApi,
+} from 'pmxtjs';
+import type { FeedFetchTickersRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DataFeedsApi();
+
+  const body = {
+    // 'binance' | 'chainlink' | The data feed provider.
+    feed: feed_example,
+    // string | Comma-separated symbols to filter (optional) (optional)
+    symbols: symbols_example,
+  } satisfies FeedFetchTickersRequest;
+
+  try {
+    const data = await api.feedFetchTickers(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **feed** | `binance`, `chainlink` | The data feed provider. | [Defaults to `undefined`] [Enum: binance, chainlink] |
+| **symbols** | `string` | Comma-separated symbols to filter (optional) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**FeedFetchTickers200Response**](FeedFetchTickers200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## feedList
+
+> FeedList200Response feedList()
+
+List Available Feeds
+
+Returns the list of available data feed providers.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataFeedsApi,
+} from 'pmxtjs';
+import type { FeedListRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DataFeedsApi();
+
+  try {
+    const data = await api.feedList();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FeedList200Response**](FeedList200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## feedLoadMarkets
+
+> FeedLoadMarkets200Response feedLoadMarkets(feed)
+
+Load Feed Markets
+
+Returns all trading pairs supported by this feed.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DataFeedsApi,
+} from 'pmxtjs';
+import type { FeedLoadMarketsRequest } from 'pmxtjs';
+
+async function example() {
+  console.log("🚀 Testing pmxtjs SDK...");
+  const api = new DataFeedsApi();
+
+  const body = {
+    // 'binance' | 'chainlink' | The data feed provider.
+    feed: feed_example,
+  } satisfies FeedLoadMarketsRequest;
+
+  try {
+    const data = await api.feedLoadMarkets(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **feed** | `binance`, `chainlink` | The data feed provider. | [Defaults to `undefined`] [Enum: binance, chainlink] |
+
+### Return type
+
+[**FeedLoadMarkets200Response**](FeedLoadMarkets200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/generated/docs/FeedFetchHistoricalPrices200Response.md

@@ -0,0 +1,36 @@
+
+# FeedFetchHistoricalPrices200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [Array<FeedTicker>](FeedTicker.md)
+
+## Example
+
+```typescript
+import type { FeedFetchHistoricalPrices200Response } from 'pmxtjs'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": true,
+  "data": null,
+} satisfies FeedFetchHistoricalPrices200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FeedFetchHistoricalPrices200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+