pmxtjs 2.9.2 → 2.9.3
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 +242 -112
- package/dist/esm/generated/src/apis/DefaultApi.js +298 -108
- package/dist/esm/generated/src/models/BuildOrder200Response.d.ts +46 -0
- package/dist/esm/generated/src/models/BuildOrder200Response.js +47 -0
- package/dist/esm/generated/src/models/BuildOrderRequest.d.ts +40 -0
- package/dist/esm/generated/src/models/BuildOrderRequest.js +47 -0
- package/dist/esm/generated/src/models/BuiltOrder.d.ts +60 -0
- package/dist/esm/generated/src/models/BuiltOrder.js +51 -0
- package/dist/esm/generated/src/models/BuiltOrderTx.d.ts +50 -0
- package/dist/esm/generated/src/models/BuiltOrderTx.js +47 -0
- 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/EventFetchParams.d.ts +15 -0
- package/dist/esm/generated/src/models/EventFetchParams.js +10 -0
- 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/{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/SubmitOrderRequest.d.ts +40 -0
- package/dist/esm/generated/src/models/SubmitOrderRequest.js +47 -0
- package/dist/esm/generated/src/models/UnifiedMarket.d.ts +6 -0
- package/dist/esm/generated/src/models/UnifiedMarket.js +2 -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 +24 -2
- package/dist/esm/generated/src/models/index.js +24 -2
- package/dist/esm/index.d.ts +6 -2
- package/dist/esm/index.js +6 -2
- package/dist/esm/pmxt/client.d.ts +107 -81
- package/dist/esm/pmxt/client.js +462 -227
- package/dist/esm/pmxt/models.d.ts +34 -0
- package/dist/esm/pmxt/server-manager.d.ts +2 -0
- package/dist/esm/pmxt/server-manager.js +15 -2
- package/dist/generated/src/apis/DefaultApi.d.ts +242 -112
- package/dist/generated/src/apis/DefaultApi.js +298 -108
- package/dist/generated/src/models/BuildOrder200Response.d.ts +46 -0
- package/dist/generated/src/models/BuildOrder200Response.js +54 -0
- package/dist/generated/src/models/BuildOrderRequest.d.ts +40 -0
- package/dist/generated/src/models/BuildOrderRequest.js +54 -0
- package/dist/generated/src/models/BuiltOrder.d.ts +60 -0
- package/dist/generated/src/models/BuiltOrder.js +58 -0
- package/dist/generated/src/models/BuiltOrderTx.d.ts +50 -0
- package/dist/generated/src/models/BuiltOrderTx.js +54 -0
- 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/EventFetchParams.d.ts +15 -0
- package/dist/generated/src/models/EventFetchParams.js +11 -1
- 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/{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/SubmitOrderRequest.d.ts +40 -0
- package/dist/generated/src/models/SubmitOrderRequest.js +54 -0
- package/dist/generated/src/models/UnifiedMarket.d.ts +6 -0
- package/dist/generated/src/models/UnifiedMarket.js +2 -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 +24 -2
- package/dist/generated/src/models/index.js +24 -2
- package/dist/index.d.ts +6 -2
- package/dist/index.js +9 -1
- package/dist/pmxt/client.d.ts +107 -81
- package/dist/pmxt/client.js +467 -228
- package/dist/pmxt/models.d.ts +34 -0
- package/dist/pmxt/server-manager.d.ts +2 -0
- package/dist/pmxt/server-manager.js +15 -2
- package/generated/.openapi-generator/FILES +48 -4
- package/generated/docs/BuildOrder200Response.md +38 -0
- package/generated/docs/BuildOrderRequest.md +36 -0
- package/generated/docs/BuiltOrder.md +43 -0
- package/generated/docs/BuiltOrderTx.md +41 -0
- package/generated/docs/{WatchUserPositionsRequest.md → CloseRequest.md} +6 -4
- package/generated/docs/DefaultApi.md +493 -185
- package/generated/docs/EventFetchParams.md +2 -0
- 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/{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/SubmitOrderRequest.md +36 -0
- package/generated/docs/UnifiedMarket.md +2 -0
- package/generated/docs/UserTrade.md +48 -0
- package/generated/package.json +1 -1
- package/generated/src/apis/DefaultApi.ts +486 -185
- 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/BuildOrder200Response.ts +96 -0
- package/generated/src/models/BuildOrderRequest.ts +89 -0
- package/generated/src/models/BuiltOrder.ts +112 -0
- package/generated/src/models/BuiltOrderTx.ts +89 -0
- 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 +19 -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 +1 -1
- 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/SubmitOrderRequest.ts +89 -0
- 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 +9 -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 +24 -2
- package/generated/src/runtime.ts +1 -1
- package/index.ts +6 -2
- package/package.json +4 -3
- package/pmxt/client.ts +464 -256
- package/pmxt/models.ts +46 -0
- package/pmxt/server-manager.ts +13 -2
- package/dist/esm/generated/src/models/WatchUserPositionsRequest.d.ts +0 -33
- package/dist/generated/src/models/WatchUserPositionsRequest.d.ts +0 -33
|
@@ -4,39 +4,115 @@ All URIs are relative to *http://localhost:3847*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
| [**buildOrder**](DefaultApi.md#buildorderoperation) | **POST** /api/{exchange}/buildOrder | Build Order |
|
|
7
8
|
| [**cancelOrder**](DefaultApi.md#cancelorderoperation) | **POST** /api/{exchange}/cancelOrder | Cancel Order |
|
|
8
|
-
| [**close**](DefaultApi.md#
|
|
9
|
+
| [**close**](DefaultApi.md#closeoperation) | **POST** /api/{exchange}/close | Close |
|
|
9
10
|
| [**createOrder**](DefaultApi.md#createorderoperation) | **POST** /api/{exchange}/createOrder | Create Order |
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
11
|
+
| [**fetchAllOrders**](DefaultApi.md#fetchallordersoperation) | **POST** /api/{exchange}/fetchAllOrders | Fetch All Orders |
|
|
12
|
+
| [**fetchBalance**](DefaultApi.md#fetchbalanceoperation) | **POST** /api/{exchange}/fetchBalance | Fetch Balance |
|
|
13
|
+
| [**fetchClosedOrders**](DefaultApi.md#fetchclosedordersoperation) | **POST** /api/{exchange}/fetchClosedOrders | Fetch Closed Orders |
|
|
14
|
+
| [**fetchEvent**](DefaultApi.md#fetcheventoperation) | **POST** /api/{exchange}/fetchEvent | Fetch Event |
|
|
12
15
|
| [**fetchEvents**](DefaultApi.md#fetcheventsoperation) | **POST** /api/{exchange}/fetchEvents | Fetch Events |
|
|
13
|
-
| [**fetchMarket**](DefaultApi.md#fetchmarketoperation) | **POST** /api/{exchange}/fetchMarket | Fetch
|
|
16
|
+
| [**fetchMarket**](DefaultApi.md#fetchmarketoperation) | **POST** /api/{exchange}/fetchMarket | Fetch Market |
|
|
14
17
|
| [**fetchMarkets**](DefaultApi.md#fetchmarketsoperation) | **POST** /api/{exchange}/fetchMarkets | Fetch Markets |
|
|
15
|
-
| [**
|
|
18
|
+
| [**fetchMarketsPaginated**](DefaultApi.md#fetchmarketspaginatedoperation) | **POST** /api/{exchange}/fetchMarketsPaginated | Fetch Markets Paginated |
|
|
19
|
+
| [**fetchMyTrades**](DefaultApi.md#fetchmytradesoperation) | **POST** /api/{exchange}/fetchMyTrades | Fetch My Trades |
|
|
20
|
+
| [**fetchOHLCV**](DefaultApi.md#fetchohlcvoperation) | **POST** /api/{exchange}/fetchOHLCV | Fetch O H L C V |
|
|
16
21
|
| [**fetchOpenOrders**](DefaultApi.md#fetchopenordersoperation) | **POST** /api/{exchange}/fetchOpenOrders | Fetch Open Orders |
|
|
17
|
-
| [**fetchOrder**](DefaultApi.md#
|
|
22
|
+
| [**fetchOrder**](DefaultApi.md#fetchorderoperation) | **POST** /api/{exchange}/fetchOrder | Fetch Order |
|
|
18
23
|
| [**fetchOrderBook**](DefaultApi.md#fetchorderbookoperation) | **POST** /api/{exchange}/fetchOrderBook | Fetch Order Book |
|
|
19
24
|
| [**fetchPositions**](DefaultApi.md#fetchpositionsoperation) | **POST** /api/{exchange}/fetchPositions | Fetch Positions |
|
|
20
25
|
| [**fetchTrades**](DefaultApi.md#fetchtradesoperation) | **POST** /api/{exchange}/fetchTrades | Fetch Trades |
|
|
21
26
|
| [**filterEvents**](DefaultApi.md#filtereventsoperation) | **POST** /api/{exchange}/filterEvents | Filter Events |
|
|
22
27
|
| [**filterMarkets**](DefaultApi.md#filtermarketsoperation) | **POST** /api/{exchange}/filterMarkets | Filter Markets |
|
|
23
28
|
| [**getExecutionPrice**](DefaultApi.md#getexecutionpriceoperation) | **POST** /api/{exchange}/getExecutionPrice | Get Execution Price |
|
|
24
|
-
| [**getExecutionPriceDetailed**](DefaultApi.md#
|
|
29
|
+
| [**getExecutionPriceDetailed**](DefaultApi.md#getexecutionpricedetailedoperation) | **POST** /api/{exchange}/getExecutionPriceDetailed | Get Execution Price Detailed |
|
|
25
30
|
| [**healthCheck**](DefaultApi.md#healthcheck) | **GET** /health | Server Health Check |
|
|
26
|
-
| [**
|
|
27
|
-
| [**
|
|
28
|
-
| [**
|
|
29
|
-
| [**
|
|
30
|
-
| [**watchUserTransactions**](DefaultApi.md#watchusertransactions) | **POST** /api/{exchange}/watchUserTransactions | Watch User Transactions (WebSocket Stream) |
|
|
31
|
+
| [**loadMarkets**](DefaultApi.md#loadmarketsoperation) | **POST** /api/{exchange}/loadMarkets | Load Markets |
|
|
32
|
+
| [**submitOrder**](DefaultApi.md#submitorderoperation) | **POST** /api/{exchange}/submitOrder | Submit Order |
|
|
33
|
+
| [**watchOrderBook**](DefaultApi.md#watchorderbookoperation) | **POST** /api/{exchange}/watchOrderBook | Watch Order Book |
|
|
34
|
+
| [**watchTrades**](DefaultApi.md#watchtradesoperation) | **POST** /api/{exchange}/watchTrades | Watch Trades |
|
|
31
35
|
|
|
32
36
|
|
|
33
37
|
|
|
38
|
+
## buildOrder
|
|
39
|
+
|
|
40
|
+
> BuildOrder200Response buildOrder(exchange, buildOrderRequest)
|
|
41
|
+
|
|
42
|
+
Build Order
|
|
43
|
+
|
|
44
|
+
Build an order payload without submitting it to the exchange. Returns the exchange-native signed order or request body for inspection, forwarding through a middleware layer, or deferred submission via submitOrder().
|
|
45
|
+
|
|
46
|
+
### Example
|
|
47
|
+
|
|
48
|
+
```ts
|
|
49
|
+
import {
|
|
50
|
+
Configuration,
|
|
51
|
+
DefaultApi,
|
|
52
|
+
} from 'pmxtjs';
|
|
53
|
+
import type { BuildOrderOperationRequest } from 'pmxtjs';
|
|
54
|
+
|
|
55
|
+
async function example() {
|
|
56
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
57
|
+
const api = new DefaultApi();
|
|
58
|
+
|
|
59
|
+
const body = {
|
|
60
|
+
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
61
|
+
exchange: exchange_example,
|
|
62
|
+
// BuildOrderRequest (optional)
|
|
63
|
+
buildOrderRequest: ...,
|
|
64
|
+
} satisfies BuildOrderOperationRequest;
|
|
65
|
+
|
|
66
|
+
try {
|
|
67
|
+
const data = await api.buildOrder(body);
|
|
68
|
+
console.log(data);
|
|
69
|
+
} catch (error) {
|
|
70
|
+
console.error(error);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
// Run the test
|
|
75
|
+
example().catch(console.error);
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Parameters
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
| Name | Type | Description | Notes |
|
|
82
|
+
|------------- | ------------- | ------------- | -------------|
|
|
83
|
+
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
84
|
+
| **buildOrderRequest** | [BuildOrderRequest](BuildOrderRequest.md) | | [Optional] |
|
|
85
|
+
|
|
86
|
+
### Return type
|
|
87
|
+
|
|
88
|
+
[**BuildOrder200Response**](BuildOrder200Response.md)
|
|
89
|
+
|
|
90
|
+
### Authorization
|
|
91
|
+
|
|
92
|
+
No authorization required
|
|
93
|
+
|
|
94
|
+
### HTTP request headers
|
|
95
|
+
|
|
96
|
+
- **Content-Type**: `application/json`
|
|
97
|
+
- **Accept**: `application/json`
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
### HTTP response details
|
|
101
|
+
| Status code | Description | Response headers |
|
|
102
|
+
|-------------|-------------|------------------|
|
|
103
|
+
| **200** | Build Order response | - |
|
|
104
|
+
|
|
105
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
106
|
+
|
|
107
|
+
|
|
34
108
|
## cancelOrder
|
|
35
109
|
|
|
36
110
|
> CreateOrder200Response cancelOrder(exchange, cancelOrderRequest)
|
|
37
111
|
|
|
38
112
|
Cancel Order
|
|
39
113
|
|
|
114
|
+
Cancel an existing open order.
|
|
115
|
+
|
|
40
116
|
### Example
|
|
41
117
|
|
|
42
118
|
```ts
|
|
@@ -94,18 +170,18 @@ No authorization required
|
|
|
94
170
|
### HTTP response details
|
|
95
171
|
| Status code | Description | Response headers |
|
|
96
172
|
|-------------|-------------|------------------|
|
|
97
|
-
| **200** | Order
|
|
173
|
+
| **200** | Cancel Order response | - |
|
|
98
174
|
|
|
99
175
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
100
176
|
|
|
101
177
|
|
|
102
178
|
## close
|
|
103
179
|
|
|
104
|
-
> BaseResponse close(exchange,
|
|
180
|
+
> BaseResponse close(exchange, closeRequest)
|
|
105
181
|
|
|
106
|
-
Close
|
|
182
|
+
Close
|
|
107
183
|
|
|
108
|
-
Close all WebSocket connections and
|
|
184
|
+
Close all WebSocket connections and clean up resources. Call this when you\'re done streaming to properly release connections.
|
|
109
185
|
|
|
110
186
|
### Example
|
|
111
187
|
|
|
@@ -114,7 +190,7 @@ import {
|
|
|
114
190
|
Configuration,
|
|
115
191
|
DefaultApi,
|
|
116
192
|
} from 'pmxtjs';
|
|
117
|
-
import type {
|
|
193
|
+
import type { CloseOperationRequest } from 'pmxtjs';
|
|
118
194
|
|
|
119
195
|
async function example() {
|
|
120
196
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -123,9 +199,9 @@ async function example() {
|
|
|
123
199
|
const body = {
|
|
124
200
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
125
201
|
exchange: exchange_example,
|
|
126
|
-
//
|
|
127
|
-
|
|
128
|
-
} satisfies
|
|
202
|
+
// CloseRequest (optional)
|
|
203
|
+
closeRequest: ...,
|
|
204
|
+
} satisfies CloseOperationRequest;
|
|
129
205
|
|
|
130
206
|
try {
|
|
131
207
|
const data = await api.close(body);
|
|
@@ -145,7 +221,7 @@ example().catch(console.error);
|
|
|
145
221
|
| Name | Type | Description | Notes |
|
|
146
222
|
|------------- | ------------- | ------------- | -------------|
|
|
147
223
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
148
|
-
| **
|
|
224
|
+
| **closeRequest** | [CloseRequest](CloseRequest.md) | | [Optional] |
|
|
149
225
|
|
|
150
226
|
### Return type
|
|
151
227
|
|
|
@@ -164,7 +240,7 @@ No authorization required
|
|
|
164
240
|
### HTTP response details
|
|
165
241
|
| Status code | Description | Response headers |
|
|
166
242
|
|-------------|-------------|------------------|
|
|
167
|
-
| **200** |
|
|
243
|
+
| **200** | Close response | - |
|
|
168
244
|
|
|
169
245
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
170
246
|
|
|
@@ -175,6 +251,8 @@ No authorization required
|
|
|
175
251
|
|
|
176
252
|
Create Order
|
|
177
253
|
|
|
254
|
+
Place a new order on the exchange.
|
|
255
|
+
|
|
178
256
|
### Example
|
|
179
257
|
|
|
180
258
|
```ts
|
|
@@ -232,17 +310,87 @@ No authorization required
|
|
|
232
310
|
### HTTP response details
|
|
233
311
|
| Status code | Description | Response headers |
|
|
234
312
|
|-------------|-------------|------------------|
|
|
235
|
-
| **200** | Order
|
|
313
|
+
| **200** | Create Order response | - |
|
|
314
|
+
|
|
315
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
## fetchAllOrders
|
|
319
|
+
|
|
320
|
+
> FetchOpenOrders200Response fetchAllOrders(exchange, fetchAllOrdersRequest)
|
|
321
|
+
|
|
322
|
+
Fetch All Orders
|
|
323
|
+
|
|
324
|
+
### Example
|
|
325
|
+
|
|
326
|
+
```ts
|
|
327
|
+
import {
|
|
328
|
+
Configuration,
|
|
329
|
+
DefaultApi,
|
|
330
|
+
} from 'pmxtjs';
|
|
331
|
+
import type { FetchAllOrdersOperationRequest } from 'pmxtjs';
|
|
332
|
+
|
|
333
|
+
async function example() {
|
|
334
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
335
|
+
const api = new DefaultApi();
|
|
336
|
+
|
|
337
|
+
const body = {
|
|
338
|
+
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
339
|
+
exchange: exchange_example,
|
|
340
|
+
// FetchAllOrdersRequest (optional)
|
|
341
|
+
fetchAllOrdersRequest: ...,
|
|
342
|
+
} satisfies FetchAllOrdersOperationRequest;
|
|
343
|
+
|
|
344
|
+
try {
|
|
345
|
+
const data = await api.fetchAllOrders(body);
|
|
346
|
+
console.log(data);
|
|
347
|
+
} catch (error) {
|
|
348
|
+
console.error(error);
|
|
349
|
+
}
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
// Run the test
|
|
353
|
+
example().catch(console.error);
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
### Parameters
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
| Name | Type | Description | Notes |
|
|
360
|
+
|------------- | ------------- | ------------- | -------------|
|
|
361
|
+
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
362
|
+
| **fetchAllOrdersRequest** | [FetchAllOrdersRequest](FetchAllOrdersRequest.md) | | [Optional] |
|
|
363
|
+
|
|
364
|
+
### Return type
|
|
365
|
+
|
|
366
|
+
[**FetchOpenOrders200Response**](FetchOpenOrders200Response.md)
|
|
367
|
+
|
|
368
|
+
### Authorization
|
|
369
|
+
|
|
370
|
+
No authorization required
|
|
371
|
+
|
|
372
|
+
### HTTP request headers
|
|
373
|
+
|
|
374
|
+
- **Content-Type**: `application/json`
|
|
375
|
+
- **Accept**: `application/json`
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
### HTTP response details
|
|
379
|
+
| Status code | Description | Response headers |
|
|
380
|
+
|-------------|-------------|------------------|
|
|
381
|
+
| **200** | Fetch All Orders response | - |
|
|
236
382
|
|
|
237
383
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
238
384
|
|
|
239
385
|
|
|
240
386
|
## fetchBalance
|
|
241
387
|
|
|
242
|
-
> FetchBalance200Response fetchBalance(exchange,
|
|
388
|
+
> FetchBalance200Response fetchBalance(exchange, fetchBalanceRequest)
|
|
243
389
|
|
|
244
390
|
Fetch Balance
|
|
245
391
|
|
|
392
|
+
Fetch account balances.
|
|
393
|
+
|
|
246
394
|
### Example
|
|
247
395
|
|
|
248
396
|
```ts
|
|
@@ -250,7 +398,7 @@ import {
|
|
|
250
398
|
Configuration,
|
|
251
399
|
DefaultApi,
|
|
252
400
|
} from 'pmxtjs';
|
|
253
|
-
import type {
|
|
401
|
+
import type { FetchBalanceOperationRequest } from 'pmxtjs';
|
|
254
402
|
|
|
255
403
|
async function example() {
|
|
256
404
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -259,9 +407,9 @@ async function example() {
|
|
|
259
407
|
const body = {
|
|
260
408
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
261
409
|
exchange: exchange_example,
|
|
262
|
-
//
|
|
263
|
-
|
|
264
|
-
} satisfies
|
|
410
|
+
// FetchBalanceRequest (optional)
|
|
411
|
+
fetchBalanceRequest: ...,
|
|
412
|
+
} satisfies FetchBalanceOperationRequest;
|
|
265
413
|
|
|
266
414
|
try {
|
|
267
415
|
const data = await api.fetchBalance(body);
|
|
@@ -281,7 +429,7 @@ example().catch(console.error);
|
|
|
281
429
|
| Name | Type | Description | Notes |
|
|
282
430
|
|------------- | ------------- | ------------- | -------------|
|
|
283
431
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
284
|
-
| **
|
|
432
|
+
| **fetchBalanceRequest** | [FetchBalanceRequest](FetchBalanceRequest.md) | | [Optional] |
|
|
285
433
|
|
|
286
434
|
### Return type
|
|
287
435
|
|
|
@@ -300,18 +448,86 @@ No authorization required
|
|
|
300
448
|
### HTTP response details
|
|
301
449
|
| Status code | Description | Response headers |
|
|
302
450
|
|-------------|-------------|------------------|
|
|
303
|
-
| **200** |
|
|
451
|
+
| **200** | Fetch Balance response | - |
|
|
452
|
+
|
|
453
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
## fetchClosedOrders
|
|
457
|
+
|
|
458
|
+
> FetchOpenOrders200Response fetchClosedOrders(exchange, fetchClosedOrdersRequest)
|
|
459
|
+
|
|
460
|
+
Fetch Closed Orders
|
|
461
|
+
|
|
462
|
+
### Example
|
|
463
|
+
|
|
464
|
+
```ts
|
|
465
|
+
import {
|
|
466
|
+
Configuration,
|
|
467
|
+
DefaultApi,
|
|
468
|
+
} from 'pmxtjs';
|
|
469
|
+
import type { FetchClosedOrdersOperationRequest } from 'pmxtjs';
|
|
470
|
+
|
|
471
|
+
async function example() {
|
|
472
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
473
|
+
const api = new DefaultApi();
|
|
474
|
+
|
|
475
|
+
const body = {
|
|
476
|
+
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
477
|
+
exchange: exchange_example,
|
|
478
|
+
// FetchClosedOrdersRequest (optional)
|
|
479
|
+
fetchClosedOrdersRequest: ...,
|
|
480
|
+
} satisfies FetchClosedOrdersOperationRequest;
|
|
481
|
+
|
|
482
|
+
try {
|
|
483
|
+
const data = await api.fetchClosedOrders(body);
|
|
484
|
+
console.log(data);
|
|
485
|
+
} catch (error) {
|
|
486
|
+
console.error(error);
|
|
487
|
+
}
|
|
488
|
+
}
|
|
489
|
+
|
|
490
|
+
// Run the test
|
|
491
|
+
example().catch(console.error);
|
|
492
|
+
```
|
|
493
|
+
|
|
494
|
+
### Parameters
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
| Name | Type | Description | Notes |
|
|
498
|
+
|------------- | ------------- | ------------- | -------------|
|
|
499
|
+
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
500
|
+
| **fetchClosedOrdersRequest** | [FetchClosedOrdersRequest](FetchClosedOrdersRequest.md) | | [Optional] |
|
|
501
|
+
|
|
502
|
+
### Return type
|
|
503
|
+
|
|
504
|
+
[**FetchOpenOrders200Response**](FetchOpenOrders200Response.md)
|
|
505
|
+
|
|
506
|
+
### Authorization
|
|
507
|
+
|
|
508
|
+
No authorization required
|
|
509
|
+
|
|
510
|
+
### HTTP request headers
|
|
511
|
+
|
|
512
|
+
- **Content-Type**: `application/json`
|
|
513
|
+
- **Accept**: `application/json`
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
### HTTP response details
|
|
517
|
+
| Status code | Description | Response headers |
|
|
518
|
+
|-------------|-------------|------------------|
|
|
519
|
+
| **200** | Fetch Closed Orders response | - |
|
|
304
520
|
|
|
305
521
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
306
522
|
|
|
307
523
|
|
|
308
524
|
## fetchEvent
|
|
309
525
|
|
|
310
|
-
> FetchEvent200Response fetchEvent(exchange,
|
|
526
|
+
> FetchEvent200Response fetchEvent(exchange, fetchEventRequest)
|
|
311
527
|
|
|
312
|
-
Fetch
|
|
528
|
+
Fetch Event
|
|
313
529
|
|
|
314
|
-
Fetch a single event by lookup parameters.
|
|
530
|
+
Fetch a single event by lookup parameters. Convenience wrapper around fetchEvents() that returns a single result or throws EventNotFound.
|
|
315
531
|
|
|
316
532
|
### Example
|
|
317
533
|
|
|
@@ -320,7 +536,7 @@ import {
|
|
|
320
536
|
Configuration,
|
|
321
537
|
DefaultApi,
|
|
322
538
|
} from 'pmxtjs';
|
|
323
|
-
import type {
|
|
539
|
+
import type { FetchEventOperationRequest } from 'pmxtjs';
|
|
324
540
|
|
|
325
541
|
async function example() {
|
|
326
542
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -329,9 +545,9 @@ async function example() {
|
|
|
329
545
|
const body = {
|
|
330
546
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
331
547
|
exchange: exchange_example,
|
|
332
|
-
//
|
|
333
|
-
|
|
334
|
-
} satisfies
|
|
548
|
+
// FetchEventRequest (optional)
|
|
549
|
+
fetchEventRequest: ...,
|
|
550
|
+
} satisfies FetchEventOperationRequest;
|
|
335
551
|
|
|
336
552
|
try {
|
|
337
553
|
const data = await api.fetchEvent(body);
|
|
@@ -351,7 +567,7 @@ example().catch(console.error);
|
|
|
351
567
|
| Name | Type | Description | Notes |
|
|
352
568
|
|------------- | ------------- | ------------- | -------------|
|
|
353
569
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
354
|
-
| **
|
|
570
|
+
| **fetchEventRequest** | [FetchEventRequest](FetchEventRequest.md) | | [Optional] |
|
|
355
571
|
|
|
356
572
|
### Return type
|
|
357
573
|
|
|
@@ -370,8 +586,7 @@ No authorization required
|
|
|
370
586
|
### HTTP response details
|
|
371
587
|
| Status code | Description | Response headers |
|
|
372
588
|
|-------------|-------------|------------------|
|
|
373
|
-
| **200** |
|
|
374
|
-
| **404** | Event not found | - |
|
|
589
|
+
| **200** | Fetch Event response | - |
|
|
375
590
|
|
|
376
591
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
377
592
|
|
|
@@ -382,6 +597,8 @@ No authorization required
|
|
|
382
597
|
|
|
383
598
|
Fetch Events
|
|
384
599
|
|
|
600
|
+
Fetch events with optional keyword search. Events group related markets together (e.g., \"Who will be Fed Chair?\" contains multiple candidate markets).
|
|
601
|
+
|
|
385
602
|
### Example
|
|
386
603
|
|
|
387
604
|
```ts
|
|
@@ -439,7 +656,7 @@ No authorization required
|
|
|
439
656
|
### HTTP response details
|
|
440
657
|
| Status code | Description | Response headers |
|
|
441
658
|
|-------------|-------------|------------------|
|
|
442
|
-
| **200** |
|
|
659
|
+
| **200** | Fetch Events response | - |
|
|
443
660
|
|
|
444
661
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
445
662
|
|
|
@@ -448,9 +665,9 @@ No authorization required
|
|
|
448
665
|
|
|
449
666
|
> FetchMarket200Response fetchMarket(exchange, fetchMarketRequest)
|
|
450
667
|
|
|
451
|
-
Fetch
|
|
668
|
+
Fetch Market
|
|
452
669
|
|
|
453
|
-
Fetch a single market by lookup parameters.
|
|
670
|
+
Fetch a single market by lookup parameters. Convenience wrapper around fetchMarkets() that returns a single result or throws MarketNotFound.
|
|
454
671
|
|
|
455
672
|
### Example
|
|
456
673
|
|
|
@@ -509,8 +726,7 @@ No authorization required
|
|
|
509
726
|
### HTTP response details
|
|
510
727
|
| Status code | Description | Response headers |
|
|
511
728
|
|-------------|-------------|------------------|
|
|
512
|
-
| **200** |
|
|
513
|
-
| **404** | Market not found | - |
|
|
729
|
+
| **200** | Fetch Market response | - |
|
|
514
730
|
|
|
515
731
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
516
732
|
|
|
@@ -521,6 +737,8 @@ No authorization required
|
|
|
521
737
|
|
|
522
738
|
Fetch Markets
|
|
523
739
|
|
|
740
|
+
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.
|
|
741
|
+
|
|
524
742
|
### Example
|
|
525
743
|
|
|
526
744
|
```ts
|
|
@@ -578,7 +796,145 @@ No authorization required
|
|
|
578
796
|
### HTTP response details
|
|
579
797
|
| Status code | Description | Response headers |
|
|
580
798
|
|-------------|-------------|------------------|
|
|
581
|
-
| **200** |
|
|
799
|
+
| **200** | Fetch Markets response | - |
|
|
800
|
+
|
|
801
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
## fetchMarketsPaginated
|
|
805
|
+
|
|
806
|
+
> FetchMarketsPaginated200Response fetchMarketsPaginated(exchange, fetchMarketsPaginatedRequest)
|
|
807
|
+
|
|
808
|
+
Fetch Markets Paginated
|
|
809
|
+
|
|
810
|
+
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\'`.
|
|
811
|
+
|
|
812
|
+
### Example
|
|
813
|
+
|
|
814
|
+
```ts
|
|
815
|
+
import {
|
|
816
|
+
Configuration,
|
|
817
|
+
DefaultApi,
|
|
818
|
+
} from 'pmxtjs';
|
|
819
|
+
import type { FetchMarketsPaginatedOperationRequest } from 'pmxtjs';
|
|
820
|
+
|
|
821
|
+
async function example() {
|
|
822
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
823
|
+
const api = new DefaultApi();
|
|
824
|
+
|
|
825
|
+
const body = {
|
|
826
|
+
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
827
|
+
exchange: exchange_example,
|
|
828
|
+
// FetchMarketsPaginatedRequest (optional)
|
|
829
|
+
fetchMarketsPaginatedRequest: ...,
|
|
830
|
+
} satisfies FetchMarketsPaginatedOperationRequest;
|
|
831
|
+
|
|
832
|
+
try {
|
|
833
|
+
const data = await api.fetchMarketsPaginated(body);
|
|
834
|
+
console.log(data);
|
|
835
|
+
} catch (error) {
|
|
836
|
+
console.error(error);
|
|
837
|
+
}
|
|
838
|
+
}
|
|
839
|
+
|
|
840
|
+
// Run the test
|
|
841
|
+
example().catch(console.error);
|
|
842
|
+
```
|
|
843
|
+
|
|
844
|
+
### Parameters
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
| Name | Type | Description | Notes |
|
|
848
|
+
|------------- | ------------- | ------------- | -------------|
|
|
849
|
+
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
850
|
+
| **fetchMarketsPaginatedRequest** | [FetchMarketsPaginatedRequest](FetchMarketsPaginatedRequest.md) | | [Optional] |
|
|
851
|
+
|
|
852
|
+
### Return type
|
|
853
|
+
|
|
854
|
+
[**FetchMarketsPaginated200Response**](FetchMarketsPaginated200Response.md)
|
|
855
|
+
|
|
856
|
+
### Authorization
|
|
857
|
+
|
|
858
|
+
No authorization required
|
|
859
|
+
|
|
860
|
+
### HTTP request headers
|
|
861
|
+
|
|
862
|
+
- **Content-Type**: `application/json`
|
|
863
|
+
- **Accept**: `application/json`
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
### HTTP response details
|
|
867
|
+
| Status code | Description | Response headers |
|
|
868
|
+
|-------------|-------------|------------------|
|
|
869
|
+
| **200** | Fetch Markets Paginated response | - |
|
|
870
|
+
|
|
871
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
## fetchMyTrades
|
|
875
|
+
|
|
876
|
+
> FetchMyTrades200Response fetchMyTrades(exchange, fetchMyTradesRequest)
|
|
877
|
+
|
|
878
|
+
Fetch My Trades
|
|
879
|
+
|
|
880
|
+
### Example
|
|
881
|
+
|
|
882
|
+
```ts
|
|
883
|
+
import {
|
|
884
|
+
Configuration,
|
|
885
|
+
DefaultApi,
|
|
886
|
+
} from 'pmxtjs';
|
|
887
|
+
import type { FetchMyTradesOperationRequest } from 'pmxtjs';
|
|
888
|
+
|
|
889
|
+
async function example() {
|
|
890
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
891
|
+
const api = new DefaultApi();
|
|
892
|
+
|
|
893
|
+
const body = {
|
|
894
|
+
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
895
|
+
exchange: exchange_example,
|
|
896
|
+
// FetchMyTradesRequest (optional)
|
|
897
|
+
fetchMyTradesRequest: ...,
|
|
898
|
+
} satisfies FetchMyTradesOperationRequest;
|
|
899
|
+
|
|
900
|
+
try {
|
|
901
|
+
const data = await api.fetchMyTrades(body);
|
|
902
|
+
console.log(data);
|
|
903
|
+
} catch (error) {
|
|
904
|
+
console.error(error);
|
|
905
|
+
}
|
|
906
|
+
}
|
|
907
|
+
|
|
908
|
+
// Run the test
|
|
909
|
+
example().catch(console.error);
|
|
910
|
+
```
|
|
911
|
+
|
|
912
|
+
### Parameters
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
| Name | Type | Description | Notes |
|
|
916
|
+
|------------- | ------------- | ------------- | -------------|
|
|
917
|
+
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
918
|
+
| **fetchMyTradesRequest** | [FetchMyTradesRequest](FetchMyTradesRequest.md) | | [Optional] |
|
|
919
|
+
|
|
920
|
+
### Return type
|
|
921
|
+
|
|
922
|
+
[**FetchMyTrades200Response**](FetchMyTrades200Response.md)
|
|
923
|
+
|
|
924
|
+
### Authorization
|
|
925
|
+
|
|
926
|
+
No authorization required
|
|
927
|
+
|
|
928
|
+
### HTTP request headers
|
|
929
|
+
|
|
930
|
+
- **Content-Type**: `application/json`
|
|
931
|
+
- **Accept**: `application/json`
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
### HTTP response details
|
|
935
|
+
| Status code | Description | Response headers |
|
|
936
|
+
|-------------|-------------|------------------|
|
|
937
|
+
| **200** | Fetch My Trades response | - |
|
|
582
938
|
|
|
583
939
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
584
940
|
|
|
@@ -587,7 +943,9 @@ No authorization required
|
|
|
587
943
|
|
|
588
944
|
> FetchOHLCV200Response fetchOHLCV(exchange, fetchOHLCVRequest)
|
|
589
945
|
|
|
590
|
-
Fetch
|
|
946
|
+
Fetch O H L C V
|
|
947
|
+
|
|
948
|
+
Fetch historical OHLCV (candlestick) price data for a specific market outcome.
|
|
591
949
|
|
|
592
950
|
### Example
|
|
593
951
|
|
|
@@ -646,7 +1004,7 @@ No authorization required
|
|
|
646
1004
|
### HTTP response details
|
|
647
1005
|
| Status code | Description | Response headers |
|
|
648
1006
|
|-------------|-------------|------------------|
|
|
649
|
-
| **200** |
|
|
1007
|
+
| **200** | Fetch O H L C V response | - |
|
|
650
1008
|
|
|
651
1009
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
652
1010
|
|
|
@@ -657,6 +1015,8 @@ No authorization required
|
|
|
657
1015
|
|
|
658
1016
|
Fetch Open Orders
|
|
659
1017
|
|
|
1018
|
+
Fetch all open orders, optionally filtered by market.
|
|
1019
|
+
|
|
660
1020
|
### Example
|
|
661
1021
|
|
|
662
1022
|
```ts
|
|
@@ -714,17 +1074,19 @@ No authorization required
|
|
|
714
1074
|
### HTTP response details
|
|
715
1075
|
| Status code | Description | Response headers |
|
|
716
1076
|
|-------------|-------------|------------------|
|
|
717
|
-
| **200** |
|
|
1077
|
+
| **200** | Fetch Open Orders response | - |
|
|
718
1078
|
|
|
719
1079
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
720
1080
|
|
|
721
1081
|
|
|
722
1082
|
## fetchOrder
|
|
723
1083
|
|
|
724
|
-
> CreateOrder200Response fetchOrder(exchange,
|
|
1084
|
+
> CreateOrder200Response fetchOrder(exchange, fetchOrderRequest)
|
|
725
1085
|
|
|
726
1086
|
Fetch Order
|
|
727
1087
|
|
|
1088
|
+
Fetch a specific order by ID.
|
|
1089
|
+
|
|
728
1090
|
### Example
|
|
729
1091
|
|
|
730
1092
|
```ts
|
|
@@ -732,7 +1094,7 @@ import {
|
|
|
732
1094
|
Configuration,
|
|
733
1095
|
DefaultApi,
|
|
734
1096
|
} from 'pmxtjs';
|
|
735
|
-
import type {
|
|
1097
|
+
import type { FetchOrderOperationRequest } from 'pmxtjs';
|
|
736
1098
|
|
|
737
1099
|
async function example() {
|
|
738
1100
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -741,9 +1103,9 @@ async function example() {
|
|
|
741
1103
|
const body = {
|
|
742
1104
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
743
1105
|
exchange: exchange_example,
|
|
744
|
-
//
|
|
745
|
-
|
|
746
|
-
} satisfies
|
|
1106
|
+
// FetchOrderRequest (optional)
|
|
1107
|
+
fetchOrderRequest: ...,
|
|
1108
|
+
} satisfies FetchOrderOperationRequest;
|
|
747
1109
|
|
|
748
1110
|
try {
|
|
749
1111
|
const data = await api.fetchOrder(body);
|
|
@@ -763,7 +1125,7 @@ example().catch(console.error);
|
|
|
763
1125
|
| Name | Type | Description | Notes |
|
|
764
1126
|
|------------- | ------------- | ------------- | -------------|
|
|
765
1127
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
766
|
-
| **
|
|
1128
|
+
| **fetchOrderRequest** | [FetchOrderRequest](FetchOrderRequest.md) | | [Optional] |
|
|
767
1129
|
|
|
768
1130
|
### Return type
|
|
769
1131
|
|
|
@@ -782,7 +1144,7 @@ No authorization required
|
|
|
782
1144
|
### HTTP response details
|
|
783
1145
|
| Status code | Description | Response headers |
|
|
784
1146
|
|-------------|-------------|------------------|
|
|
785
|
-
| **200** | Order
|
|
1147
|
+
| **200** | Fetch Order response | - |
|
|
786
1148
|
|
|
787
1149
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
788
1150
|
|
|
@@ -793,6 +1155,8 @@ No authorization required
|
|
|
793
1155
|
|
|
794
1156
|
Fetch Order Book
|
|
795
1157
|
|
|
1158
|
+
Fetch the current order book (bids/asks) for a specific outcome. Essential for calculating spread, depth, and execution prices.
|
|
1159
|
+
|
|
796
1160
|
### Example
|
|
797
1161
|
|
|
798
1162
|
```ts
|
|
@@ -850,7 +1214,7 @@ No authorization required
|
|
|
850
1214
|
### HTTP response details
|
|
851
1215
|
| Status code | Description | Response headers |
|
|
852
1216
|
|-------------|-------------|------------------|
|
|
853
|
-
| **200** |
|
|
1217
|
+
| **200** | Fetch Order Book response | - |
|
|
854
1218
|
|
|
855
1219
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
856
1220
|
|
|
@@ -861,6 +1225,8 @@ No authorization required
|
|
|
861
1225
|
|
|
862
1226
|
Fetch Positions
|
|
863
1227
|
|
|
1228
|
+
Fetch current user positions across all markets.
|
|
1229
|
+
|
|
864
1230
|
### Example
|
|
865
1231
|
|
|
866
1232
|
```ts
|
|
@@ -918,7 +1284,7 @@ No authorization required
|
|
|
918
1284
|
### HTTP response details
|
|
919
1285
|
| Status code | Description | Response headers |
|
|
920
1286
|
|-------------|-------------|------------------|
|
|
921
|
-
| **200** |
|
|
1287
|
+
| **200** | Fetch Positions response | - |
|
|
922
1288
|
|
|
923
1289
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
924
1290
|
|
|
@@ -929,6 +1295,8 @@ No authorization required
|
|
|
929
1295
|
|
|
930
1296
|
Fetch Trades
|
|
931
1297
|
|
|
1298
|
+
Fetch raw trade history for a specific outcome.
|
|
1299
|
+
|
|
932
1300
|
### Example
|
|
933
1301
|
|
|
934
1302
|
```ts
|
|
@@ -986,7 +1354,7 @@ No authorization required
|
|
|
986
1354
|
### HTTP response details
|
|
987
1355
|
| Status code | Description | Response headers |
|
|
988
1356
|
|-------------|-------------|------------------|
|
|
989
|
-
| **200** |
|
|
1357
|
+
| **200** | Fetch Trades response | - |
|
|
990
1358
|
|
|
991
1359
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
992
1360
|
|
|
@@ -997,7 +1365,7 @@ No authorization required
|
|
|
997
1365
|
|
|
998
1366
|
Filter Events
|
|
999
1367
|
|
|
1000
|
-
Filter a list of events by criteria. Can filter by string query, structured criteria object, or custom filter function.
|
|
1368
|
+
Filter a list of events by criteria. Can filter by string query, structured criteria object, or custom filter function.
|
|
1001
1369
|
|
|
1002
1370
|
### Example
|
|
1003
1371
|
|
|
@@ -1056,7 +1424,7 @@ No authorization required
|
|
|
1056
1424
|
### HTTP response details
|
|
1057
1425
|
| Status code | Description | Response headers |
|
|
1058
1426
|
|-------------|-------------|------------------|
|
|
1059
|
-
| **200** |
|
|
1427
|
+
| **200** | Filter Events response | - |
|
|
1060
1428
|
|
|
1061
1429
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1062
1430
|
|
|
@@ -1067,7 +1435,7 @@ No authorization required
|
|
|
1067
1435
|
|
|
1068
1436
|
Filter Markets
|
|
1069
1437
|
|
|
1070
|
-
Filter a list of markets by criteria. Can filter by string query, structured criteria object, or custom filter function.
|
|
1438
|
+
Filter a list of markets by criteria. Can filter by string query, structured criteria object, or custom filter function.
|
|
1071
1439
|
|
|
1072
1440
|
### Example
|
|
1073
1441
|
|
|
@@ -1126,7 +1494,7 @@ No authorization required
|
|
|
1126
1494
|
### HTTP response details
|
|
1127
1495
|
| Status code | Description | Response headers |
|
|
1128
1496
|
|-------------|-------------|------------------|
|
|
1129
|
-
| **200** |
|
|
1497
|
+
| **200** | Filter Markets response | - |
|
|
1130
1498
|
|
|
1131
1499
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1132
1500
|
|
|
@@ -1137,6 +1505,8 @@ No authorization required
|
|
|
1137
1505
|
|
|
1138
1506
|
Get Execution Price
|
|
1139
1507
|
|
|
1508
|
+
Calculate the volume-weighted average execution price for a given order size. Returns 0 if the order cannot be fully filled.
|
|
1509
|
+
|
|
1140
1510
|
### Example
|
|
1141
1511
|
|
|
1142
1512
|
```ts
|
|
@@ -1194,16 +1564,18 @@ No authorization required
|
|
|
1194
1564
|
### HTTP response details
|
|
1195
1565
|
| Status code | Description | Response headers |
|
|
1196
1566
|
|-------------|-------------|------------------|
|
|
1197
|
-
| **200** |
|
|
1567
|
+
| **200** | Get Execution Price response | - |
|
|
1198
1568
|
|
|
1199
1569
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1200
1570
|
|
|
1201
1571
|
|
|
1202
1572
|
## getExecutionPriceDetailed
|
|
1203
1573
|
|
|
1204
|
-
> GetExecutionPriceDetailed200Response getExecutionPriceDetailed(exchange,
|
|
1574
|
+
> GetExecutionPriceDetailed200Response getExecutionPriceDetailed(exchange, getExecutionPriceDetailedRequest)
|
|
1575
|
+
|
|
1576
|
+
Get Execution Price Detailed
|
|
1205
1577
|
|
|
1206
|
-
|
|
1578
|
+
Calculate detailed execution price information including partial fill data.
|
|
1207
1579
|
|
|
1208
1580
|
### Example
|
|
1209
1581
|
|
|
@@ -1212,7 +1584,7 @@ import {
|
|
|
1212
1584
|
Configuration,
|
|
1213
1585
|
DefaultApi,
|
|
1214
1586
|
} from 'pmxtjs';
|
|
1215
|
-
import type {
|
|
1587
|
+
import type { GetExecutionPriceDetailedOperationRequest } from 'pmxtjs';
|
|
1216
1588
|
|
|
1217
1589
|
async function example() {
|
|
1218
1590
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1221,9 +1593,9 @@ async function example() {
|
|
|
1221
1593
|
const body = {
|
|
1222
1594
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1223
1595
|
exchange: exchange_example,
|
|
1224
|
-
//
|
|
1225
|
-
|
|
1226
|
-
} satisfies
|
|
1596
|
+
// GetExecutionPriceDetailedRequest (optional)
|
|
1597
|
+
getExecutionPriceDetailedRequest: ...,
|
|
1598
|
+
} satisfies GetExecutionPriceDetailedOperationRequest;
|
|
1227
1599
|
|
|
1228
1600
|
try {
|
|
1229
1601
|
const data = await api.getExecutionPriceDetailed(body);
|
|
@@ -1243,7 +1615,7 @@ example().catch(console.error);
|
|
|
1243
1615
|
| Name | Type | Description | Notes |
|
|
1244
1616
|
|------------- | ------------- | ------------- | -------------|
|
|
1245
1617
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1246
|
-
| **
|
|
1618
|
+
| **getExecutionPriceDetailedRequest** | [GetExecutionPriceDetailedRequest](GetExecutionPriceDetailedRequest.md) | | [Optional] |
|
|
1247
1619
|
|
|
1248
1620
|
### Return type
|
|
1249
1621
|
|
|
@@ -1262,7 +1634,7 @@ No authorization required
|
|
|
1262
1634
|
### HTTP response details
|
|
1263
1635
|
| Status code | Description | Response headers |
|
|
1264
1636
|
|-------------|-------------|------------------|
|
|
1265
|
-
| **200** | Detailed
|
|
1637
|
+
| **200** | Get Execution Price Detailed response | - |
|
|
1266
1638
|
|
|
1267
1639
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1268
1640
|
|
|
@@ -1324,13 +1696,13 @@ No authorization required
|
|
|
1324
1696
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1325
1697
|
|
|
1326
1698
|
|
|
1327
|
-
##
|
|
1699
|
+
## loadMarkets
|
|
1328
1700
|
|
|
1329
|
-
>
|
|
1701
|
+
> LoadMarkets200Response loadMarkets(exchange, loadMarketsRequest)
|
|
1330
1702
|
|
|
1331
|
-
|
|
1703
|
+
Load Markets
|
|
1332
1704
|
|
|
1333
|
-
|
|
1705
|
+
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.
|
|
1334
1706
|
|
|
1335
1707
|
### Example
|
|
1336
1708
|
|
|
@@ -1339,7 +1711,7 @@ import {
|
|
|
1339
1711
|
Configuration,
|
|
1340
1712
|
DefaultApi,
|
|
1341
1713
|
} from 'pmxtjs';
|
|
1342
|
-
import type {
|
|
1714
|
+
import type { LoadMarketsOperationRequest } from 'pmxtjs';
|
|
1343
1715
|
|
|
1344
1716
|
async function example() {
|
|
1345
1717
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1348,12 +1720,12 @@ async function example() {
|
|
|
1348
1720
|
const body = {
|
|
1349
1721
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1350
1722
|
exchange: exchange_example,
|
|
1351
|
-
//
|
|
1352
|
-
|
|
1353
|
-
} satisfies
|
|
1723
|
+
// LoadMarketsRequest (optional)
|
|
1724
|
+
loadMarketsRequest: ...,
|
|
1725
|
+
} satisfies LoadMarketsOperationRequest;
|
|
1354
1726
|
|
|
1355
1727
|
try {
|
|
1356
|
-
const data = await api.
|
|
1728
|
+
const data = await api.loadMarkets(body);
|
|
1357
1729
|
console.log(data);
|
|
1358
1730
|
} catch (error) {
|
|
1359
1731
|
console.error(error);
|
|
@@ -1370,11 +1742,11 @@ example().catch(console.error);
|
|
|
1370
1742
|
| Name | Type | Description | Notes |
|
|
1371
1743
|
|------------- | ------------- | ------------- | -------------|
|
|
1372
1744
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1373
|
-
| **
|
|
1745
|
+
| **loadMarketsRequest** | [LoadMarketsRequest](LoadMarketsRequest.md) | | [Optional] |
|
|
1374
1746
|
|
|
1375
1747
|
### Return type
|
|
1376
1748
|
|
|
1377
|
-
[**
|
|
1749
|
+
[**LoadMarkets200Response**](LoadMarkets200Response.md)
|
|
1378
1750
|
|
|
1379
1751
|
### Authorization
|
|
1380
1752
|
|
|
@@ -1389,16 +1761,18 @@ No authorization required
|
|
|
1389
1761
|
### HTTP response details
|
|
1390
1762
|
| Status code | Description | Response headers |
|
|
1391
1763
|
|-------------|-------------|------------------|
|
|
1392
|
-
| **200** |
|
|
1764
|
+
| **200** | Load Markets response | - |
|
|
1393
1765
|
|
|
1394
1766
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1395
1767
|
|
|
1396
1768
|
|
|
1397
|
-
##
|
|
1769
|
+
## submitOrder
|
|
1770
|
+
|
|
1771
|
+
> CreateOrder200Response submitOrder(exchange, submitOrderRequest)
|
|
1398
1772
|
|
|
1399
|
-
|
|
1773
|
+
Submit Order
|
|
1400
1774
|
|
|
1401
|
-
|
|
1775
|
+
Submit a pre-built order returned by buildOrder().
|
|
1402
1776
|
|
|
1403
1777
|
### Example
|
|
1404
1778
|
|
|
@@ -1407,7 +1781,7 @@ import {
|
|
|
1407
1781
|
Configuration,
|
|
1408
1782
|
DefaultApi,
|
|
1409
1783
|
} from 'pmxtjs';
|
|
1410
|
-
import type {
|
|
1784
|
+
import type { SubmitOrderOperationRequest } from 'pmxtjs';
|
|
1411
1785
|
|
|
1412
1786
|
async function example() {
|
|
1413
1787
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1416,12 +1790,12 @@ async function example() {
|
|
|
1416
1790
|
const body = {
|
|
1417
1791
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1418
1792
|
exchange: exchange_example,
|
|
1419
|
-
//
|
|
1420
|
-
|
|
1421
|
-
} satisfies
|
|
1793
|
+
// SubmitOrderRequest (optional)
|
|
1794
|
+
submitOrderRequest: ...,
|
|
1795
|
+
} satisfies SubmitOrderOperationRequest;
|
|
1422
1796
|
|
|
1423
1797
|
try {
|
|
1424
|
-
const data = await api.
|
|
1798
|
+
const data = await api.submitOrder(body);
|
|
1425
1799
|
console.log(data);
|
|
1426
1800
|
} catch (error) {
|
|
1427
1801
|
console.error(error);
|
|
@@ -1438,11 +1812,11 @@ example().catch(console.error);
|
|
|
1438
1812
|
| Name | Type | Description | Notes |
|
|
1439
1813
|
|------------- | ------------- | ------------- | -------------|
|
|
1440
1814
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1441
|
-
| **
|
|
1815
|
+
| **submitOrderRequest** | [SubmitOrderRequest](SubmitOrderRequest.md) | | [Optional] |
|
|
1442
1816
|
|
|
1443
1817
|
### Return type
|
|
1444
1818
|
|
|
1445
|
-
[**
|
|
1819
|
+
[**CreateOrder200Response**](CreateOrder200Response.md)
|
|
1446
1820
|
|
|
1447
1821
|
### Authorization
|
|
1448
1822
|
|
|
@@ -1457,18 +1831,18 @@ No authorization required
|
|
|
1457
1831
|
### HTTP response details
|
|
1458
1832
|
| Status code | Description | Response headers |
|
|
1459
1833
|
|-------------|-------------|------------------|
|
|
1460
|
-
| **200** |
|
|
1834
|
+
| **200** | Submit Order response | - |
|
|
1461
1835
|
|
|
1462
1836
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1463
1837
|
|
|
1464
1838
|
|
|
1465
|
-
##
|
|
1839
|
+
## watchOrderBook
|
|
1466
1840
|
|
|
1467
|
-
>
|
|
1841
|
+
> FetchOrderBook200Response watchOrderBook(exchange, watchOrderBookRequest)
|
|
1468
1842
|
|
|
1469
|
-
Watch
|
|
1843
|
+
Watch Order Book
|
|
1470
1844
|
|
|
1471
|
-
|
|
1845
|
+
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).
|
|
1472
1846
|
|
|
1473
1847
|
### Example
|
|
1474
1848
|
|
|
@@ -1477,7 +1851,7 @@ import {
|
|
|
1477
1851
|
Configuration,
|
|
1478
1852
|
DefaultApi,
|
|
1479
1853
|
} from 'pmxtjs';
|
|
1480
|
-
import type {
|
|
1854
|
+
import type { WatchOrderBookOperationRequest } from 'pmxtjs';
|
|
1481
1855
|
|
|
1482
1856
|
async function example() {
|
|
1483
1857
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1486,12 +1860,12 @@ async function example() {
|
|
|
1486
1860
|
const body = {
|
|
1487
1861
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1488
1862
|
exchange: exchange_example,
|
|
1489
|
-
//
|
|
1490
|
-
|
|
1491
|
-
} satisfies
|
|
1863
|
+
// WatchOrderBookRequest (optional)
|
|
1864
|
+
watchOrderBookRequest: ...,
|
|
1865
|
+
} satisfies WatchOrderBookOperationRequest;
|
|
1492
1866
|
|
|
1493
1867
|
try {
|
|
1494
|
-
const data = await api.
|
|
1868
|
+
const data = await api.watchOrderBook(body);
|
|
1495
1869
|
console.log(data);
|
|
1496
1870
|
} catch (error) {
|
|
1497
1871
|
console.error(error);
|
|
@@ -1508,11 +1882,11 @@ example().catch(console.error);
|
|
|
1508
1882
|
| Name | Type | Description | Notes |
|
|
1509
1883
|
|------------- | ------------- | ------------- | -------------|
|
|
1510
1884
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1511
|
-
| **
|
|
1885
|
+
| **watchOrderBookRequest** | [WatchOrderBookRequest](WatchOrderBookRequest.md) | | [Optional] |
|
|
1512
1886
|
|
|
1513
1887
|
### Return type
|
|
1514
1888
|
|
|
1515
|
-
[**
|
|
1889
|
+
[**FetchOrderBook200Response**](FetchOrderBook200Response.md)
|
|
1516
1890
|
|
|
1517
1891
|
### Authorization
|
|
1518
1892
|
|
|
@@ -1527,84 +1901,18 @@ No authorization required
|
|
|
1527
1901
|
### HTTP response details
|
|
1528
1902
|
| Status code | Description | Response headers |
|
|
1529
1903
|
|-------------|-------------|------------------|
|
|
1530
|
-
| **200** |
|
|
1904
|
+
| **200** | Watch Order Book response | - |
|
|
1531
1905
|
|
|
1532
1906
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1533
1907
|
|
|
1534
1908
|
|
|
1535
|
-
##
|
|
1536
|
-
|
|
1537
|
-
> BaseResponse watchUserPositions(exchange, watchUserPositionsRequest)
|
|
1538
|
-
|
|
1539
|
-
Watch User Positions (WebSocket Stream)
|
|
1540
|
-
|
|
1541
|
-
### Example
|
|
1542
|
-
|
|
1543
|
-
```ts
|
|
1544
|
-
import {
|
|
1545
|
-
Configuration,
|
|
1546
|
-
DefaultApi,
|
|
1547
|
-
} from 'pmxtjs';
|
|
1548
|
-
import type { WatchUserPositionsOperationRequest } from 'pmxtjs';
|
|
1549
|
-
|
|
1550
|
-
async function example() {
|
|
1551
|
-
console.log("🚀 Testing pmxtjs SDK...");
|
|
1552
|
-
const api = new DefaultApi();
|
|
1553
|
-
|
|
1554
|
-
const body = {
|
|
1555
|
-
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1556
|
-
exchange: exchange_example,
|
|
1557
|
-
// WatchUserPositionsRequest (optional)
|
|
1558
|
-
watchUserPositionsRequest: ...,
|
|
1559
|
-
} satisfies WatchUserPositionsOperationRequest;
|
|
1560
|
-
|
|
1561
|
-
try {
|
|
1562
|
-
const data = await api.watchUserPositions(body);
|
|
1563
|
-
console.log(data);
|
|
1564
|
-
} catch (error) {
|
|
1565
|
-
console.error(error);
|
|
1566
|
-
}
|
|
1567
|
-
}
|
|
1568
|
-
|
|
1569
|
-
// Run the test
|
|
1570
|
-
example().catch(console.error);
|
|
1571
|
-
```
|
|
1572
|
-
|
|
1573
|
-
### Parameters
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
| Name | Type | Description | Notes |
|
|
1577
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1578
|
-
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1579
|
-
| **watchUserPositionsRequest** | [WatchUserPositionsRequest](WatchUserPositionsRequest.md) | | [Optional] |
|
|
1580
|
-
|
|
1581
|
-
### Return type
|
|
1582
|
-
|
|
1583
|
-
[**BaseResponse**](BaseResponse.md)
|
|
1584
|
-
|
|
1585
|
-
### Authorization
|
|
1586
|
-
|
|
1587
|
-
No authorization required
|
|
1588
|
-
|
|
1589
|
-
### HTTP request headers
|
|
1590
|
-
|
|
1591
|
-
- **Content-Type**: `application/json`
|
|
1592
|
-
- **Accept**: `application/json`
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
### HTTP response details
|
|
1596
|
-
| Status code | Description | Response headers |
|
|
1597
|
-
|-------------|-------------|------------------|
|
|
1598
|
-
| **200** | User position update | - |
|
|
1599
|
-
|
|
1600
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1601
|
-
|
|
1909
|
+
## watchTrades
|
|
1602
1910
|
|
|
1603
|
-
|
|
1911
|
+
> FetchTrades200Response watchTrades(exchange, watchTradesRequest)
|
|
1604
1912
|
|
|
1605
|
-
|
|
1913
|
+
Watch Trades
|
|
1606
1914
|
|
|
1607
|
-
Watch
|
|
1915
|
+
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
1916
|
|
|
1609
1917
|
### Example
|
|
1610
1918
|
|
|
@@ -1613,7 +1921,7 @@ import {
|
|
|
1613
1921
|
Configuration,
|
|
1614
1922
|
DefaultApi,
|
|
1615
1923
|
} from 'pmxtjs';
|
|
1616
|
-
import type {
|
|
1924
|
+
import type { WatchTradesOperationRequest } from 'pmxtjs';
|
|
1617
1925
|
|
|
1618
1926
|
async function example() {
|
|
1619
1927
|
console.log("🚀 Testing pmxtjs SDK...");
|
|
@@ -1622,12 +1930,12 @@ async function example() {
|
|
|
1622
1930
|
const body = {
|
|
1623
1931
|
// 'polymarket' | 'kalshi' | 'limitless' | 'probable' | 'baozi' | 'myriad' | The prediction market exchange to target.
|
|
1624
1932
|
exchange: exchange_example,
|
|
1625
|
-
//
|
|
1626
|
-
|
|
1627
|
-
} satisfies
|
|
1933
|
+
// WatchTradesRequest (optional)
|
|
1934
|
+
watchTradesRequest: ...,
|
|
1935
|
+
} satisfies WatchTradesOperationRequest;
|
|
1628
1936
|
|
|
1629
1937
|
try {
|
|
1630
|
-
const data = await api.
|
|
1938
|
+
const data = await api.watchTrades(body);
|
|
1631
1939
|
console.log(data);
|
|
1632
1940
|
} catch (error) {
|
|
1633
1941
|
console.error(error);
|
|
@@ -1644,11 +1952,11 @@ example().catch(console.error);
|
|
|
1644
1952
|
| Name | Type | Description | Notes |
|
|
1645
1953
|
|------------- | ------------- | ------------- | -------------|
|
|
1646
1954
|
| **exchange** | `polymarket`, `kalshi`, `limitless`, `probable`, `baozi`, `myriad` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, limitless, probable, baozi, myriad] |
|
|
1647
|
-
| **
|
|
1955
|
+
| **watchTradesRequest** | [WatchTradesRequest](WatchTradesRequest.md) | | [Optional] |
|
|
1648
1956
|
|
|
1649
1957
|
### Return type
|
|
1650
1958
|
|
|
1651
|
-
[**
|
|
1959
|
+
[**FetchTrades200Response**](FetchTrades200Response.md)
|
|
1652
1960
|
|
|
1653
1961
|
### Authorization
|
|
1654
1962
|
|
|
@@ -1663,7 +1971,7 @@ No authorization required
|
|
|
1663
1971
|
### HTTP response details
|
|
1664
1972
|
| Status code | Description | Response headers |
|
|
1665
1973
|
|-------------|-------------|------------------|
|
|
1666
|
-
| **200** |
|
|
1974
|
+
| **200** | Watch Trades response | - |
|
|
1667
1975
|
|
|
1668
1976
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1669
1977
|
|