pmxtjs 2.42.3 → 2.42.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/generated/src/apis/DataFeedsApi.d.ts +22 -0
- package/dist/esm/generated/src/apis/DataFeedsApi.js +41 -0
- package/dist/generated/src/apis/DataFeedsApi.d.ts +22 -0
- package/dist/generated/src/apis/DataFeedsApi.js +42 -1
- package/generated/docs/DataFeedsApi.md +71 -0
- package/generated/package.json +1 -1
- package/generated/src/apis/DataFeedsApi.ts +63 -0
- package/package.json +2 -2
|
@@ -51,6 +51,10 @@ export interface FeedFetchTickersRequest {
|
|
|
51
51
|
export interface FeedLoadMarketsRequest {
|
|
52
52
|
feed: FeedLoadMarketsFeedEnum;
|
|
53
53
|
}
|
|
54
|
+
export interface FeedWatchTickerRequest {
|
|
55
|
+
feed: FeedWatchTickerFeedEnum;
|
|
56
|
+
symbol: string;
|
|
57
|
+
}
|
|
54
58
|
/**
|
|
55
59
|
*
|
|
56
60
|
*/
|
|
@@ -145,6 +149,16 @@ export declare class DataFeedsApi extends runtime.BaseAPI {
|
|
|
145
149
|
* Load Feed Markets
|
|
146
150
|
*/
|
|
147
151
|
feedLoadMarkets(requestParameters: FeedLoadMarketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedLoadMarkets200Response>;
|
|
152
|
+
/**
|
|
153
|
+
* 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.
|
|
154
|
+
* Watch Ticker (WebSocket)
|
|
155
|
+
*/
|
|
156
|
+
feedWatchTickerRaw(requestParameters: FeedWatchTickerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedFetchTicker200Response>>;
|
|
157
|
+
/**
|
|
158
|
+
* 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.
|
|
159
|
+
* Watch Ticker (WebSocket)
|
|
160
|
+
*/
|
|
161
|
+
feedWatchTicker(requestParameters: FeedWatchTickerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedFetchTicker200Response>;
|
|
148
162
|
}
|
|
149
163
|
/**
|
|
150
164
|
* @export
|
|
@@ -218,3 +232,11 @@ export declare const FeedLoadMarketsFeedEnum: {
|
|
|
218
232
|
readonly Chainlink: "chainlink";
|
|
219
233
|
};
|
|
220
234
|
export type FeedLoadMarketsFeedEnum = typeof FeedLoadMarketsFeedEnum[keyof typeof FeedLoadMarketsFeedEnum];
|
|
235
|
+
/**
|
|
236
|
+
* @export
|
|
237
|
+
*/
|
|
238
|
+
export declare const FeedWatchTickerFeedEnum: {
|
|
239
|
+
readonly Binance: "binance";
|
|
240
|
+
readonly Chainlink: "chainlink";
|
|
241
|
+
};
|
|
242
|
+
export type FeedWatchTickerFeedEnum = typeof FeedWatchTickerFeedEnum[keyof typeof FeedWatchTickerFeedEnum];
|
|
@@ -331,6 +331,40 @@ export class DataFeedsApi extends runtime.BaseAPI {
|
|
|
331
331
|
const response = await this.feedLoadMarketsRaw(requestParameters, initOverrides);
|
|
332
332
|
return await response.value();
|
|
333
333
|
}
|
|
334
|
+
/**
|
|
335
|
+
* 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.
|
|
336
|
+
* Watch Ticker (WebSocket)
|
|
337
|
+
*/
|
|
338
|
+
async feedWatchTickerRaw(requestParameters, initOverrides) {
|
|
339
|
+
if (requestParameters['feed'] == null) {
|
|
340
|
+
throw new runtime.RequiredError('feed', 'Required parameter "feed" was null or undefined when calling feedWatchTicker().');
|
|
341
|
+
}
|
|
342
|
+
if (requestParameters['symbol'] == null) {
|
|
343
|
+
throw new runtime.RequiredError('symbol', 'Required parameter "symbol" was null or undefined when calling feedWatchTicker().');
|
|
344
|
+
}
|
|
345
|
+
const queryParameters = {};
|
|
346
|
+
if (requestParameters['symbol'] != null) {
|
|
347
|
+
queryParameters['symbol'] = requestParameters['symbol'];
|
|
348
|
+
}
|
|
349
|
+
const headerParameters = {};
|
|
350
|
+
let urlPath = `/api/feeds/{feed}/watchTicker`;
|
|
351
|
+
urlPath = urlPath.replace(`{${"feed"}}`, encodeURIComponent(String(requestParameters['feed'])));
|
|
352
|
+
const response = await this.request({
|
|
353
|
+
path: urlPath,
|
|
354
|
+
method: 'GET',
|
|
355
|
+
headers: headerParameters,
|
|
356
|
+
query: queryParameters,
|
|
357
|
+
}, initOverrides);
|
|
358
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => FeedFetchTicker200ResponseFromJSON(jsonValue));
|
|
359
|
+
}
|
|
360
|
+
/**
|
|
361
|
+
* 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.
|
|
362
|
+
* Watch Ticker (WebSocket)
|
|
363
|
+
*/
|
|
364
|
+
async feedWatchTicker(requestParameters, initOverrides) {
|
|
365
|
+
const response = await this.feedWatchTickerRaw(requestParameters, initOverrides);
|
|
366
|
+
return await response.value();
|
|
367
|
+
}
|
|
334
368
|
}
|
|
335
369
|
/**
|
|
336
370
|
* @export
|
|
@@ -395,3 +429,10 @@ export const FeedLoadMarketsFeedEnum = {
|
|
|
395
429
|
Binance: 'binance',
|
|
396
430
|
Chainlink: 'chainlink'
|
|
397
431
|
};
|
|
432
|
+
/**
|
|
433
|
+
* @export
|
|
434
|
+
*/
|
|
435
|
+
export const FeedWatchTickerFeedEnum = {
|
|
436
|
+
Binance: 'binance',
|
|
437
|
+
Chainlink: 'chainlink'
|
|
438
|
+
};
|
|
@@ -51,6 +51,10 @@ export interface FeedFetchTickersRequest {
|
|
|
51
51
|
export interface FeedLoadMarketsRequest {
|
|
52
52
|
feed: FeedLoadMarketsFeedEnum;
|
|
53
53
|
}
|
|
54
|
+
export interface FeedWatchTickerRequest {
|
|
55
|
+
feed: FeedWatchTickerFeedEnum;
|
|
56
|
+
symbol: string;
|
|
57
|
+
}
|
|
54
58
|
/**
|
|
55
59
|
*
|
|
56
60
|
*/
|
|
@@ -145,6 +149,16 @@ export declare class DataFeedsApi extends runtime.BaseAPI {
|
|
|
145
149
|
* Load Feed Markets
|
|
146
150
|
*/
|
|
147
151
|
feedLoadMarkets(requestParameters: FeedLoadMarketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedLoadMarkets200Response>;
|
|
152
|
+
/**
|
|
153
|
+
* 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.
|
|
154
|
+
* Watch Ticker (WebSocket)
|
|
155
|
+
*/
|
|
156
|
+
feedWatchTickerRaw(requestParameters: FeedWatchTickerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedFetchTicker200Response>>;
|
|
157
|
+
/**
|
|
158
|
+
* 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.
|
|
159
|
+
* Watch Ticker (WebSocket)
|
|
160
|
+
*/
|
|
161
|
+
feedWatchTicker(requestParameters: FeedWatchTickerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedFetchTicker200Response>;
|
|
148
162
|
}
|
|
149
163
|
/**
|
|
150
164
|
* @export
|
|
@@ -218,3 +232,11 @@ export declare const FeedLoadMarketsFeedEnum: {
|
|
|
218
232
|
readonly Chainlink: "chainlink";
|
|
219
233
|
};
|
|
220
234
|
export type FeedLoadMarketsFeedEnum = typeof FeedLoadMarketsFeedEnum[keyof typeof FeedLoadMarketsFeedEnum];
|
|
235
|
+
/**
|
|
236
|
+
* @export
|
|
237
|
+
*/
|
|
238
|
+
export declare const FeedWatchTickerFeedEnum: {
|
|
239
|
+
readonly Binance: "binance";
|
|
240
|
+
readonly Chainlink: "chainlink";
|
|
241
|
+
};
|
|
242
|
+
export type FeedWatchTickerFeedEnum = typeof FeedWatchTickerFeedEnum[keyof typeof FeedWatchTickerFeedEnum];
|
|
@@ -46,7 +46,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
46
46
|
};
|
|
47
47
|
})();
|
|
48
48
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
49
|
-
exports.FeedLoadMarketsFeedEnum = exports.FeedFetchTickersFeedEnum = exports.FeedFetchTickerFeedEnum = exports.FeedFetchOrderBookFeedEnum = exports.FeedFetchOracleRoundFeedEnum = exports.FeedFetchOracleHistoryFeedEnum = exports.FeedFetchOHLCVFeedEnum = exports.FeedFetchHistoricalPricesOrderEnum = exports.FeedFetchHistoricalPricesFeedEnum = exports.DataFeedsApi = void 0;
|
|
49
|
+
exports.FeedWatchTickerFeedEnum = exports.FeedLoadMarketsFeedEnum = exports.FeedFetchTickersFeedEnum = exports.FeedFetchTickerFeedEnum = exports.FeedFetchOrderBookFeedEnum = exports.FeedFetchOracleRoundFeedEnum = exports.FeedFetchOracleHistoryFeedEnum = exports.FeedFetchOHLCVFeedEnum = exports.FeedFetchHistoricalPricesOrderEnum = exports.FeedFetchHistoricalPricesFeedEnum = exports.DataFeedsApi = void 0;
|
|
50
50
|
const runtime = __importStar(require("../runtime"));
|
|
51
51
|
const index_1 = require("../models/index");
|
|
52
52
|
/**
|
|
@@ -367,6 +367,40 @@ class DataFeedsApi extends runtime.BaseAPI {
|
|
|
367
367
|
const response = await this.feedLoadMarketsRaw(requestParameters, initOverrides);
|
|
368
368
|
return await response.value();
|
|
369
369
|
}
|
|
370
|
+
/**
|
|
371
|
+
* 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.
|
|
372
|
+
* Watch Ticker (WebSocket)
|
|
373
|
+
*/
|
|
374
|
+
async feedWatchTickerRaw(requestParameters, initOverrides) {
|
|
375
|
+
if (requestParameters['feed'] == null) {
|
|
376
|
+
throw new runtime.RequiredError('feed', 'Required parameter "feed" was null or undefined when calling feedWatchTicker().');
|
|
377
|
+
}
|
|
378
|
+
if (requestParameters['symbol'] == null) {
|
|
379
|
+
throw new runtime.RequiredError('symbol', 'Required parameter "symbol" was null or undefined when calling feedWatchTicker().');
|
|
380
|
+
}
|
|
381
|
+
const queryParameters = {};
|
|
382
|
+
if (requestParameters['symbol'] != null) {
|
|
383
|
+
queryParameters['symbol'] = requestParameters['symbol'];
|
|
384
|
+
}
|
|
385
|
+
const headerParameters = {};
|
|
386
|
+
let urlPath = `/api/feeds/{feed}/watchTicker`;
|
|
387
|
+
urlPath = urlPath.replace(`{${"feed"}}`, encodeURIComponent(String(requestParameters['feed'])));
|
|
388
|
+
const response = await this.request({
|
|
389
|
+
path: urlPath,
|
|
390
|
+
method: 'GET',
|
|
391
|
+
headers: headerParameters,
|
|
392
|
+
query: queryParameters,
|
|
393
|
+
}, initOverrides);
|
|
394
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FeedFetchTicker200ResponseFromJSON)(jsonValue));
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
* 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.
|
|
398
|
+
* Watch Ticker (WebSocket)
|
|
399
|
+
*/
|
|
400
|
+
async feedWatchTicker(requestParameters, initOverrides) {
|
|
401
|
+
const response = await this.feedWatchTickerRaw(requestParameters, initOverrides);
|
|
402
|
+
return await response.value();
|
|
403
|
+
}
|
|
370
404
|
}
|
|
371
405
|
exports.DataFeedsApi = DataFeedsApi;
|
|
372
406
|
/**
|
|
@@ -432,3 +466,10 @@ exports.FeedLoadMarketsFeedEnum = {
|
|
|
432
466
|
Binance: 'binance',
|
|
433
467
|
Chainlink: 'chainlink'
|
|
434
468
|
};
|
|
469
|
+
/**
|
|
470
|
+
* @export
|
|
471
|
+
*/
|
|
472
|
+
exports.FeedWatchTickerFeedEnum = {
|
|
473
|
+
Binance: 'binance',
|
|
474
|
+
Chainlink: 'chainlink'
|
|
475
|
+
};
|
|
@@ -13,6 +13,7 @@ All URIs are relative to *http://localhost:3847*
|
|
|
13
13
|
| [**feedFetchTickers**](DataFeedsApi.md#feedfetchtickers) | **GET** /api/feeds/{feed}/fetchTickers | Fetch Tickers |
|
|
14
14
|
| [**feedList**](DataFeedsApi.md#feedlist) | **GET** /api/feeds | List Available Feeds |
|
|
15
15
|
| [**feedLoadMarkets**](DataFeedsApi.md#feedloadmarkets) | **GET** /api/feeds/{feed}/loadMarkets | Load Feed Markets |
|
|
16
|
+
| [**feedWatchTicker**](DataFeedsApi.md#feedwatchticker) | **GET** /api/feeds/{feed}/watchTicker | Watch Ticker (WebSocket) |
|
|
16
17
|
|
|
17
18
|
|
|
18
19
|
|
|
@@ -658,3 +659,73 @@ No authorization required
|
|
|
658
659
|
|
|
659
660
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
660
661
|
|
|
662
|
+
|
|
663
|
+
## feedWatchTicker
|
|
664
|
+
|
|
665
|
+
> FeedFetchTicker200Response feedWatchTicker(feed, symbol)
|
|
666
|
+
|
|
667
|
+
Watch Ticker (WebSocket)
|
|
668
|
+
|
|
669
|
+
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.
|
|
670
|
+
|
|
671
|
+
### Example
|
|
672
|
+
|
|
673
|
+
```ts
|
|
674
|
+
import {
|
|
675
|
+
Configuration,
|
|
676
|
+
DataFeedsApi,
|
|
677
|
+
} from 'pmxtjs';
|
|
678
|
+
import type { FeedWatchTickerRequest } from 'pmxtjs';
|
|
679
|
+
|
|
680
|
+
async function example() {
|
|
681
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
682
|
+
const api = new DataFeedsApi();
|
|
683
|
+
|
|
684
|
+
const body = {
|
|
685
|
+
// 'binance' | 'chainlink' | The data feed provider.
|
|
686
|
+
feed: feed_example,
|
|
687
|
+
// string | Trading pair to stream (e.g. BTC/USDT)
|
|
688
|
+
symbol: symbol_example,
|
|
689
|
+
} satisfies FeedWatchTickerRequest;
|
|
690
|
+
|
|
691
|
+
try {
|
|
692
|
+
const data = await api.feedWatchTicker(body);
|
|
693
|
+
console.log(data);
|
|
694
|
+
} catch (error) {
|
|
695
|
+
console.error(error);
|
|
696
|
+
}
|
|
697
|
+
}
|
|
698
|
+
|
|
699
|
+
// Run the test
|
|
700
|
+
example().catch(console.error);
|
|
701
|
+
```
|
|
702
|
+
|
|
703
|
+
### Parameters
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
| Name | Type | Description | Notes |
|
|
707
|
+
|------------- | ------------- | ------------- | -------------|
|
|
708
|
+
| **feed** | `binance`, `chainlink` | The data feed provider. | [Defaults to `undefined`] [Enum: binance, chainlink] |
|
|
709
|
+
| **symbol** | `string` | Trading pair to stream (e.g. BTC/USDT) | [Defaults to `undefined`] |
|
|
710
|
+
|
|
711
|
+
### Return type
|
|
712
|
+
|
|
713
|
+
[**FeedFetchTicker200Response**](FeedFetchTicker200Response.md)
|
|
714
|
+
|
|
715
|
+
### Authorization
|
|
716
|
+
|
|
717
|
+
No authorization required
|
|
718
|
+
|
|
719
|
+
### HTTP request headers
|
|
720
|
+
|
|
721
|
+
- **Content-Type**: Not defined
|
|
722
|
+
- **Accept**: `application/json`
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
### HTTP response details
|
|
726
|
+
| Status code | Description | Response headers |
|
|
727
|
+
|-------------|-------------|------------------|
|
|
728
|
+
| **200** | Successful response | - |
|
|
729
|
+
|
|
730
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
731
|
+
|
package/generated/package.json
CHANGED
|
@@ -94,6 +94,11 @@ export interface FeedLoadMarketsRequest {
|
|
|
94
94
|
feed: FeedLoadMarketsFeedEnum;
|
|
95
95
|
}
|
|
96
96
|
|
|
97
|
+
export interface FeedWatchTickerRequest {
|
|
98
|
+
feed: FeedWatchTickerFeedEnum;
|
|
99
|
+
symbol: string;
|
|
100
|
+
}
|
|
101
|
+
|
|
97
102
|
/**
|
|
98
103
|
*
|
|
99
104
|
*/
|
|
@@ -548,6 +553,56 @@ export class DataFeedsApi extends runtime.BaseAPI {
|
|
|
548
553
|
return await response.value();
|
|
549
554
|
}
|
|
550
555
|
|
|
556
|
+
/**
|
|
557
|
+
* 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.
|
|
558
|
+
* Watch Ticker (WebSocket)
|
|
559
|
+
*/
|
|
560
|
+
async feedWatchTickerRaw(requestParameters: FeedWatchTickerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeedFetchTicker200Response>> {
|
|
561
|
+
if (requestParameters['feed'] == null) {
|
|
562
|
+
throw new runtime.RequiredError(
|
|
563
|
+
'feed',
|
|
564
|
+
'Required parameter "feed" was null or undefined when calling feedWatchTicker().'
|
|
565
|
+
);
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
if (requestParameters['symbol'] == null) {
|
|
569
|
+
throw new runtime.RequiredError(
|
|
570
|
+
'symbol',
|
|
571
|
+
'Required parameter "symbol" was null or undefined when calling feedWatchTicker().'
|
|
572
|
+
);
|
|
573
|
+
}
|
|
574
|
+
|
|
575
|
+
const queryParameters: any = {};
|
|
576
|
+
|
|
577
|
+
if (requestParameters['symbol'] != null) {
|
|
578
|
+
queryParameters['symbol'] = requestParameters['symbol'];
|
|
579
|
+
}
|
|
580
|
+
|
|
581
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
let urlPath = `/api/feeds/{feed}/watchTicker`;
|
|
585
|
+
urlPath = urlPath.replace(`{${"feed"}}`, encodeURIComponent(String(requestParameters['feed'])));
|
|
586
|
+
|
|
587
|
+
const response = await this.request({
|
|
588
|
+
path: urlPath,
|
|
589
|
+
method: 'GET',
|
|
590
|
+
headers: headerParameters,
|
|
591
|
+
query: queryParameters,
|
|
592
|
+
}, initOverrides);
|
|
593
|
+
|
|
594
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => FeedFetchTicker200ResponseFromJSON(jsonValue));
|
|
595
|
+
}
|
|
596
|
+
|
|
597
|
+
/**
|
|
598
|
+
* 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.
|
|
599
|
+
* Watch Ticker (WebSocket)
|
|
600
|
+
*/
|
|
601
|
+
async feedWatchTicker(requestParameters: FeedWatchTickerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeedFetchTicker200Response> {
|
|
602
|
+
const response = await this.feedWatchTickerRaw(requestParameters, initOverrides);
|
|
603
|
+
return await response.value();
|
|
604
|
+
}
|
|
605
|
+
|
|
551
606
|
}
|
|
552
607
|
|
|
553
608
|
/**
|
|
@@ -622,3 +677,11 @@ export const FeedLoadMarketsFeedEnum = {
|
|
|
622
677
|
Chainlink: 'chainlink'
|
|
623
678
|
} as const;
|
|
624
679
|
export type FeedLoadMarketsFeedEnum = typeof FeedLoadMarketsFeedEnum[keyof typeof FeedLoadMarketsFeedEnum];
|
|
680
|
+
/**
|
|
681
|
+
* @export
|
|
682
|
+
*/
|
|
683
|
+
export const FeedWatchTickerFeedEnum = {
|
|
684
|
+
Binance: 'binance',
|
|
685
|
+
Chainlink: 'chainlink'
|
|
686
|
+
} as const;
|
|
687
|
+
export type FeedWatchTickerFeedEnum = typeof FeedWatchTickerFeedEnum[keyof typeof FeedWatchTickerFeedEnum];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pmxtjs",
|
|
3
|
-
"version": "2.42.
|
|
3
|
+
"version": "2.42.5",
|
|
4
4
|
"description": "Unified prediction market data API - The ccxt for prediction markets",
|
|
5
5
|
"author": "PMXT Contributors",
|
|
6
6
|
"repository": {
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"unified"
|
|
44
44
|
],
|
|
45
45
|
"dependencies": {
|
|
46
|
-
"pmxt-core": "2.42.
|
|
46
|
+
"pmxt-core": "2.42.5",
|
|
47
47
|
"ws": "^8.18.0"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|