pmxtjs 2.51.2 → 2.51.4

package/generated/docs/CreateOrderParams.md

@@ -12,41 +12,13 @@ Name | Type
 `type` | string
 `amount` | number
 `price` | number
+`denom` | string
+`slippagePct` | number
 `fee` | number
 `tickSize` | number
 `negRisk` | boolean
 `onBehalfOf` | number
 
-## Example
-
-```typescript
-import type { CreateOrderParams } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "marketId": null,
-  "outcomeId": null,
-  "side": null,
-  "type": null,
-  "amount": null,
-  "price": null,
-  "fee": null,
-  "tickSize": null,
-  "negRisk": null,
-  "onBehalfOf": null,
-} satisfies CreateOrderParams
-
-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 CreateOrderParams
-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)
 
 

package/generated/docs/CreateOrderRequest.md

@@ -9,28 +9,6 @@ Name | Type
 `args` | [Array<CreateOrderParams>](CreateOrderParams.md)
 `credentials` | [ExchangeCredentials](ExchangeCredentials.md)
 
-## Example
-
-```typescript
-import type { CreateOrderRequest } from 'pmxtjs'
-
-// TODO: Update the object below with actual values
-const example = {
-  "args": null,
-  "credentials": null,
-} satisfies CreateOrderRequest
-
-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 CreateOrderRequest
-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)
 
 

package/generated/docs/DataFeedsApi.md

@@ -25,46 +25,6 @@ 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
 
 
@@ -107,44 +67,6 @@ 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
 
 
@@ -186,40 +108,6 @@ 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
 
 
@@ -259,38 +147,6 @@ 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
 
 
@@ -329,40 +185,6 @@ 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
 
 
@@ -402,38 +224,6 @@ 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
 
 
@@ -472,38 +262,6 @@ 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
 
 
@@ -542,31 +300,6 @@ 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.
@@ -601,36 +334,6 @@ 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
 
 
@@ -668,38 +371,6 @@ Watch Ticker (WebSocket)
 
 Stream live ticker updates for a symbol via WebSocket.  **Transport:** WebSocket  | Environment | URL | |---|---| | Hosted API | `wss://api.pmxt.dev/ws?apiKey=YOUR_KEY` |  **Subscribe:** ```json { \"id\": \"btc-stream\", \"action\": \"subscribe\", \"method\": \"watchTicker\", \"args\": [\"BTC/USDT\"], \"feed\": \"binance\" } ```  **Server response:** ```json { \"event\": \"data\", \"id\": \"btc-stream\", \"method\": \"watchTicker\", \"symbol\": \"BTC/USDT\", \"source\": \"binance\", \"data\": { \"symbol\": \"BTC/USDT\", \"last\": 76949.16, \"timestamp\": 1716148800000, ... } } ```  **Unsubscribe:** ```json { \"id\": \"btc-stream\", \"action\": \"unsubscribe\" } ```  Currently supports Binance feeds only. Tickers stream as they arrive from the Binance trade relay.
 
-### Example
-
-```ts
-import {
-  Configuration,
-  DataFeedsApi,
-} from 'pmxtjs';
-import type { FeedWatchTickerRequest } 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 to stream (e.g. BTC/USDT)
-    symbol: symbol_example,
-  } satisfies FeedWatchTickerRequest;
-
-  try {
-    const data = await api.feedWatchTicker(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
 ### Parameters