pmxtjs 2.12.0 → 2.13.2
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/DefaultApi.d.ts +198 -120
- package/dist/esm/generated/src/apis/DefaultApi.js +228 -120
- package/dist/esm/generated/src/models/CloseRequest.d.ts +39 -0
- package/dist/esm/generated/src/models/{WatchUserPositionsRequest.js → CloseRequest.js} +10 -8
- package/dist/esm/generated/src/models/FetchAllOrdersRequest.d.ts +40 -0
- package/dist/esm/generated/src/models/FetchAllOrdersRequest.js +45 -0
- package/dist/esm/generated/src/models/FetchBalanceRequest.d.ts +39 -0
- package/dist/esm/generated/src/models/FetchBalanceRequest.js +44 -0
- package/dist/esm/generated/src/models/FetchClosedOrdersRequest.d.ts +40 -0
- package/dist/esm/generated/src/models/FetchClosedOrdersRequest.js +45 -0
- package/dist/esm/generated/src/models/FetchEventRequest.d.ts +40 -0
- package/dist/esm/generated/src/models/FetchEventRequest.js +45 -0
- package/dist/esm/generated/src/models/FetchMarketsPaginated200Response.d.ts +46 -0
- package/dist/esm/generated/src/models/FetchMarketsPaginated200Response.js +47 -0
- package/dist/esm/generated/src/models/FetchMarketsPaginatedRequest.d.ts +40 -0
- package/dist/esm/generated/src/models/FetchMarketsPaginatedRequest.js +45 -0
- package/dist/esm/generated/src/models/FetchMarketsPaginatedRequestArgsInner.d.ts +38 -0
- package/dist/esm/generated/src/models/FetchMarketsPaginatedRequestArgsInner.js +43 -0
- package/dist/esm/generated/src/models/FetchMarketsRequest.d.ts +0 -6
- package/dist/esm/generated/src/models/FetchMarketsRequest.js +0 -2
- package/dist/esm/generated/src/models/FetchMyTrades200Response.d.ts +46 -0
- package/dist/esm/generated/src/models/FetchMyTrades200Response.js +47 -0
- package/dist/esm/generated/src/models/FetchMyTradesRequest.d.ts +40 -0
- package/dist/esm/generated/src/models/FetchMyTradesRequest.js +45 -0
- package/dist/esm/generated/src/models/FetchOHLCVRequest.d.ts +1 -1
- package/dist/esm/generated/src/models/FetchOHLCVRequestArgsInner.d.ts +2 -2
- package/dist/esm/generated/src/models/FetchOHLCVRequestArgsInner.js +5 -5
- package/dist/esm/generated/src/models/FetchOHLCVRequestArgsInnerOneOf.d.ts +24 -0
- package/dist/esm/generated/src/models/FetchOHLCVRequestArgsInnerOneOf.js +54 -0
- package/dist/esm/generated/src/models/{WatchPricesRequest.d.ts → FetchOrderRequest.d.ts} +10 -10
- package/dist/esm/generated/src/models/{WatchPricesRequest.js → FetchOrderRequest.js} +8 -8
- package/dist/esm/generated/src/models/FetchPositionsRequest.d.ts +1 -1
- package/dist/esm/generated/src/models/FetchTradesRequest.d.ts +1 -1
- package/dist/esm/generated/src/models/FetchTradesRequestArgsInner.d.ts +2 -2
- package/dist/esm/generated/src/models/FetchTradesRequestArgsInner.js +5 -5
- package/dist/esm/generated/src/models/FetchTradesRequestArgsInnerOneOf.d.ts +24 -0
- package/dist/esm/generated/src/models/FetchTradesRequestArgsInnerOneOf.js +54 -0
- package/dist/esm/generated/src/models/FilterEventsRequest.d.ts +1 -1
- package/dist/esm/generated/src/models/FilterEventsRequestArgsInner.js +3 -3
- package/dist/esm/generated/src/models/FilterMarketsRequest.d.ts +1 -1
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInner.js +3 -3
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInnerOneOf.d.ts +2 -2
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInnerOneOf.js +5 -1
- package/dist/esm/generated/src/models/GetExecutionPriceDetailedRequest.d.ts +40 -0
- package/dist/esm/generated/src/models/GetExecutionPriceDetailedRequest.js +47 -0
- package/dist/esm/generated/src/models/GetExecutionPriceRequest.d.ts +1 -1
- package/dist/esm/generated/src/models/LoadMarkets200Response.d.ts +48 -0
- package/dist/esm/generated/src/models/LoadMarkets200Response.js +48 -0
- package/dist/esm/generated/src/models/LoadMarketsRequest.d.ts +39 -0
- package/dist/esm/generated/src/models/LoadMarketsRequest.js +44 -0
- package/dist/esm/generated/src/models/MyTradesParams.d.ts +62 -0
- package/dist/esm/generated/src/models/MyTradesParams.js +51 -0
- package/dist/esm/generated/src/models/OrderHistoryParams.d.ts +56 -0
- package/dist/esm/generated/src/models/OrderHistoryParams.js +49 -0
- package/dist/esm/generated/src/models/PaginatedMarketsResult.d.ts +45 -0
- package/dist/esm/generated/src/models/PaginatedMarketsResult.js +46 -0
- package/dist/esm/generated/src/models/UserTrade.d.ts +83 -0
- package/dist/esm/generated/src/models/UserTrade.js +63 -0
- package/dist/esm/generated/src/models/WatchOrderBookRequest.d.ts +1 -1
- package/dist/esm/generated/src/models/WatchTradesRequest.d.ts +1 -1
- package/dist/esm/generated/src/models/index.d.ts +20 -2
- package/dist/esm/generated/src/models/index.js +20 -2
- package/dist/esm/pmxt/client.js +2 -2
- package/dist/generated/src/apis/DefaultApi.d.ts +198 -120
- package/dist/generated/src/apis/DefaultApi.js +228 -120
- package/dist/generated/src/models/CloseRequest.d.ts +39 -0
- package/dist/generated/src/models/{WatchUserPositionsRequest.js → CloseRequest.js} +15 -13
- package/dist/generated/src/models/FetchAllOrdersRequest.d.ts +40 -0
- package/dist/generated/src/models/FetchAllOrdersRequest.js +52 -0
- package/dist/generated/src/models/FetchBalanceRequest.d.ts +39 -0
- package/dist/generated/src/models/FetchBalanceRequest.js +51 -0
- package/dist/generated/src/models/FetchClosedOrdersRequest.d.ts +40 -0
- package/dist/generated/src/models/FetchClosedOrdersRequest.js +52 -0
- package/dist/generated/src/models/FetchEventRequest.d.ts +40 -0
- package/dist/generated/src/models/FetchEventRequest.js +52 -0
- package/dist/generated/src/models/FetchMarketsPaginated200Response.d.ts +46 -0
- package/dist/generated/src/models/FetchMarketsPaginated200Response.js +54 -0
- package/dist/generated/src/models/FetchMarketsPaginatedRequest.d.ts +40 -0
- package/dist/generated/src/models/FetchMarketsPaginatedRequest.js +52 -0
- package/dist/generated/src/models/FetchMarketsPaginatedRequestArgsInner.d.ts +38 -0
- package/dist/generated/src/models/FetchMarketsPaginatedRequestArgsInner.js +50 -0
- package/dist/generated/src/models/FetchMarketsRequest.d.ts +0 -6
- package/dist/generated/src/models/FetchMarketsRequest.js +0 -2
- package/dist/generated/src/models/FetchMyTrades200Response.d.ts +46 -0
- package/dist/generated/src/models/FetchMyTrades200Response.js +54 -0
- package/dist/generated/src/models/FetchMyTradesRequest.d.ts +40 -0
- package/dist/generated/src/models/FetchMyTradesRequest.js +52 -0
- package/dist/generated/src/models/FetchOHLCVRequest.d.ts +1 -1
- package/dist/generated/src/models/FetchOHLCVRequestArgsInner.d.ts +2 -2
- package/dist/generated/src/models/FetchOHLCVRequestArgsInner.js +5 -5
- package/dist/generated/src/models/FetchOHLCVRequestArgsInnerOneOf.d.ts +24 -0
- package/dist/generated/src/models/FetchOHLCVRequestArgsInnerOneOf.js +61 -0
- package/dist/generated/src/models/{WatchPricesRequest.d.ts → FetchOrderRequest.d.ts} +10 -10
- package/dist/generated/src/models/{WatchPricesRequest.js → FetchOrderRequest.js} +13 -13
- package/dist/generated/src/models/FetchPositionsRequest.d.ts +1 -1
- package/dist/generated/src/models/FetchTradesRequest.d.ts +1 -1
- package/dist/generated/src/models/FetchTradesRequestArgsInner.d.ts +2 -2
- package/dist/generated/src/models/FetchTradesRequestArgsInner.js +5 -5
- package/dist/generated/src/models/FetchTradesRequestArgsInnerOneOf.d.ts +24 -0
- package/dist/generated/src/models/FetchTradesRequestArgsInnerOneOf.js +61 -0
- package/dist/generated/src/models/FilterEventsRequest.d.ts +1 -1
- package/dist/generated/src/models/FilterEventsRequestArgsInner.js +3 -3
- package/dist/generated/src/models/FilterMarketsRequest.d.ts +1 -1
- package/dist/generated/src/models/FilterMarketsRequestArgsInner.js +3 -3
- package/dist/generated/src/models/FilterMarketsRequestArgsInnerOneOf.d.ts +2 -2
- package/dist/generated/src/models/FilterMarketsRequestArgsInnerOneOf.js +5 -1
- package/dist/generated/src/models/GetExecutionPriceDetailedRequest.d.ts +40 -0
- package/dist/generated/src/models/GetExecutionPriceDetailedRequest.js +54 -0
- package/dist/generated/src/models/GetExecutionPriceRequest.d.ts +1 -1
- package/dist/generated/src/models/LoadMarkets200Response.d.ts +48 -0
- package/dist/generated/src/models/LoadMarkets200Response.js +55 -0
- package/dist/generated/src/models/LoadMarketsRequest.d.ts +39 -0
- package/dist/generated/src/models/LoadMarketsRequest.js +51 -0
- package/dist/generated/src/models/MyTradesParams.d.ts +62 -0
- package/dist/generated/src/models/MyTradesParams.js +58 -0
- package/dist/generated/src/models/OrderHistoryParams.d.ts +56 -0
- package/dist/generated/src/models/OrderHistoryParams.js +56 -0
- package/dist/generated/src/models/PaginatedMarketsResult.d.ts +45 -0
- package/dist/generated/src/models/PaginatedMarketsResult.js +53 -0
- package/dist/generated/src/models/UserTrade.d.ts +83 -0
- package/dist/generated/src/models/UserTrade.js +71 -0
- package/dist/generated/src/models/WatchOrderBookRequest.d.ts +1 -1
- package/dist/generated/src/models/WatchTradesRequest.d.ts +1 -1
- package/dist/generated/src/models/index.d.ts +20 -2
- package/dist/generated/src/models/index.js +20 -2
- package/dist/pmxt/client.js +2 -2
- package/generated/.openapi-generator/FILES +40 -4
- package/generated/docs/{WatchUserPositionsRequest.md → CloseRequest.md} +6 -4
- package/generated/docs/DefaultApi.md +399 -233
- package/generated/docs/FetchAllOrdersRequest.md +36 -0
- package/generated/docs/FetchBalanceRequest.md +36 -0
- package/generated/docs/FetchClosedOrdersRequest.md +36 -0
- package/generated/docs/FetchEventRequest.md +36 -0
- package/generated/docs/FetchMarketsPaginated200Response.md +38 -0
- package/generated/docs/FetchMarketsPaginatedRequest.md +36 -0
- package/generated/docs/FetchMarketsPaginatedRequestArgsInner.md +36 -0
- package/generated/docs/FetchMarketsRequest.md +0 -2
- package/generated/docs/FetchMyTrades200Response.md +38 -0
- package/generated/docs/FetchMyTradesRequest.md +36 -0
- package/generated/docs/FetchOHLCVRequest.md +1 -1
- package/generated/docs/FetchOHLCVRequestArgsInnerOneOf.md +40 -0
- package/generated/docs/{WatchPricesRequest.md → FetchOrderRequest.md} +4 -4
- package/generated/docs/FetchTradesRequestArgsInner.md +2 -0
- package/generated/docs/FetchTradesRequestArgsInnerOneOf.md +40 -0
- package/generated/docs/FilterMarketsRequestArgsInnerOneOf.md +0 -1
- package/generated/docs/GetExecutionPriceDetailedRequest.md +36 -0
- package/generated/docs/LoadMarkets200Response.md +38 -0
- package/generated/docs/LoadMarketsRequest.md +36 -0
- package/generated/docs/MyTradesParams.md +44 -0
- package/generated/docs/OrderHistoryParams.md +42 -0
- package/generated/docs/PaginatedMarketsResult.md +38 -0
- package/generated/docs/UserTrade.md +48 -0
- package/generated/package.json +1 -1
- package/generated/src/apis/DefaultApi.ts +389 -215
- package/generated/src/models/Balance.ts +1 -1
- package/generated/src/models/BaseRequest.ts +1 -1
- package/generated/src/models/BaseResponse.ts +1 -1
- package/generated/src/models/CancelOrderRequest.ts +1 -1
- package/generated/src/models/{WatchUserPositionsRequest.ts → CloseRequest.ts} +20 -12
- package/generated/src/models/CreateOrder200Response.ts +1 -1
- package/generated/src/models/CreateOrderParams.ts +1 -1
- package/generated/src/models/CreateOrderRequest.ts +1 -1
- package/generated/src/models/ErrorDetail.ts +1 -1
- package/generated/src/models/ErrorResponse.ts +1 -1
- package/generated/src/models/EventFetchParams.ts +1 -1
- package/generated/src/models/ExchangeCredentials.ts +1 -1
- package/generated/src/models/ExchangeCredentialsSignatureType.ts +1 -1
- package/generated/src/models/ExecutionPriceResult.ts +1 -1
- package/generated/src/models/FetchAllOrdersRequest.ts +88 -0
- package/generated/src/models/FetchBalance200Response.ts +1 -1
- package/generated/src/models/FetchBalanceRequest.ts +81 -0
- package/generated/src/models/FetchClosedOrdersRequest.ts +88 -0
- package/generated/src/models/FetchEvent200Response.ts +1 -1
- package/generated/src/models/FetchEventRequest.ts +88 -0
- package/generated/src/models/FetchEvents200Response.ts +1 -1
- package/generated/src/models/FetchEventsRequest.ts +1 -1
- package/generated/src/models/FetchMarket200Response.ts +1 -1
- package/generated/src/models/FetchMarketRequest.ts +1 -1
- package/generated/src/models/FetchMarkets200Response.ts +1 -1
- package/generated/src/models/FetchMarketsPaginated200Response.ts +96 -0
- package/generated/src/models/FetchMarketsPaginatedRequest.ts +88 -0
- package/generated/src/models/FetchMarketsPaginatedRequestArgsInner.ts +73 -0
- package/generated/src/models/FetchMarketsRequest.ts +1 -9
- package/generated/src/models/FetchMyTrades200Response.ts +96 -0
- package/generated/src/models/FetchMyTradesRequest.ts +88 -0
- package/generated/src/models/FetchOHLCV200Response.ts +1 -1
- package/generated/src/models/FetchOHLCVRequest.ts +2 -2
- package/generated/src/models/FetchOHLCVRequestArgsInner.ts +12 -12
- package/generated/src/models/FetchOHLCVRequestArgsInnerOneOf.ts +80 -0
- package/generated/src/models/FetchOpenOrders200Response.ts +1 -1
- package/generated/src/models/FetchOpenOrdersRequest.ts +1 -1
- package/generated/src/models/FetchOrderBook200Response.ts +1 -1
- package/generated/src/models/FetchOrderBookRequest.ts +1 -1
- package/generated/src/models/{WatchPricesRequest.ts → FetchOrderRequest.ts} +13 -13
- package/generated/src/models/FetchPositions200Response.ts +1 -1
- package/generated/src/models/FetchPositionsRequest.ts +2 -2
- package/generated/src/models/FetchTrades200Response.ts +1 -1
- package/generated/src/models/FetchTradesRequest.ts +2 -2
- package/generated/src/models/FetchTradesRequestArgsInner.ts +12 -12
- package/generated/src/models/FetchTradesRequestArgsInnerOneOf.ts +80 -0
- package/generated/src/models/FilterEventsRequest.ts +2 -2
- package/generated/src/models/FilterEventsRequestArgsInner.ts +4 -4
- package/generated/src/models/FilterMarketsRequest.ts +2 -2
- package/generated/src/models/FilterMarketsRequestArgsInner.ts +4 -4
- package/generated/src/models/FilterMarketsRequestArgsInnerOneOf.ts +6 -4
- package/generated/src/models/GetExecutionPrice200Response.ts +1 -1
- package/generated/src/models/GetExecutionPriceDetailed200Response.ts +1 -1
- package/generated/src/models/GetExecutionPriceDetailedRequest.ts +89 -0
- package/generated/src/models/GetExecutionPriceRequest.ts +2 -2
- package/generated/src/models/GetExecutionPriceRequestArgsInner.ts +1 -1
- package/generated/src/models/HealthCheck200Response.ts +1 -1
- package/generated/src/models/HistoryFilterParams.ts +1 -1
- package/generated/src/models/LoadMarkets200Response.ts +96 -0
- package/generated/src/models/LoadMarketsRequest.ts +81 -0
- package/generated/src/models/MarketFilterParams.ts +1 -1
- package/generated/src/models/MarketOutcome.ts +1 -1
- package/generated/src/models/MyTradesParams.ts +105 -0
- package/generated/src/models/OHLCVParams.ts +1 -1
- package/generated/src/models/Order.ts +1 -1
- package/generated/src/models/OrderBook.ts +1 -1
- package/generated/src/models/OrderHistoryParams.ts +97 -0
- package/generated/src/models/OrderLevel.ts +1 -1
- package/generated/src/models/PaginatedMarketsResult.ts +89 -0
- package/generated/src/models/Position.ts +1 -1
- package/generated/src/models/PriceCandle.ts +1 -1
- package/generated/src/models/Trade.ts +1 -1
- package/generated/src/models/TradesParams.ts +1 -1
- package/generated/src/models/UnifiedEvent.ts +1 -1
- package/generated/src/models/UnifiedMarket.ts +1 -1
- package/generated/src/models/UserTrade.ts +133 -0
- package/generated/src/models/WatchOrderBookRequest.ts +2 -2
- package/generated/src/models/WatchOrderBookRequestArgsInner.ts +1 -1
- package/generated/src/models/WatchTradesRequest.ts +2 -2
- package/generated/src/models/index.ts +20 -2
- package/generated/src/runtime.ts +1 -1
- package/package.json +2 -2
- package/pmxt/client.ts +6 -4
- package/dist/esm/generated/src/models/WatchUserPositionsRequest.d.ts +0 -33
- package/dist/generated/src/models/WatchUserPositionsRequest.d.ts +0 -33
|
@@ -5,29 +5,31 @@ All URIs are relative to *http://localhost:3847*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**cancelOrder**](DefaultApi.md#cancelorderoperation) | **POST** /api/{exchange}/cancelOrder | Cancel Order |
|
|
8
|
-
| [**close**](DefaultApi.md#
|
|
8
|
+
| [**close**](DefaultApi.md#closeoperation) | **POST** /api/{exchange}/close | Close |
|
|
9
9
|
| [**createOrder**](DefaultApi.md#createorderoperation) | **POST** /api/{exchange}/createOrder | Create Order |
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
10
|
+
| [**fetchAllOrders**](DefaultApi.md#fetchallordersoperation) | **POST** /api/{exchange}/fetchAllOrders | Fetch All Orders |
|
|
11
|
+
| [**fetchBalance**](DefaultApi.md#fetchbalanceoperation) | **POST** /api/{exchange}/fetchBalance | Fetch Balance |
|
|
12
|
+
| [**fetchClosedOrders**](DefaultApi.md#fetchclosedordersoperation) | **POST** /api/{exchange}/fetchClosedOrders | Fetch Closed Orders |
|
|
13
|
+
| [**fetchEvent**](DefaultApi.md#fetcheventoperation) | **POST** /api/{exchange}/fetchEvent | Fetch Event |
|
|
12
14
|
| [**fetchEvents**](DefaultApi.md#fetcheventsoperation) | **POST** /api/{exchange}/fetchEvents | Fetch Events |
|
|
13
|
-
| [**fetchMarket**](DefaultApi.md#fetchmarketoperation) | **POST** /api/{exchange}/fetchMarket | Fetch
|
|
15
|
+
| [**fetchMarket**](DefaultApi.md#fetchmarketoperation) | **POST** /api/{exchange}/fetchMarket | Fetch Market |
|
|
14
16
|
| [**fetchMarkets**](DefaultApi.md#fetchmarketsoperation) | **POST** /api/{exchange}/fetchMarkets | Fetch Markets |
|
|
15
|
-
| [**
|
|
17
|
+
| [**fetchMarketsPaginated**](DefaultApi.md#fetchmarketspaginatedoperation) | **POST** /api/{exchange}/fetchMarketsPaginated | Fetch Markets Paginated |
|
|
18
|
+
| [**fetchMyTrades**](DefaultApi.md#fetchmytradesoperation) | **POST** /api/{exchange}/fetchMyTrades | Fetch My Trades |
|
|
19
|
+
| [**fetchOHLCV**](DefaultApi.md#fetchohlcvoperation) | **POST** /api/{exchange}/fetchOHLCV | Fetch O H L C V |
|
|
16
20
|
| [**fetchOpenOrders**](DefaultApi.md#fetchopenordersoperation) | **POST** /api/{exchange}/fetchOpenOrders | Fetch Open Orders |
|
|
17
|
-
| [**fetchOrder**](DefaultApi.md#
|
|
21
|
+
| [**fetchOrder**](DefaultApi.md#fetchorderoperation) | **POST** /api/{exchange}/fetchOrder | Fetch Order |
|
|
18
22
|
| [**fetchOrderBook**](DefaultApi.md#fetchorderbookoperation) | **POST** /api/{exchange}/fetchOrderBook | Fetch Order Book |
|
|
19
23
|
| [**fetchPositions**](DefaultApi.md#fetchpositionsoperation) | **POST** /api/{exchange}/fetchPositions | Fetch Positions |
|
|
20
24
|
| [**fetchTrades**](DefaultApi.md#fetchtradesoperation) | **POST** /api/{exchange}/fetchTrades | Fetch Trades |
|
|
21
25
|
| [**filterEvents**](DefaultApi.md#filtereventsoperation) | **POST** /api/{exchange}/filterEvents | Filter Events |
|
|
22
26
|
| [**filterMarkets**](DefaultApi.md#filtermarketsoperation) | **POST** /api/{exchange}/filterMarkets | Filter Markets |
|
|
23
27
|
| [**getExecutionPrice**](DefaultApi.md#getexecutionpriceoperation) | **POST** /api/{exchange}/getExecutionPrice | Get Execution Price |
|
|
24
|
-
| [**getExecutionPriceDetailed**](DefaultApi.md#
|
|
28
|
+
| [**getExecutionPriceDetailed**](DefaultApi.md#getexecutionpricedetailedoperation) | **POST** /api/{exchange}/getExecutionPriceDetailed | Get Execution Price Detailed |
|
|
25
29
|
| [**healthCheck**](DefaultApi.md#healthcheck) | **GET** /health | Server Health Check |
|
|
26
|
-
| [**
|
|
27
|
-
| [**
|
|
28
|
-
| [**watchTrades**](DefaultApi.md#watchtradesoperation) | **POST** /api/{exchange}/watchTrades | Watch Trades
|
|
29
|
-
| [**watchUserPositions**](DefaultApi.md#watchuserpositionsoperation) | **POST** /api/{exchange}/watchUserPositions | Watch User Positions (WebSocket Stream) |
|
|
30
|
-
| [**watchUserTransactions**](DefaultApi.md#watchusertransactions) | **POST** /api/{exchange}/watchUserTransactions | Watch User Transactions (WebSocket Stream) |
|
|
30
|
+
| [**loadMarkets**](DefaultApi.md#loadmarketsoperation) | **POST** /api/{exchange}/loadMarkets | Load Markets |
|
|
31
|
+
| [**watchOrderBook**](DefaultApi.md#watchorderbookoperation) | **POST** /api/{exchange}/watchOrderBook | Watch Order Book |
|
|
32
|
+
| [**watchTrades**](DefaultApi.md#watchtradesoperation) | **POST** /api/{exchange}/watchTrades | Watch Trades |
|
|
31
33
|
|
|
32
34
|
|
|
33
35
|
|
|
@@ -37,6 +39,8 @@ All URIs are relative to *http://localhost:3847*
|
|
|
37
39
|
|
|
38
40
|
Cancel Order
|
|
39
41
|
|
|
42
|
+
Cancel an existing open order.
|
|
43
|
+
|
|
40
44
|
### Example
|
|
41
45
|
|
|
42
46
|
```ts
|
|
@@ -94,18 +98,18 @@ No authorization required
|
|
|
94
98
|
### HTTP response details
|
|
95
99
|
| Status code | Description | Response headers |
|
|
96
100
|
|-------------|-------------|------------------|
|
|
97
|
-
| **200** | Order
|
|
101
|
+
| **200** | Cancel Order response | - |
|
|
98
102
|
|
|
99
103
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
100
104
|
|
|
101
105
|
|
|
102
106
|
## close
|
|
103
107
|
|
|
104
|
-
> BaseResponse close(exchange,
|
|
108
|
+
> BaseResponse close(exchange, closeRequest)
|
|
105
109
|
|
|
106
|
-
Close
|
|
110
|
+
Close
|
|
107
111
|
|
|
108
|
-
Close all WebSocket connections and
|
|
112
|
+
Close all WebSocket connections and clean up resources. Call this when you\'re done streaming to properly release connections.
|
|
109
113
|
|
|
110
114
|
### Example
|
|
111
115
|
|
|
@@ -114,7 +118,7 @@ import {
|
|
|
114
118
|
Configuration,
|
|
115
119
|
DefaultApi,
|
|
116
120
|
} from 'pmxtjs';
|
|
117
|
-
import type {
|
|
121
|
+
import type { CloseOperationRequest } from 'pmxtjs';
|
|
118
122
|
|
|
119
123
|
async function example() {
|
|
120
124
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -123,9 +127,9 @@ async function example() {
|
|
|
123
127
|
const body = {
|
|
124
128
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
125
129
|
exchange: exchange_example,
|
|
126
|
-
//
|
|
127
|
-
|
|
128
|
-
} satisfies
|
|
130
|
+
// CloseRequest (optional)
|
|
131
|
+
closeRequest: ...,
|
|
132
|
+
} satisfies CloseOperationRequest;
|
|
129
133
|
|
|
130
134
|
try {
|
|
131
135
|
const data = await api.close(body);
|
|
@@ -145,7 +149,7 @@ example().catch(console.error);
|
|
|
145
149
|
| Name | Type | Description | Notes |
|
|
146
150
|
|------------- | ------------- | ------------- | -------------|
|
|
147
151
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
148
|
-
| **
|
|
152
|
+
| **closeRequest** | [CloseRequest](CloseRequest.md) | | [Optional] |
|
|
149
153
|
|
|
150
154
|
### Return type
|
|
151
155
|
|
|
@@ -164,7 +168,7 @@ No authorization required
|
|
|
164
168
|
### HTTP response details
|
|
165
169
|
| Status code | Description | Response headers |
|
|
166
170
|
|-------------|-------------|------------------|
|
|
167
|
-
| **200** |
|
|
171
|
+
| **200** | Close response | - |
|
|
168
172
|
|
|
169
173
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
170
174
|
|
|
@@ -175,6 +179,8 @@ No authorization required
|
|
|
175
179
|
|
|
176
180
|
Create Order
|
|
177
181
|
|
|
182
|
+
Place a new order on the exchange.
|
|
183
|
+
|
|
178
184
|
### Example
|
|
179
185
|
|
|
180
186
|
```ts
|
|
@@ -232,17 +238,87 @@ No authorization required
|
|
|
232
238
|
### HTTP response details
|
|
233
239
|
| Status code | Description | Response headers |
|
|
234
240
|
|-------------|-------------|------------------|
|
|
235
|
-
| **200** | Order
|
|
241
|
+
| **200** | Create Order response | - |
|
|
242
|
+
|
|
243
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
## fetchAllOrders
|
|
247
|
+
|
|
248
|
+
> FetchOpenOrders200Response fetchAllOrders(exchange, fetchAllOrdersRequest)
|
|
249
|
+
|
|
250
|
+
Fetch All Orders
|
|
251
|
+
|
|
252
|
+
### Example
|
|
253
|
+
|
|
254
|
+
```ts
|
|
255
|
+
import {
|
|
256
|
+
Configuration,
|
|
257
|
+
DefaultApi,
|
|
258
|
+
} from 'pmxtjs';
|
|
259
|
+
import type { FetchAllOrdersOperationRequest } from 'pmxtjs';
|
|
260
|
+
|
|
261
|
+
async function example() {
|
|
262
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
263
|
+
const api = new DefaultApi();
|
|
264
|
+
|
|
265
|
+
const body = {
|
|
266
|
+
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
267
|
+
exchange: exchange_example,
|
|
268
|
+
// FetchAllOrdersRequest (optional)
|
|
269
|
+
fetchAllOrdersRequest: ...,
|
|
270
|
+
} satisfies FetchAllOrdersOperationRequest;
|
|
271
|
+
|
|
272
|
+
try {
|
|
273
|
+
const data = await api.fetchAllOrders(body);
|
|
274
|
+
console.log(data);
|
|
275
|
+
} catch (error) {
|
|
276
|
+
console.error(error);
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
// Run the test
|
|
281
|
+
example().catch(console.error);
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### Parameters
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
| Name | Type | Description | Notes |
|
|
288
|
+
|------------- | ------------- | ------------- | -------------|
|
|
289
|
+
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
290
|
+
| **fetchAllOrdersRequest** | [FetchAllOrdersRequest](FetchAllOrdersRequest.md) | | [Optional] |
|
|
291
|
+
|
|
292
|
+
### Return type
|
|
293
|
+
|
|
294
|
+
[**FetchOpenOrders200Response**](FetchOpenOrders200Response.md)
|
|
295
|
+
|
|
296
|
+
### Authorization
|
|
297
|
+
|
|
298
|
+
No authorization required
|
|
299
|
+
|
|
300
|
+
### HTTP request headers
|
|
301
|
+
|
|
302
|
+
- **Content-Type**: `application/json`
|
|
303
|
+
- **Accept**: `application/json`
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
### HTTP response details
|
|
307
|
+
| Status code | Description | Response headers |
|
|
308
|
+
|-------------|-------------|------------------|
|
|
309
|
+
| **200** | Fetch All Orders response | - |
|
|
236
310
|
|
|
237
311
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
238
312
|
|
|
239
313
|
|
|
240
314
|
## fetchBalance
|
|
241
315
|
|
|
242
|
-
> FetchBalance200Response fetchBalance(exchange,
|
|
316
|
+
> FetchBalance200Response fetchBalance(exchange, fetchBalanceRequest)
|
|
243
317
|
|
|
244
318
|
Fetch Balance
|
|
245
319
|
|
|
320
|
+
Fetch account balances.
|
|
321
|
+
|
|
246
322
|
### Example
|
|
247
323
|
|
|
248
324
|
```ts
|
|
@@ -250,7 +326,7 @@ import {
|
|
|
250
326
|
Configuration,
|
|
251
327
|
DefaultApi,
|
|
252
328
|
} from 'pmxtjs';
|
|
253
|
-
import type {
|
|
329
|
+
import type { FetchBalanceOperationRequest } from 'pmxtjs';
|
|
254
330
|
|
|
255
331
|
async function example() {
|
|
256
332
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -259,9 +335,9 @@ async function example() {
|
|
|
259
335
|
const body = {
|
|
260
336
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
261
337
|
exchange: exchange_example,
|
|
262
|
-
//
|
|
263
|
-
|
|
264
|
-
} satisfies
|
|
338
|
+
// FetchBalanceRequest (optional)
|
|
339
|
+
fetchBalanceRequest: ...,
|
|
340
|
+
} satisfies FetchBalanceOperationRequest;
|
|
265
341
|
|
|
266
342
|
try {
|
|
267
343
|
const data = await api.fetchBalance(body);
|
|
@@ -281,7 +357,7 @@ example().catch(console.error);
|
|
|
281
357
|
| Name | Type | Description | Notes |
|
|
282
358
|
|------------- | ------------- | ------------- | -------------|
|
|
283
359
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
284
|
-
| **
|
|
360
|
+
| **fetchBalanceRequest** | [FetchBalanceRequest](FetchBalanceRequest.md) | | [Optional] |
|
|
285
361
|
|
|
286
362
|
### Return type
|
|
287
363
|
|
|
@@ -300,18 +376,86 @@ No authorization required
|
|
|
300
376
|
### HTTP response details
|
|
301
377
|
| Status code | Description | Response headers |
|
|
302
378
|
|-------------|-------------|------------------|
|
|
303
|
-
| **200** |
|
|
379
|
+
| **200** | Fetch Balance response | - |
|
|
380
|
+
|
|
381
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
## fetchClosedOrders
|
|
385
|
+
|
|
386
|
+
> FetchOpenOrders200Response fetchClosedOrders(exchange, fetchClosedOrdersRequest)
|
|
387
|
+
|
|
388
|
+
Fetch Closed Orders
|
|
389
|
+
|
|
390
|
+
### Example
|
|
391
|
+
|
|
392
|
+
```ts
|
|
393
|
+
import {
|
|
394
|
+
Configuration,
|
|
395
|
+
DefaultApi,
|
|
396
|
+
} from 'pmxtjs';
|
|
397
|
+
import type { FetchClosedOrdersOperationRequest } from 'pmxtjs';
|
|
398
|
+
|
|
399
|
+
async function example() {
|
|
400
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
401
|
+
const api = new DefaultApi();
|
|
402
|
+
|
|
403
|
+
const body = {
|
|
404
|
+
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
405
|
+
exchange: exchange_example,
|
|
406
|
+
// FetchClosedOrdersRequest (optional)
|
|
407
|
+
fetchClosedOrdersRequest: ...,
|
|
408
|
+
} satisfies FetchClosedOrdersOperationRequest;
|
|
409
|
+
|
|
410
|
+
try {
|
|
411
|
+
const data = await api.fetchClosedOrders(body);
|
|
412
|
+
console.log(data);
|
|
413
|
+
} catch (error) {
|
|
414
|
+
console.error(error);
|
|
415
|
+
}
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
// Run the test
|
|
419
|
+
example().catch(console.error);
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
### Parameters
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
| Name | Type | Description | Notes |
|
|
426
|
+
|------------- | ------------- | ------------- | -------------|
|
|
427
|
+
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
428
|
+
| **fetchClosedOrdersRequest** | [FetchClosedOrdersRequest](FetchClosedOrdersRequest.md) | | [Optional] |
|
|
429
|
+
|
|
430
|
+
### Return type
|
|
431
|
+
|
|
432
|
+
[**FetchOpenOrders200Response**](FetchOpenOrders200Response.md)
|
|
433
|
+
|
|
434
|
+
### Authorization
|
|
435
|
+
|
|
436
|
+
No authorization required
|
|
437
|
+
|
|
438
|
+
### HTTP request headers
|
|
439
|
+
|
|
440
|
+
- **Content-Type**: `application/json`
|
|
441
|
+
- **Accept**: `application/json`
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
### HTTP response details
|
|
445
|
+
| Status code | Description | Response headers |
|
|
446
|
+
|-------------|-------------|------------------|
|
|
447
|
+
| **200** | Fetch Closed Orders response | - |
|
|
304
448
|
|
|
305
449
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
306
450
|
|
|
307
451
|
|
|
308
452
|
## fetchEvent
|
|
309
453
|
|
|
310
|
-
> FetchEvent200Response fetchEvent(exchange,
|
|
454
|
+
> FetchEvent200Response fetchEvent(exchange, fetchEventRequest)
|
|
311
455
|
|
|
312
|
-
Fetch
|
|
456
|
+
Fetch Event
|
|
313
457
|
|
|
314
|
-
Fetch a single event by lookup parameters.
|
|
458
|
+
Fetch a single event by lookup parameters. Convenience wrapper around fetchEvents() that returns a single result or throws EventNotFound.
|
|
315
459
|
|
|
316
460
|
### Example
|
|
317
461
|
|
|
@@ -320,7 +464,7 @@ import {
|
|
|
320
464
|
Configuration,
|
|
321
465
|
DefaultApi,
|
|
322
466
|
} from 'pmxtjs';
|
|
323
|
-
import type {
|
|
467
|
+
import type { FetchEventOperationRequest } from 'pmxtjs';
|
|
324
468
|
|
|
325
469
|
async function example() {
|
|
326
470
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -329,9 +473,9 @@ async function example() {
|
|
|
329
473
|
const body = {
|
|
330
474
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
331
475
|
exchange: exchange_example,
|
|
332
|
-
//
|
|
333
|
-
|
|
334
|
-
} satisfies
|
|
476
|
+
// FetchEventRequest (optional)
|
|
477
|
+
fetchEventRequest: ...,
|
|
478
|
+
} satisfies FetchEventOperationRequest;
|
|
335
479
|
|
|
336
480
|
try {
|
|
337
481
|
const data = await api.fetchEvent(body);
|
|
@@ -351,7 +495,7 @@ example().catch(console.error);
|
|
|
351
495
|
| Name | Type | Description | Notes |
|
|
352
496
|
|------------- | ------------- | ------------- | -------------|
|
|
353
497
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
354
|
-
| **
|
|
498
|
+
| **fetchEventRequest** | [FetchEventRequest](FetchEventRequest.md) | | [Optional] |
|
|
355
499
|
|
|
356
500
|
### Return type
|
|
357
501
|
|
|
@@ -370,8 +514,7 @@ No authorization required
|
|
|
370
514
|
### HTTP response details
|
|
371
515
|
| Status code | Description | Response headers |
|
|
372
516
|
|-------------|-------------|------------------|
|
|
373
|
-
| **200** |
|
|
374
|
-
| **404** | Event not found | - |
|
|
517
|
+
| **200** | Fetch Event response | - |
|
|
375
518
|
|
|
376
519
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
377
520
|
|
|
@@ -382,6 +525,8 @@ No authorization required
|
|
|
382
525
|
|
|
383
526
|
Fetch Events
|
|
384
527
|
|
|
528
|
+
Fetch events with optional keyword search. Events group related markets together (e.g., \"Who will be Fed Chair?\" contains multiple candidate markets).
|
|
529
|
+
|
|
385
530
|
### Example
|
|
386
531
|
|
|
387
532
|
```ts
|
|
@@ -439,7 +584,7 @@ No authorization required
|
|
|
439
584
|
### HTTP response details
|
|
440
585
|
| Status code | Description | Response headers |
|
|
441
586
|
|-------------|-------------|------------------|
|
|
442
|
-
| **200** |
|
|
587
|
+
| **200** | Fetch Events response | - |
|
|
443
588
|
|
|
444
589
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
445
590
|
|
|
@@ -448,9 +593,9 @@ No authorization required
|
|
|
448
593
|
|
|
449
594
|
> FetchMarket200Response fetchMarket(exchange, fetchMarketRequest)
|
|
450
595
|
|
|
451
|
-
Fetch
|
|
596
|
+
Fetch Market
|
|
452
597
|
|
|
453
|
-
Fetch a single market by lookup parameters.
|
|
598
|
+
Fetch a single market by lookup parameters. Convenience wrapper around fetchMarkets() that returns a single result or throws MarketNotFound.
|
|
454
599
|
|
|
455
600
|
### Example
|
|
456
601
|
|
|
@@ -509,8 +654,7 @@ No authorization required
|
|
|
509
654
|
### HTTP response details
|
|
510
655
|
| Status code | Description | Response headers |
|
|
511
656
|
|-------------|-------------|------------------|
|
|
512
|
-
| **200** |
|
|
513
|
-
| **404** | Market not found | - |
|
|
657
|
+
| **200** | Fetch Market response | - |
|
|
514
658
|
|
|
515
659
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
516
660
|
|
|
@@ -521,6 +665,8 @@ No authorization required
|
|
|
521
665
|
|
|
522
666
|
Fetch Markets
|
|
523
667
|
|
|
668
|
+
Fetch markets with optional filtering, search, or slug lookup. Always hits the exchange API — results reflect the live state at the time of the call.
|
|
669
|
+
|
|
524
670
|
### Example
|
|
525
671
|
|
|
526
672
|
```ts
|
|
@@ -578,16 +724,18 @@ No authorization required
|
|
|
578
724
|
### HTTP response details
|
|
579
725
|
| Status code | Description | Response headers |
|
|
580
726
|
|-------------|-------------|------------------|
|
|
581
|
-
| **200** |
|
|
727
|
+
| **200** | Fetch Markets response | - |
|
|
582
728
|
|
|
583
729
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
584
730
|
|
|
585
731
|
|
|
586
|
-
##
|
|
732
|
+
## fetchMarketsPaginated
|
|
587
733
|
|
|
588
|
-
>
|
|
734
|
+
> FetchMarketsPaginated200Response fetchMarketsPaginated(exchange, fetchMarketsPaginatedRequest)
|
|
589
735
|
|
|
590
|
-
Fetch
|
|
736
|
+
Fetch Markets Paginated
|
|
737
|
+
|
|
738
|
+
Fetch markets with cursor-based pagination backed by a stable in-memory snapshot. On the first call (or when no cursor is supplied), fetches all markets once and caches them. Subsequent calls with a cursor returned from a previous call slice directly from the cached snapshot — no additional API calls are made. The snapshot is invalidated after `snapshotTTL` ms (configured via `ExchangeOptions` in the constructor). A request using a cursor from an expired snapshot throws `\'Cursor has expired\'`.
|
|
591
739
|
|
|
592
740
|
### Example
|
|
593
741
|
|
|
@@ -596,7 +744,7 @@ import {
|
|
|
596
744
|
Configuration,
|
|
597
745
|
DefaultApi,
|
|
598
746
|
} from 'pmxtjs';
|
|
599
|
-
import type {
|
|
747
|
+
import type { FetchMarketsPaginatedOperationRequest } from 'pmxtjs';
|
|
600
748
|
|
|
601
749
|
async function example() {
|
|
602
750
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -605,12 +753,12 @@ async function example() {
|
|
|
605
753
|
const body = {
|
|
606
754
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
607
755
|
exchange: exchange_example,
|
|
608
|
-
//
|
|
609
|
-
|
|
610
|
-
} satisfies
|
|
756
|
+
// FetchMarketsPaginatedRequest (optional)
|
|
757
|
+
fetchMarketsPaginatedRequest: ...,
|
|
758
|
+
} satisfies FetchMarketsPaginatedOperationRequest;
|
|
611
759
|
|
|
612
760
|
try {
|
|
613
|
-
const data = await api.
|
|
761
|
+
const data = await api.fetchMarketsPaginated(body);
|
|
614
762
|
console.log(data);
|
|
615
763
|
} catch (error) {
|
|
616
764
|
console.error(error);
|
|
@@ -627,11 +775,11 @@ example().catch(console.error);
|
|
|
627
775
|
| Name | Type | Description | Notes |
|
|
628
776
|
|------------- | ------------- | ------------- | -------------|
|
|
629
777
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
630
|
-
| **
|
|
778
|
+
| **fetchMarketsPaginatedRequest** | [FetchMarketsPaginatedRequest](FetchMarketsPaginatedRequest.md) | | [Optional] |
|
|
631
779
|
|
|
632
780
|
### Return type
|
|
633
781
|
|
|
634
|
-
[**
|
|
782
|
+
[**FetchMarketsPaginated200Response**](FetchMarketsPaginated200Response.md)
|
|
635
783
|
|
|
636
784
|
### Authorization
|
|
637
785
|
|
|
@@ -646,16 +794,16 @@ No authorization required
|
|
|
646
794
|
### HTTP response details
|
|
647
795
|
| Status code | Description | Response headers |
|
|
648
796
|
|-------------|-------------|------------------|
|
|
649
|
-
| **200** |
|
|
797
|
+
| **200** | Fetch Markets Paginated response | - |
|
|
650
798
|
|
|
651
799
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
652
800
|
|
|
653
801
|
|
|
654
|
-
##
|
|
802
|
+
## fetchMyTrades
|
|
655
803
|
|
|
656
|
-
>
|
|
804
|
+
> FetchMyTrades200Response fetchMyTrades(exchange, fetchMyTradesRequest)
|
|
657
805
|
|
|
658
|
-
Fetch
|
|
806
|
+
Fetch My Trades
|
|
659
807
|
|
|
660
808
|
### Example
|
|
661
809
|
|
|
@@ -664,7 +812,7 @@ import {
|
|
|
664
812
|
Configuration,
|
|
665
813
|
DefaultApi,
|
|
666
814
|
} from 'pmxtjs';
|
|
667
|
-
import type {
|
|
815
|
+
import type { FetchMyTradesOperationRequest } from 'pmxtjs';
|
|
668
816
|
|
|
669
817
|
async function example() {
|
|
670
818
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -673,12 +821,12 @@ async function example() {
|
|
|
673
821
|
const body = {
|
|
674
822
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
675
823
|
exchange: exchange_example,
|
|
676
|
-
//
|
|
677
|
-
|
|
678
|
-
} satisfies
|
|
824
|
+
// FetchMyTradesRequest (optional)
|
|
825
|
+
fetchMyTradesRequest: ...,
|
|
826
|
+
} satisfies FetchMyTradesOperationRequest;
|
|
679
827
|
|
|
680
828
|
try {
|
|
681
|
-
const data = await api.
|
|
829
|
+
const data = await api.fetchMyTrades(body);
|
|
682
830
|
console.log(data);
|
|
683
831
|
} catch (error) {
|
|
684
832
|
console.error(error);
|
|
@@ -695,11 +843,11 @@ example().catch(console.error);
|
|
|
695
843
|
| Name | Type | Description | Notes |
|
|
696
844
|
|------------- | ------------- | ------------- | -------------|
|
|
697
845
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
698
|
-
| **
|
|
846
|
+
| **fetchMyTradesRequest** | [FetchMyTradesRequest](FetchMyTradesRequest.md) | | [Optional] |
|
|
699
847
|
|
|
700
848
|
### Return type
|
|
701
849
|
|
|
702
|
-
[**
|
|
850
|
+
[**FetchMyTrades200Response**](FetchMyTrades200Response.md)
|
|
703
851
|
|
|
704
852
|
### Authorization
|
|
705
853
|
|
|
@@ -714,16 +862,18 @@ No authorization required
|
|
|
714
862
|
### HTTP response details
|
|
715
863
|
| Status code | Description | Response headers |
|
|
716
864
|
|-------------|-------------|------------------|
|
|
717
|
-
| **200** |
|
|
865
|
+
| **200** | Fetch My Trades response | - |
|
|
718
866
|
|
|
719
867
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
720
868
|
|
|
721
869
|
|
|
722
|
-
##
|
|
870
|
+
## fetchOHLCV
|
|
871
|
+
|
|
872
|
+
> FetchOHLCV200Response fetchOHLCV(exchange, fetchOHLCVRequest)
|
|
723
873
|
|
|
724
|
-
|
|
874
|
+
Fetch O H L C V
|
|
725
875
|
|
|
726
|
-
Fetch
|
|
876
|
+
Fetch historical OHLCV (candlestick) price data for a specific market outcome.
|
|
727
877
|
|
|
728
878
|
### Example
|
|
729
879
|
|
|
@@ -732,7 +882,7 @@ import {
|
|
|
732
882
|
Configuration,
|
|
733
883
|
DefaultApi,
|
|
734
884
|
} from 'pmxtjs';
|
|
735
|
-
import type {
|
|
885
|
+
import type { FetchOHLCVOperationRequest } from 'pmxtjs';
|
|
736
886
|
|
|
737
887
|
async function example() {
|
|
738
888
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -741,12 +891,12 @@ async function example() {
|
|
|
741
891
|
const body = {
|
|
742
892
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
743
893
|
exchange: exchange_example,
|
|
744
|
-
//
|
|
745
|
-
|
|
746
|
-
} satisfies
|
|
894
|
+
// FetchOHLCVRequest (optional)
|
|
895
|
+
fetchOHLCVRequest: ...,
|
|
896
|
+
} satisfies FetchOHLCVOperationRequest;
|
|
747
897
|
|
|
748
898
|
try {
|
|
749
|
-
const data = await api.
|
|
899
|
+
const data = await api.fetchOHLCV(body);
|
|
750
900
|
console.log(data);
|
|
751
901
|
} catch (error) {
|
|
752
902
|
console.error(error);
|
|
@@ -763,11 +913,11 @@ example().catch(console.error);
|
|
|
763
913
|
| Name | Type | Description | Notes |
|
|
764
914
|
|------------- | ------------- | ------------- | -------------|
|
|
765
915
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
766
|
-
| **
|
|
916
|
+
| **fetchOHLCVRequest** | [FetchOHLCVRequest](FetchOHLCVRequest.md) | | [Optional] |
|
|
767
917
|
|
|
768
918
|
### Return type
|
|
769
919
|
|
|
770
|
-
[**
|
|
920
|
+
[**FetchOHLCV200Response**](FetchOHLCV200Response.md)
|
|
771
921
|
|
|
772
922
|
### Authorization
|
|
773
923
|
|
|
@@ -782,16 +932,18 @@ No authorization required
|
|
|
782
932
|
### HTTP response details
|
|
783
933
|
| Status code | Description | Response headers |
|
|
784
934
|
|-------------|-------------|------------------|
|
|
785
|
-
| **200** |
|
|
935
|
+
| **200** | Fetch O H L C V response | - |
|
|
786
936
|
|
|
787
937
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
788
938
|
|
|
789
939
|
|
|
790
|
-
##
|
|
940
|
+
## fetchOpenOrders
|
|
791
941
|
|
|
792
|
-
>
|
|
942
|
+
> FetchOpenOrders200Response fetchOpenOrders(exchange, fetchOpenOrdersRequest)
|
|
793
943
|
|
|
794
|
-
Fetch
|
|
944
|
+
Fetch Open Orders
|
|
945
|
+
|
|
946
|
+
Fetch all open orders, optionally filtered by market.
|
|
795
947
|
|
|
796
948
|
### Example
|
|
797
949
|
|
|
@@ -800,7 +952,7 @@ import {
|
|
|
800
952
|
Configuration,
|
|
801
953
|
DefaultApi,
|
|
802
954
|
} from 'pmxtjs';
|
|
803
|
-
import type {
|
|
955
|
+
import type { FetchOpenOrdersOperationRequest } from 'pmxtjs';
|
|
804
956
|
|
|
805
957
|
async function example() {
|
|
806
958
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -809,12 +961,12 @@ async function example() {
|
|
|
809
961
|
const body = {
|
|
810
962
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
811
963
|
exchange: exchange_example,
|
|
812
|
-
//
|
|
813
|
-
|
|
814
|
-
} satisfies
|
|
964
|
+
// FetchOpenOrdersRequest (optional)
|
|
965
|
+
fetchOpenOrdersRequest: ...,
|
|
966
|
+
} satisfies FetchOpenOrdersOperationRequest;
|
|
815
967
|
|
|
816
968
|
try {
|
|
817
|
-
const data = await api.
|
|
969
|
+
const data = await api.fetchOpenOrders(body);
|
|
818
970
|
console.log(data);
|
|
819
971
|
} catch (error) {
|
|
820
972
|
console.error(error);
|
|
@@ -831,11 +983,11 @@ example().catch(console.error);
|
|
|
831
983
|
| Name | Type | Description | Notes |
|
|
832
984
|
|------------- | ------------- | ------------- | -------------|
|
|
833
985
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
834
|
-
| **
|
|
986
|
+
| **fetchOpenOrdersRequest** | [FetchOpenOrdersRequest](FetchOpenOrdersRequest.md) | | [Optional] |
|
|
835
987
|
|
|
836
988
|
### Return type
|
|
837
989
|
|
|
838
|
-
[**
|
|
990
|
+
[**FetchOpenOrders200Response**](FetchOpenOrders200Response.md)
|
|
839
991
|
|
|
840
992
|
### Authorization
|
|
841
993
|
|
|
@@ -850,16 +1002,18 @@ No authorization required
|
|
|
850
1002
|
### HTTP response details
|
|
851
1003
|
| Status code | Description | Response headers |
|
|
852
1004
|
|-------------|-------------|------------------|
|
|
853
|
-
| **200** |
|
|
1005
|
+
| **200** | Fetch Open Orders response | - |
|
|
854
1006
|
|
|
855
1007
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
856
1008
|
|
|
857
1009
|
|
|
858
|
-
##
|
|
1010
|
+
## fetchOrder
|
|
859
1011
|
|
|
860
|
-
>
|
|
1012
|
+
> CreateOrder200Response fetchOrder(exchange, fetchOrderRequest)
|
|
861
1013
|
|
|
862
|
-
Fetch
|
|
1014
|
+
Fetch Order
|
|
1015
|
+
|
|
1016
|
+
Fetch a specific order by ID.
|
|
863
1017
|
|
|
864
1018
|
### Example
|
|
865
1019
|
|
|
@@ -868,7 +1022,7 @@ import {
|
|
|
868
1022
|
Configuration,
|
|
869
1023
|
DefaultApi,
|
|
870
1024
|
} from 'pmxtjs';
|
|
871
|
-
import type {
|
|
1025
|
+
import type { FetchOrderOperationRequest } from 'pmxtjs';
|
|
872
1026
|
|
|
873
1027
|
async function example() {
|
|
874
1028
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -877,12 +1031,12 @@ async function example() {
|
|
|
877
1031
|
const body = {
|
|
878
1032
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
879
1033
|
exchange: exchange_example,
|
|
880
|
-
//
|
|
881
|
-
|
|
882
|
-
} satisfies
|
|
1034
|
+
// FetchOrderRequest (optional)
|
|
1035
|
+
fetchOrderRequest: ...,
|
|
1036
|
+
} satisfies FetchOrderOperationRequest;
|
|
883
1037
|
|
|
884
1038
|
try {
|
|
885
|
-
const data = await api.
|
|
1039
|
+
const data = await api.fetchOrder(body);
|
|
886
1040
|
console.log(data);
|
|
887
1041
|
} catch (error) {
|
|
888
1042
|
console.error(error);
|
|
@@ -899,11 +1053,11 @@ example().catch(console.error);
|
|
|
899
1053
|
| Name | Type | Description | Notes |
|
|
900
1054
|
|------------- | ------------- | ------------- | -------------|
|
|
901
1055
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
902
|
-
| **
|
|
1056
|
+
| **fetchOrderRequest** | [FetchOrderRequest](FetchOrderRequest.md) | | [Optional] |
|
|
903
1057
|
|
|
904
1058
|
### Return type
|
|
905
1059
|
|
|
906
|
-
[**
|
|
1060
|
+
[**CreateOrder200Response**](CreateOrder200Response.md)
|
|
907
1061
|
|
|
908
1062
|
### Authorization
|
|
909
1063
|
|
|
@@ -918,16 +1072,18 @@ No authorization required
|
|
|
918
1072
|
### HTTP response details
|
|
919
1073
|
| Status code | Description | Response headers |
|
|
920
1074
|
|-------------|-------------|------------------|
|
|
921
|
-
| **200** |
|
|
1075
|
+
| **200** | Fetch Order response | - |
|
|
922
1076
|
|
|
923
1077
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
924
1078
|
|
|
925
1079
|
|
|
926
|
-
##
|
|
1080
|
+
## fetchOrderBook
|
|
927
1081
|
|
|
928
|
-
>
|
|
1082
|
+
> FetchOrderBook200Response fetchOrderBook(exchange, fetchOrderBookRequest)
|
|
929
1083
|
|
|
930
|
-
Fetch
|
|
1084
|
+
Fetch Order Book
|
|
1085
|
+
|
|
1086
|
+
Fetch the current order book (bids/asks) for a specific outcome. Essential for calculating spread, depth, and execution prices.
|
|
931
1087
|
|
|
932
1088
|
### Example
|
|
933
1089
|
|
|
@@ -936,7 +1092,7 @@ import {
|
|
|
936
1092
|
Configuration,
|
|
937
1093
|
DefaultApi,
|
|
938
1094
|
} from 'pmxtjs';
|
|
939
|
-
import type {
|
|
1095
|
+
import type { FetchOrderBookOperationRequest } from 'pmxtjs';
|
|
940
1096
|
|
|
941
1097
|
async function example() {
|
|
942
1098
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -945,12 +1101,12 @@ async function example() {
|
|
|
945
1101
|
const body = {
|
|
946
1102
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
947
1103
|
exchange: exchange_example,
|
|
948
|
-
//
|
|
949
|
-
|
|
950
|
-
} satisfies
|
|
1104
|
+
// FetchOrderBookRequest (optional)
|
|
1105
|
+
fetchOrderBookRequest: ...,
|
|
1106
|
+
} satisfies FetchOrderBookOperationRequest;
|
|
951
1107
|
|
|
952
1108
|
try {
|
|
953
|
-
const data = await api.
|
|
1109
|
+
const data = await api.fetchOrderBook(body);
|
|
954
1110
|
console.log(data);
|
|
955
1111
|
} catch (error) {
|
|
956
1112
|
console.error(error);
|
|
@@ -967,11 +1123,11 @@ example().catch(console.error);
|
|
|
967
1123
|
| Name | Type | Description | Notes |
|
|
968
1124
|
|------------- | ------------- | ------------- | -------------|
|
|
969
1125
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
970
|
-
| **
|
|
1126
|
+
| **fetchOrderBookRequest** | [FetchOrderBookRequest](FetchOrderBookRequest.md) | | [Optional] |
|
|
971
1127
|
|
|
972
1128
|
### Return type
|
|
973
1129
|
|
|
974
|
-
[**
|
|
1130
|
+
[**FetchOrderBook200Response**](FetchOrderBook200Response.md)
|
|
975
1131
|
|
|
976
1132
|
### Authorization
|
|
977
1133
|
|
|
@@ -986,18 +1142,18 @@ No authorization required
|
|
|
986
1142
|
### HTTP response details
|
|
987
1143
|
| Status code | Description | Response headers |
|
|
988
1144
|
|-------------|-------------|------------------|
|
|
989
|
-
| **200** |
|
|
1145
|
+
| **200** | Fetch Order Book response | - |
|
|
990
1146
|
|
|
991
1147
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
992
1148
|
|
|
993
1149
|
|
|
994
|
-
##
|
|
1150
|
+
## fetchPositions
|
|
995
1151
|
|
|
996
|
-
>
|
|
1152
|
+
> FetchPositions200Response fetchPositions(exchange, fetchPositionsRequest)
|
|
997
1153
|
|
|
998
|
-
|
|
1154
|
+
Fetch Positions
|
|
999
1155
|
|
|
1000
|
-
|
|
1156
|
+
Fetch current user positions across all markets.
|
|
1001
1157
|
|
|
1002
1158
|
### Example
|
|
1003
1159
|
|
|
@@ -1006,7 +1162,7 @@ import {
|
|
|
1006
1162
|
Configuration,
|
|
1007
1163
|
DefaultApi,
|
|
1008
1164
|
} from 'pmxtjs';
|
|
1009
|
-
import type {
|
|
1165
|
+
import type { FetchPositionsOperationRequest } from 'pmxtjs';
|
|
1010
1166
|
|
|
1011
1167
|
async function example() {
|
|
1012
1168
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1015,12 +1171,12 @@ async function example() {
|
|
|
1015
1171
|
const body = {
|
|
1016
1172
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1017
1173
|
exchange: exchange_example,
|
|
1018
|
-
//
|
|
1019
|
-
|
|
1020
|
-
} satisfies
|
|
1174
|
+
// FetchPositionsRequest (optional)
|
|
1175
|
+
fetchPositionsRequest: ...,
|
|
1176
|
+
} satisfies FetchPositionsOperationRequest;
|
|
1021
1177
|
|
|
1022
1178
|
try {
|
|
1023
|
-
const data = await api.
|
|
1179
|
+
const data = await api.fetchPositions(body);
|
|
1024
1180
|
console.log(data);
|
|
1025
1181
|
} catch (error) {
|
|
1026
1182
|
console.error(error);
|
|
@@ -1037,11 +1193,11 @@ example().catch(console.error);
|
|
|
1037
1193
|
| Name | Type | Description | Notes |
|
|
1038
1194
|
|------------- | ------------- | ------------- | -------------|
|
|
1039
1195
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1040
|
-
| **
|
|
1196
|
+
| **fetchPositionsRequest** | [FetchPositionsRequest](FetchPositionsRequest.md) | | [Optional] |
|
|
1041
1197
|
|
|
1042
1198
|
### Return type
|
|
1043
1199
|
|
|
1044
|
-
[**
|
|
1200
|
+
[**FetchPositions200Response**](FetchPositions200Response.md)
|
|
1045
1201
|
|
|
1046
1202
|
### Authorization
|
|
1047
1203
|
|
|
@@ -1056,18 +1212,18 @@ No authorization required
|
|
|
1056
1212
|
### HTTP response details
|
|
1057
1213
|
| Status code | Description | Response headers |
|
|
1058
1214
|
|-------------|-------------|------------------|
|
|
1059
|
-
| **200** |
|
|
1215
|
+
| **200** | Fetch Positions response | - |
|
|
1060
1216
|
|
|
1061
1217
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1062
1218
|
|
|
1063
1219
|
|
|
1064
|
-
##
|
|
1220
|
+
## fetchTrades
|
|
1065
1221
|
|
|
1066
|
-
>
|
|
1222
|
+
> FetchTrades200Response fetchTrades(exchange, fetchTradesRequest)
|
|
1067
1223
|
|
|
1068
|
-
|
|
1224
|
+
Fetch Trades
|
|
1069
1225
|
|
|
1070
|
-
|
|
1226
|
+
Fetch raw trade history for a specific outcome.
|
|
1071
1227
|
|
|
1072
1228
|
### Example
|
|
1073
1229
|
|
|
@@ -1076,7 +1232,7 @@ import {
|
|
|
1076
1232
|
Configuration,
|
|
1077
1233
|
DefaultApi,
|
|
1078
1234
|
} from 'pmxtjs';
|
|
1079
|
-
import type {
|
|
1235
|
+
import type { FetchTradesOperationRequest } from 'pmxtjs';
|
|
1080
1236
|
|
|
1081
1237
|
async function example() {
|
|
1082
1238
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1085,12 +1241,12 @@ async function example() {
|
|
|
1085
1241
|
const body = {
|
|
1086
1242
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1087
1243
|
exchange: exchange_example,
|
|
1088
|
-
//
|
|
1089
|
-
|
|
1090
|
-
} satisfies
|
|
1244
|
+
// FetchTradesRequest (optional)
|
|
1245
|
+
fetchTradesRequest: ...,
|
|
1246
|
+
} satisfies FetchTradesOperationRequest;
|
|
1091
1247
|
|
|
1092
1248
|
try {
|
|
1093
|
-
const data = await api.
|
|
1249
|
+
const data = await api.fetchTrades(body);
|
|
1094
1250
|
console.log(data);
|
|
1095
1251
|
} catch (error) {
|
|
1096
1252
|
console.error(error);
|
|
@@ -1107,11 +1263,11 @@ example().catch(console.error);
|
|
|
1107
1263
|
| Name | Type | Description | Notes |
|
|
1108
1264
|
|------------- | ------------- | ------------- | -------------|
|
|
1109
1265
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1110
|
-
| **
|
|
1266
|
+
| **fetchTradesRequest** | [FetchTradesRequest](FetchTradesRequest.md) | | [Optional] |
|
|
1111
1267
|
|
|
1112
1268
|
### Return type
|
|
1113
1269
|
|
|
1114
|
-
[**
|
|
1270
|
+
[**FetchTrades200Response**](FetchTrades200Response.md)
|
|
1115
1271
|
|
|
1116
1272
|
### Authorization
|
|
1117
1273
|
|
|
@@ -1126,16 +1282,18 @@ No authorization required
|
|
|
1126
1282
|
### HTTP response details
|
|
1127
1283
|
| Status code | Description | Response headers |
|
|
1128
1284
|
|-------------|-------------|------------------|
|
|
1129
|
-
| **200** |
|
|
1285
|
+
| **200** | Fetch Trades response | - |
|
|
1130
1286
|
|
|
1131
1287
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1132
1288
|
|
|
1133
1289
|
|
|
1134
|
-
##
|
|
1290
|
+
## filterEvents
|
|
1135
1291
|
|
|
1136
|
-
>
|
|
1292
|
+
> FetchEvents200Response filterEvents(exchange, filterEventsRequest)
|
|
1137
1293
|
|
|
1138
|
-
|
|
1294
|
+
Filter Events
|
|
1295
|
+
|
|
1296
|
+
Filter a list of events by criteria. Can filter by string query, structured criteria object, or custom filter function.
|
|
1139
1297
|
|
|
1140
1298
|
### Example
|
|
1141
1299
|
|
|
@@ -1144,7 +1302,7 @@ import {
|
|
|
1144
1302
|
Configuration,
|
|
1145
1303
|
DefaultApi,
|
|
1146
1304
|
} from 'pmxtjs';
|
|
1147
|
-
import type {
|
|
1305
|
+
import type { FilterEventsOperationRequest } from 'pmxtjs';
|
|
1148
1306
|
|
|
1149
1307
|
async function example() {
|
|
1150
1308
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1153,12 +1311,12 @@ async function example() {
|
|
|
1153
1311
|
const body = {
|
|
1154
1312
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1155
1313
|
exchange: exchange_example,
|
|
1156
|
-
//
|
|
1157
|
-
|
|
1158
|
-
} satisfies
|
|
1314
|
+
// FilterEventsRequest (optional)
|
|
1315
|
+
filterEventsRequest: ...,
|
|
1316
|
+
} satisfies FilterEventsOperationRequest;
|
|
1159
1317
|
|
|
1160
1318
|
try {
|
|
1161
|
-
const data = await api.
|
|
1319
|
+
const data = await api.filterEvents(body);
|
|
1162
1320
|
console.log(data);
|
|
1163
1321
|
} catch (error) {
|
|
1164
1322
|
console.error(error);
|
|
@@ -1175,11 +1333,11 @@ example().catch(console.error);
|
|
|
1175
1333
|
| Name | Type | Description | Notes |
|
|
1176
1334
|
|------------- | ------------- | ------------- | -------------|
|
|
1177
1335
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1178
|
-
| **
|
|
1336
|
+
| **filterEventsRequest** | [FilterEventsRequest](FilterEventsRequest.md) | | [Optional] |
|
|
1179
1337
|
|
|
1180
1338
|
### Return type
|
|
1181
1339
|
|
|
1182
|
-
[**
|
|
1340
|
+
[**FetchEvents200Response**](FetchEvents200Response.md)
|
|
1183
1341
|
|
|
1184
1342
|
### Authorization
|
|
1185
1343
|
|
|
@@ -1194,16 +1352,18 @@ No authorization required
|
|
|
1194
1352
|
### HTTP response details
|
|
1195
1353
|
| Status code | Description | Response headers |
|
|
1196
1354
|
|-------------|-------------|------------------|
|
|
1197
|
-
| **200** |
|
|
1355
|
+
| **200** | Filter Events response | - |
|
|
1198
1356
|
|
|
1199
1357
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1200
1358
|
|
|
1201
1359
|
|
|
1202
|
-
##
|
|
1360
|
+
## filterMarkets
|
|
1203
1361
|
|
|
1204
|
-
>
|
|
1362
|
+
> FetchMarkets200Response filterMarkets(exchange, filterMarketsRequest)
|
|
1363
|
+
|
|
1364
|
+
Filter Markets
|
|
1205
1365
|
|
|
1206
|
-
|
|
1366
|
+
Filter a list of markets by criteria. Can filter by string query, structured criteria object, or custom filter function.
|
|
1207
1367
|
|
|
1208
1368
|
### Example
|
|
1209
1369
|
|
|
@@ -1212,7 +1372,7 @@ import {
|
|
|
1212
1372
|
Configuration,
|
|
1213
1373
|
DefaultApi,
|
|
1214
1374
|
} from 'pmxtjs';
|
|
1215
|
-
import type {
|
|
1375
|
+
import type { FilterMarketsOperationRequest } from 'pmxtjs';
|
|
1216
1376
|
|
|
1217
1377
|
async function example() {
|
|
1218
1378
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1221,12 +1381,12 @@ async function example() {
|
|
|
1221
1381
|
const body = {
|
|
1222
1382
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1223
1383
|
exchange: exchange_example,
|
|
1224
|
-
//
|
|
1225
|
-
|
|
1226
|
-
} satisfies
|
|
1384
|
+
// FilterMarketsRequest (optional)
|
|
1385
|
+
filterMarketsRequest: ...,
|
|
1386
|
+
} satisfies FilterMarketsOperationRequest;
|
|
1227
1387
|
|
|
1228
1388
|
try {
|
|
1229
|
-
const data = await api.
|
|
1389
|
+
const data = await api.filterMarkets(body);
|
|
1230
1390
|
console.log(data);
|
|
1231
1391
|
} catch (error) {
|
|
1232
1392
|
console.error(error);
|
|
@@ -1243,11 +1403,11 @@ example().catch(console.error);
|
|
|
1243
1403
|
| Name | Type | Description | Notes |
|
|
1244
1404
|
|------------- | ------------- | ------------- | -------------|
|
|
1245
1405
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1246
|
-
| **
|
|
1406
|
+
| **filterMarketsRequest** | [FilterMarketsRequest](FilterMarketsRequest.md) | | [Optional] |
|
|
1247
1407
|
|
|
1248
1408
|
### Return type
|
|
1249
1409
|
|
|
1250
|
-
[**
|
|
1410
|
+
[**FetchMarkets200Response**](FetchMarkets200Response.md)
|
|
1251
1411
|
|
|
1252
1412
|
### Authorization
|
|
1253
1413
|
|
|
@@ -1262,16 +1422,18 @@ No authorization required
|
|
|
1262
1422
|
### HTTP response details
|
|
1263
1423
|
| Status code | Description | Response headers |
|
|
1264
1424
|
|-------------|-------------|------------------|
|
|
1265
|
-
| **200** |
|
|
1425
|
+
| **200** | Filter Markets response | - |
|
|
1266
1426
|
|
|
1267
1427
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1268
1428
|
|
|
1269
1429
|
|
|
1270
|
-
##
|
|
1430
|
+
## getExecutionPrice
|
|
1271
1431
|
|
|
1272
|
-
>
|
|
1432
|
+
> GetExecutionPrice200Response getExecutionPrice(exchange, getExecutionPriceRequest)
|
|
1273
1433
|
|
|
1274
|
-
|
|
1434
|
+
Get Execution Price
|
|
1435
|
+
|
|
1436
|
+
Calculate the volume-weighted average execution price for a given order size. Returns 0 if the order cannot be fully filled.
|
|
1275
1437
|
|
|
1276
1438
|
### Example
|
|
1277
1439
|
|
|
@@ -1280,14 +1442,21 @@ import {
|
|
|
1280
1442
|
Configuration,
|
|
1281
1443
|
DefaultApi,
|
|
1282
1444
|
} from 'pmxtjs';
|
|
1283
|
-
import type {
|
|
1445
|
+
import type { GetExecutionPriceOperationRequest } from 'pmxtjs';
|
|
1284
1446
|
|
|
1285
1447
|
async function example() {
|
|
1286
1448
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
1287
1449
|
const api = new DefaultApi();
|
|
1288
1450
|
|
|
1451
|
+
const body = {
|
|
1452
|
+
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1453
|
+
exchange: exchange_example,
|
|
1454
|
+
// GetExecutionPriceRequest (optional)
|
|
1455
|
+
getExecutionPriceRequest: ...,
|
|
1456
|
+
} satisfies GetExecutionPriceOperationRequest;
|
|
1457
|
+
|
|
1289
1458
|
try {
|
|
1290
|
-
const data = await api.
|
|
1459
|
+
const data = await api.getExecutionPrice(body);
|
|
1291
1460
|
console.log(data);
|
|
1292
1461
|
} catch (error) {
|
|
1293
1462
|
console.error(error);
|
|
@@ -1300,11 +1469,15 @@ example().catch(console.error);
|
|
|
1300
1469
|
|
|
1301
1470
|
### Parameters
|
|
1302
1471
|
|
|
1303
|
-
|
|
1472
|
+
|
|
1473
|
+
| Name | Type | Description | Notes |
|
|
1474
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1475
|
+
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1476
|
+
| **getExecutionPriceRequest** | [GetExecutionPriceRequest](GetExecutionPriceRequest.md) | | [Optional] |
|
|
1304
1477
|
|
|
1305
1478
|
### Return type
|
|
1306
1479
|
|
|
1307
|
-
[**
|
|
1480
|
+
[**GetExecutionPrice200Response**](GetExecutionPrice200Response.md)
|
|
1308
1481
|
|
|
1309
1482
|
### Authorization
|
|
1310
1483
|
|
|
@@ -1312,25 +1485,25 @@ No authorization required
|
|
|
1312
1485
|
|
|
1313
1486
|
### HTTP request headers
|
|
1314
1487
|
|
|
1315
|
-
- **Content-Type**:
|
|
1488
|
+
- **Content-Type**: `application/json`
|
|
1316
1489
|
- **Accept**: `application/json`
|
|
1317
1490
|
|
|
1318
1491
|
|
|
1319
1492
|
### HTTP response details
|
|
1320
1493
|
| Status code | Description | Response headers |
|
|
1321
1494
|
|-------------|-------------|------------------|
|
|
1322
|
-
| **200** |
|
|
1495
|
+
| **200** | Get Execution Price response | - |
|
|
1323
1496
|
|
|
1324
1497
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1325
1498
|
|
|
1326
1499
|
|
|
1327
|
-
##
|
|
1500
|
+
## getExecutionPriceDetailed
|
|
1328
1501
|
|
|
1329
|
-
>
|
|
1502
|
+
> GetExecutionPriceDetailed200Response getExecutionPriceDetailed(exchange, getExecutionPriceDetailedRequest)
|
|
1330
1503
|
|
|
1331
|
-
|
|
1504
|
+
Get Execution Price Detailed
|
|
1332
1505
|
|
|
1333
|
-
|
|
1506
|
+
Calculate detailed execution price information including partial fill data.
|
|
1334
1507
|
|
|
1335
1508
|
### Example
|
|
1336
1509
|
|
|
@@ -1339,7 +1512,7 @@ import {
|
|
|
1339
1512
|
Configuration,
|
|
1340
1513
|
DefaultApi,
|
|
1341
1514
|
} from 'pmxtjs';
|
|
1342
|
-
import type {
|
|
1515
|
+
import type { GetExecutionPriceDetailedOperationRequest } from 'pmxtjs';
|
|
1343
1516
|
|
|
1344
1517
|
async function example() {
|
|
1345
1518
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1348,12 +1521,12 @@ async function example() {
|
|
|
1348
1521
|
const body = {
|
|
1349
1522
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1350
1523
|
exchange: exchange_example,
|
|
1351
|
-
//
|
|
1352
|
-
|
|
1353
|
-
} satisfies
|
|
1524
|
+
// GetExecutionPriceDetailedRequest (optional)
|
|
1525
|
+
getExecutionPriceDetailedRequest: ...,
|
|
1526
|
+
} satisfies GetExecutionPriceDetailedOperationRequest;
|
|
1354
1527
|
|
|
1355
1528
|
try {
|
|
1356
|
-
const data = await api.
|
|
1529
|
+
const data = await api.getExecutionPriceDetailed(body);
|
|
1357
1530
|
console.log(data);
|
|
1358
1531
|
} catch (error) {
|
|
1359
1532
|
console.error(error);
|
|
@@ -1370,11 +1543,11 @@ example().catch(console.error);
|
|
|
1370
1543
|
| Name | Type | Description | Notes |
|
|
1371
1544
|
|------------- | ------------- | ------------- | -------------|
|
|
1372
1545
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1373
|
-
| **
|
|
1546
|
+
| **getExecutionPriceDetailedRequest** | [GetExecutionPriceDetailedRequest](GetExecutionPriceDetailedRequest.md) | | [Optional] |
|
|
1374
1547
|
|
|
1375
1548
|
### Return type
|
|
1376
1549
|
|
|
1377
|
-
[**
|
|
1550
|
+
[**GetExecutionPriceDetailed200Response**](GetExecutionPriceDetailed200Response.md)
|
|
1378
1551
|
|
|
1379
1552
|
### Authorization
|
|
1380
1553
|
|
|
@@ -1389,16 +1562,16 @@ No authorization required
|
|
|
1389
1562
|
### HTTP response details
|
|
1390
1563
|
| Status code | Description | Response headers |
|
|
1391
1564
|
|-------------|-------------|------------------|
|
|
1392
|
-
| **200** |
|
|
1565
|
+
| **200** | Get Execution Price Detailed response | - |
|
|
1393
1566
|
|
|
1394
1567
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1395
1568
|
|
|
1396
1569
|
|
|
1397
|
-
##
|
|
1570
|
+
## healthCheck
|
|
1398
1571
|
|
|
1399
|
-
>
|
|
1572
|
+
> HealthCheck200Response healthCheck()
|
|
1400
1573
|
|
|
1401
|
-
|
|
1574
|
+
Server Health Check
|
|
1402
1575
|
|
|
1403
1576
|
### Example
|
|
1404
1577
|
|
|
@@ -1407,21 +1580,14 @@ import {
|
|
|
1407
1580
|
Configuration,
|
|
1408
1581
|
DefaultApi,
|
|
1409
1582
|
} from 'pmxtjs';
|
|
1410
|
-
import type {
|
|
1583
|
+
import type { HealthCheckRequest } from 'pmxtjs';
|
|
1411
1584
|
|
|
1412
1585
|
async function example() {
|
|
1413
1586
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
1414
1587
|
const api = new DefaultApi();
|
|
1415
1588
|
|
|
1416
|
-
const body = {
|
|
1417
|
-
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1418
|
-
exchange: exchange_example,
|
|
1419
|
-
// WatchPricesRequest (optional)
|
|
1420
|
-
watchPricesRequest: ...,
|
|
1421
|
-
} satisfies WatchPricesOperationRequest;
|
|
1422
|
-
|
|
1423
1589
|
try {
|
|
1424
|
-
const data = await api.
|
|
1590
|
+
const data = await api.healthCheck();
|
|
1425
1591
|
console.log(data);
|
|
1426
1592
|
} catch (error) {
|
|
1427
1593
|
console.error(error);
|
|
@@ -1434,15 +1600,11 @@ example().catch(console.error);
|
|
|
1434
1600
|
|
|
1435
1601
|
### Parameters
|
|
1436
1602
|
|
|
1437
|
-
|
|
1438
|
-
| Name | Type | Description | Notes |
|
|
1439
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1440
|
-
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1441
|
-
| **watchPricesRequest** | [WatchPricesRequest](WatchPricesRequest.md) | | [Optional] |
|
|
1603
|
+
This endpoint does not need any parameter.
|
|
1442
1604
|
|
|
1443
1605
|
### Return type
|
|
1444
1606
|
|
|
1445
|
-
[**
|
|
1607
|
+
[**HealthCheck200Response**](HealthCheck200Response.md)
|
|
1446
1608
|
|
|
1447
1609
|
### Authorization
|
|
1448
1610
|
|
|
@@ -1450,25 +1612,25 @@ No authorization required
|
|
|
1450
1612
|
|
|
1451
1613
|
### HTTP request headers
|
|
1452
1614
|
|
|
1453
|
-
- **Content-Type**:
|
|
1615
|
+
- **Content-Type**: Not defined
|
|
1454
1616
|
- **Accept**: `application/json`
|
|
1455
1617
|
|
|
1456
1618
|
|
|
1457
1619
|
### HTTP response details
|
|
1458
1620
|
| Status code | Description | Response headers |
|
|
1459
1621
|
|-------------|-------------|------------------|
|
|
1460
|
-
| **200** |
|
|
1622
|
+
| **200** | Server is consistent and running. | - |
|
|
1461
1623
|
|
|
1462
1624
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1463
1625
|
|
|
1464
1626
|
|
|
1465
|
-
##
|
|
1627
|
+
## loadMarkets
|
|
1466
1628
|
|
|
1467
|
-
>
|
|
1629
|
+
> LoadMarkets200Response loadMarkets(exchange, loadMarketsRequest)
|
|
1468
1630
|
|
|
1469
|
-
|
|
1631
|
+
Load Markets
|
|
1470
1632
|
|
|
1471
|
-
|
|
1633
|
+
Load and cache all markets from the exchange into `this.markets` and `this.marketsBySlug`. Subsequent calls return the cached result without hitting the API again. This is the correct way to paginate or iterate over markets without drift. Because `fetchMarkets()` always hits the API, repeated calls with different `offset` values may return inconsistent results if the exchange reorders or adds markets between requests. Use `loadMarkets()` once to get a stable snapshot, then paginate over `Object.values(exchange.markets)` locally.
|
|
1472
1634
|
|
|
1473
1635
|
### Example
|
|
1474
1636
|
|
|
@@ -1477,7 +1639,7 @@ import {
|
|
|
1477
1639
|
Configuration,
|
|
1478
1640
|
DefaultApi,
|
|
1479
1641
|
} from 'pmxtjs';
|
|
1480
|
-
import type {
|
|
1642
|
+
import type { LoadMarketsOperationRequest } from 'pmxtjs';
|
|
1481
1643
|
|
|
1482
1644
|
async function example() {
|
|
1483
1645
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1486,12 +1648,12 @@ async function example() {
|
|
|
1486
1648
|
const body = {
|
|
1487
1649
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1488
1650
|
exchange: exchange_example,
|
|
1489
|
-
//
|
|
1490
|
-
|
|
1491
|
-
} satisfies
|
|
1651
|
+
// LoadMarketsRequest (optional)
|
|
1652
|
+
loadMarketsRequest: ...,
|
|
1653
|
+
} satisfies LoadMarketsOperationRequest;
|
|
1492
1654
|
|
|
1493
1655
|
try {
|
|
1494
|
-
const data = await api.
|
|
1656
|
+
const data = await api.loadMarkets(body);
|
|
1495
1657
|
console.log(data);
|
|
1496
1658
|
} catch (error) {
|
|
1497
1659
|
console.error(error);
|
|
@@ -1508,11 +1670,11 @@ example().catch(console.error);
|
|
|
1508
1670
|
| Name | Type | Description | Notes |
|
|
1509
1671
|
|------------- | ------------- | ------------- | -------------|
|
|
1510
1672
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1511
|
-
| **
|
|
1673
|
+
| **loadMarketsRequest** | [LoadMarketsRequest](LoadMarketsRequest.md) | | [Optional] |
|
|
1512
1674
|
|
|
1513
1675
|
### Return type
|
|
1514
1676
|
|
|
1515
|
-
[**
|
|
1677
|
+
[**LoadMarkets200Response**](LoadMarkets200Response.md)
|
|
1516
1678
|
|
|
1517
1679
|
### Authorization
|
|
1518
1680
|
|
|
@@ -1527,16 +1689,18 @@ No authorization required
|
|
|
1527
1689
|
### HTTP response details
|
|
1528
1690
|
| Status code | Description | Response headers |
|
|
1529
1691
|
|-------------|-------------|------------------|
|
|
1530
|
-
| **200** |
|
|
1692
|
+
| **200** | Load Markets response | - |
|
|
1531
1693
|
|
|
1532
1694
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1533
1695
|
|
|
1534
1696
|
|
|
1535
|
-
##
|
|
1697
|
+
## watchOrderBook
|
|
1698
|
+
|
|
1699
|
+
> FetchOrderBook200Response watchOrderBook(exchange, watchOrderBookRequest)
|
|
1536
1700
|
|
|
1537
|
-
|
|
1701
|
+
Watch Order Book
|
|
1538
1702
|
|
|
1539
|
-
Watch
|
|
1703
|
+
Watch order book updates in real-time via WebSocket. Returns a promise that resolves with the next order book update. Call repeatedly in a loop to stream updates (CCXT Pro pattern).
|
|
1540
1704
|
|
|
1541
1705
|
### Example
|
|
1542
1706
|
|
|
@@ -1545,7 +1709,7 @@ import {
|
|
|
1545
1709
|
Configuration,
|
|
1546
1710
|
DefaultApi,
|
|
1547
1711
|
} from 'pmxtjs';
|
|
1548
|
-
import type {
|
|
1712
|
+
import type { WatchOrderBookOperationRequest } from 'pmxtjs';
|
|
1549
1713
|
|
|
1550
1714
|
async function example() {
|
|
1551
1715
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1554,12 +1718,12 @@ async function example() {
|
|
|
1554
1718
|
const body = {
|
|
1555
1719
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1556
1720
|
exchange: exchange_example,
|
|
1557
|
-
//
|
|
1558
|
-
|
|
1559
|
-
} satisfies
|
|
1721
|
+
// WatchOrderBookRequest (optional)
|
|
1722
|
+
watchOrderBookRequest: ...,
|
|
1723
|
+
} satisfies WatchOrderBookOperationRequest;
|
|
1560
1724
|
|
|
1561
1725
|
try {
|
|
1562
|
-
const data = await api.
|
|
1726
|
+
const data = await api.watchOrderBook(body);
|
|
1563
1727
|
console.log(data);
|
|
1564
1728
|
} catch (error) {
|
|
1565
1729
|
console.error(error);
|
|
@@ -1576,11 +1740,11 @@ example().catch(console.error);
|
|
|
1576
1740
|
| Name | Type | Description | Notes |
|
|
1577
1741
|
|------------- | ------------- | ------------- | -------------|
|
|
1578
1742
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1579
|
-
| **
|
|
1743
|
+
| **watchOrderBookRequest** | [WatchOrderBookRequest](WatchOrderBookRequest.md) | | [Optional] |
|
|
1580
1744
|
|
|
1581
1745
|
### Return type
|
|
1582
1746
|
|
|
1583
|
-
[**
|
|
1747
|
+
[**FetchOrderBook200Response**](FetchOrderBook200Response.md)
|
|
1584
1748
|
|
|
1585
1749
|
### Authorization
|
|
1586
1750
|
|
|
@@ -1595,16 +1759,18 @@ No authorization required
|
|
|
1595
1759
|
### HTTP response details
|
|
1596
1760
|
| Status code | Description | Response headers |
|
|
1597
1761
|
|-------------|-------------|------------------|
|
|
1598
|
-
| **200** |
|
|
1762
|
+
| **200** | Watch Order Book response | - |
|
|
1599
1763
|
|
|
1600
1764
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1601
1765
|
|
|
1602
1766
|
|
|
1603
|
-
##
|
|
1767
|
+
## watchTrades
|
|
1768
|
+
|
|
1769
|
+
> FetchTrades200Response watchTrades(exchange, watchTradesRequest)
|
|
1604
1770
|
|
|
1605
|
-
|
|
1771
|
+
Watch Trades
|
|
1606
1772
|
|
|
1607
|
-
Watch
|
|
1773
|
+
Watch trade executions in real-time via WebSocket. Returns a promise that resolves with the next trade(s). Call repeatedly in a loop to stream updates (CCXT Pro pattern).
|
|
1608
1774
|
|
|
1609
1775
|
### Example
|
|
1610
1776
|
|
|
@@ -1613,7 +1779,7 @@ import {
|
|
|
1613
1779
|
Configuration,
|
|
1614
1780
|
DefaultApi,
|
|
1615
1781
|
} from 'pmxtjs';
|
|
1616
|
-
import type {
|
|
1782
|
+
import type { WatchTradesOperationRequest } from 'pmxtjs';
|
|
1617
1783
|
|
|
1618
1784
|
async function example() {
|
|
1619
1785
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1622,12 +1788,12 @@ async function example() {
|
|
|
1622
1788
|
const body = {
|
|
1623
1789
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1624
1790
|
exchange: exchange_example,
|
|
1625
|
-
//
|
|
1626
|
-
|
|
1627
|
-
} satisfies
|
|
1791
|
+
// WatchTradesRequest (optional)
|
|
1792
|
+
watchTradesRequest: ...,
|
|
1793
|
+
} satisfies WatchTradesOperationRequest;
|
|
1628
1794
|
|
|
1629
1795
|
try {
|
|
1630
|
-
const data = await api.
|
|
1796
|
+
const data = await api.watchTrades(body);
|
|
1631
1797
|
console.log(data);
|
|
1632
1798
|
} catch (error) {
|
|
1633
1799
|
console.error(error);
|
|
@@ -1644,11 +1810,11 @@ example().catch(console.error);
|
|
|
1644
1810
|
| Name | Type | Description | Notes |
|
|
1645
1811
|
|------------- | ------------- | ------------- | -------------|
|
|
1646
1812
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1647
|
-
| **
|
|
1813
|
+
| **watchTradesRequest** | [WatchTradesRequest](WatchTradesRequest.md) | | [Optional] |
|
|
1648
1814
|
|
|
1649
1815
|
### Return type
|
|
1650
1816
|
|
|
1651
|
-
[**
|
|
1817
|
+
[**FetchTrades200Response**](FetchTrades200Response.md)
|
|
1652
1818
|
|
|
1653
1819
|
### Authorization
|
|
1654
1820
|
|
|
@@ -1663,7 +1829,7 @@ No authorization required
|
|
|
1663
1829
|
### HTTP response details
|
|
1664
1830
|
| Status code | Description | Response headers |
|
|
1665
1831
|
|-------------|-------------|------------------|
|
|
1666
|
-
| **200** |
|
|
1832
|
+
| **200** | Watch Trades response | - |
|
|
1667
1833
|
|
|
1668
1834
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1669
1835
|
|