pmxtjs 2.35.8 → 2.35.10
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 +196 -13
- package/dist/esm/generated/src/apis/DefaultApi.js +292 -13
- package/dist/esm/generated/src/models/FetchEventMatchesParams.d.ts +13 -1
- package/dist/esm/generated/src/models/FetchEventMatchesParams.js +4 -0
- package/dist/esm/generated/src/models/FetchMarketMatchesParams.d.ts +34 -1
- package/dist/esm/generated/src/models/FetchMarketMatchesParams.js +16 -0
- package/dist/esm/generated/src/models/FetchMatchedMarkets200Response.d.ts +46 -0
- package/dist/esm/generated/src/models/FetchMatchedMarkets200Response.js +47 -0
- package/dist/esm/generated/src/models/FetchMatchedMarketsParams.d.ts +61 -0
- package/dist/esm/generated/src/models/FetchMatchedMarketsParams.js +57 -0
- package/dist/esm/generated/src/models/MatchResult.d.ts +6 -0
- package/dist/esm/generated/src/models/MatchResult.js +2 -0
- package/dist/esm/generated/src/models/MatchedMarketPair.d.ts +98 -0
- package/dist/esm/generated/src/models/MatchedMarketPair.js +84 -0
- package/dist/esm/generated/src/models/index.d.ts +3 -0
- package/dist/esm/generated/src/models/index.js +3 -0
- package/dist/esm/pmxt/client.js +20 -0
- package/dist/generated/src/apis/DefaultApi.d.ts +196 -13
- package/dist/generated/src/apis/DefaultApi.js +293 -14
- package/dist/generated/src/models/FetchEventMatchesParams.d.ts +13 -1
- package/dist/generated/src/models/FetchEventMatchesParams.js +4 -0
- package/dist/generated/src/models/FetchMarketMatchesParams.d.ts +34 -1
- package/dist/generated/src/models/FetchMarketMatchesParams.js +17 -1
- package/dist/generated/src/models/FetchMatchedMarkets200Response.d.ts +46 -0
- package/dist/generated/src/models/FetchMatchedMarkets200Response.js +54 -0
- package/dist/generated/src/models/FetchMatchedMarketsParams.d.ts +61 -0
- package/dist/generated/src/models/FetchMatchedMarketsParams.js +65 -0
- package/dist/generated/src/models/MatchResult.d.ts +6 -0
- package/dist/generated/src/models/MatchResult.js +2 -0
- package/dist/generated/src/models/MatchedMarketPair.d.ts +98 -0
- package/dist/generated/src/models/MatchedMarketPair.js +92 -0
- package/dist/generated/src/models/index.d.ts +3 -0
- package/dist/generated/src/models/index.js +3 -0
- package/dist/pmxt/client.js +20 -0
- package/generated/.openapi-generator/FILES +6 -0
- package/generated/docs/DefaultApi.md +307 -21
- package/generated/docs/FetchEventMatchesParams.md +4 -0
- package/generated/docs/FetchMarketMatchesParams.md +8 -0
- package/generated/docs/FetchMatchedMarkets200Response.md +38 -0
- package/generated/docs/FetchMatchedMarketsParams.md +40 -0
- package/generated/docs/MatchResult.md +2 -0
- package/generated/docs/MatchedMarketPair.md +52 -0
- package/generated/package.json +1 -1
- package/generated/src/apis/DefaultApi.ts +408 -12
- package/generated/src/models/FetchEventMatchesParams.ts +17 -1
- package/generated/src/models/FetchMarketMatchesParams.ts +43 -1
- package/generated/src/models/FetchMatchedMarkets200Response.ts +96 -0
- package/generated/src/models/FetchMatchedMarketsParams.ts +103 -0
- package/generated/src/models/MatchResult.ts +8 -0
- package/generated/src/models/MatchedMarketPair.ts +166 -0
- package/generated/src/models/index.ts +3 -0
- package/package.json +2 -2
- package/pmxt/client.ts +28 -0
|
@@ -14,20 +14,23 @@ All URIs are relative to *http://localhost:3847*
|
|
|
14
14
|
| [**fetchBalance**](DefaultApi.md#fetchbalance) | **GET** /api/{exchange}/fetchBalance | Fetch Balance |
|
|
15
15
|
| [**fetchClosedOrders**](DefaultApi.md#fetchclosedorders) | **GET** /api/{exchange}/fetchClosedOrders | Fetch Closed Orders |
|
|
16
16
|
| [**fetchEvent**](DefaultApi.md#fetchevent) | **GET** /api/{exchange}/fetchEvent | Fetch Event |
|
|
17
|
-
| [**fetchEventMatches**](DefaultApi.md#fetcheventmatches) | **GET** /api/{exchange}/fetchEventMatches |
|
|
17
|
+
| [**fetchEventMatches**](DefaultApi.md#fetcheventmatches) | **GET** /api/{exchange}/fetchEventMatches | Event Matches |
|
|
18
18
|
| [**fetchEvents**](DefaultApi.md#fetchevents) | **GET** /api/{exchange}/fetchEvents | Fetch Events |
|
|
19
19
|
| [**fetchEventsPaginated**](DefaultApi.md#fetcheventspaginated) | **GET** /api/{exchange}/fetchEventsPaginated | Fetch Events Paginated |
|
|
20
20
|
| [**fetchHedges**](DefaultApi.md#fetchhedges) | **GET** /api/{exchange}/fetchHedges | Find Hedging Opportunities |
|
|
21
21
|
| [**fetchMarket**](DefaultApi.md#fetchmarket) | **GET** /api/{exchange}/fetchMarket | Fetch Market |
|
|
22
|
-
| [**fetchMarketMatches**](DefaultApi.md#fetchmarketmatches) | **GET** /api/{exchange}/fetchMarketMatches |
|
|
22
|
+
| [**fetchMarketMatches**](DefaultApi.md#fetchmarketmatches) | **GET** /api/{exchange}/fetchMarketMatches | Market Matches |
|
|
23
23
|
| [**fetchMarkets**](DefaultApi.md#fetchmarkets) | **GET** /api/{exchange}/fetchMarkets | Fetch Markets |
|
|
24
24
|
| [**fetchMarketsPaginated**](DefaultApi.md#fetchmarketspaginated) | **GET** /api/{exchange}/fetchMarketsPaginated | Fetch Markets Paginated |
|
|
25
|
+
| [**fetchMatchedMarkets**](DefaultApi.md#fetchmatchedmarkets) | **GET** /api/{exchange}/fetchMatchedMarkets | Matched Markets |
|
|
26
|
+
| [**fetchMatchedPrices**](DefaultApi.md#fetchmatchedprices) | **GET** /api/{exchange}/fetchMatchedPrices | Compare Matched Market Prices |
|
|
25
27
|
| [**fetchMyTrades**](DefaultApi.md#fetchmytrades) | **GET** /api/{exchange}/fetchMyTrades | Fetch My Trades |
|
|
26
28
|
| [**fetchOHLCV**](DefaultApi.md#fetchohlcv) | **GET** /api/{exchange}/fetchOHLCV | Fetch OHLCV |
|
|
27
29
|
| [**fetchOpenOrders**](DefaultApi.md#fetchopenorders) | **GET** /api/{exchange}/fetchOpenOrders | Fetch Open Orders |
|
|
28
30
|
| [**fetchOrder**](DefaultApi.md#fetchorder) | **GET** /api/{exchange}/fetchOrder | Fetch Order |
|
|
29
31
|
| [**fetchOrderBook**](DefaultApi.md#fetchorderbook) | **GET** /api/{exchange}/fetchOrderBook | Fetch Order Book |
|
|
30
32
|
| [**fetchPositions**](DefaultApi.md#fetchpositions) | **GET** /api/{exchange}/fetchPositions | Fetch Positions |
|
|
33
|
+
| [**fetchRelatedMarkets**](DefaultApi.md#fetchrelatedmarkets) | **GET** /api/{exchange}/fetchRelatedMarkets | Find Related Markets |
|
|
31
34
|
| [**fetchTrades**](DefaultApi.md#fetchtrades) | **GET** /api/{exchange}/fetchTrades | Fetch Trades |
|
|
32
35
|
| [**filterEvents**](DefaultApi.md#filtereventsoperation) | **POST** /api/{exchange}/filterEvents | Filter Events |
|
|
33
36
|
| [**filterMarkets**](DefaultApi.md#filtermarketsoperation) | **POST** /api/{exchange}/filterMarkets | Filter Markets |
|
|
@@ -480,8 +483,6 @@ No authorization required
|
|
|
480
483
|
|
|
481
484
|
Find Arbitrage Opportunities
|
|
482
485
|
|
|
483
|
-
Scan for arbitrage opportunities across venues. Finds identity matches where the same market is priced differently on different venues, returning opportunities sorted by spread size.
|
|
484
|
-
|
|
485
486
|
### Example
|
|
486
487
|
|
|
487
488
|
```ts
|
|
@@ -805,11 +806,11 @@ No authorization required
|
|
|
805
806
|
|
|
806
807
|
## fetchEventMatches
|
|
807
808
|
|
|
808
|
-
> FetchEventMatches200Response fetchEventMatches(exchange, event, eventId, slug, relation, minConfidence, limit, includePrices)
|
|
809
|
+
> FetchEventMatches200Response fetchEventMatches(exchange, query, category, event, eventId, slug, relation, minConfidence, limit, includePrices)
|
|
809
810
|
|
|
810
|
-
|
|
811
|
+
Event Matches
|
|
811
812
|
|
|
812
|
-
Find the same or related event on other venues. Given an event on one venue, discover semantically equivalent events across every other venue PMXT ingests
|
|
813
|
+
Find the same or related event on other venues. Two modes: **Lookup mode** (eventId/slug provided): Given an event on one venue, discover semantically equivalent events across every other venue PMXT ingests. **Browse mode** (no identifier): Returns all matched event pairs from the catalog. Supports query and category params for filtering.
|
|
813
814
|
|
|
814
815
|
### Example
|
|
815
816
|
|
|
@@ -827,9 +828,13 @@ async function example() {
|
|
|
827
828
|
const body = {
|
|
828
829
|
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | 'router' | The prediction market exchange to target.
|
|
829
830
|
exchange: exchange_example,
|
|
831
|
+
// string | Keyword search across matched event titles. (optional)
|
|
832
|
+
query: query_example,
|
|
833
|
+
// string | Filter matches by category. (optional)
|
|
834
|
+
category: category_example,
|
|
830
835
|
// UnifiedEvent | Pass a UnifiedEvent directly instead of eventId/slug. (optional)
|
|
831
836
|
event: ...,
|
|
832
|
-
// string (optional)
|
|
837
|
+
// string | Lookup a specific event by ID. Omit for browse mode. (optional)
|
|
833
838
|
eventId: eventId_example,
|
|
834
839
|
// string (optional)
|
|
835
840
|
slug: slug_example,
|
|
@@ -861,8 +866,10 @@ example().catch(console.error);
|
|
|
861
866
|
| Name | Type | Description | Notes |
|
|
862
867
|
|------------- | ------------- | ------------- | -------------|
|
|
863
868
|
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us`, `router` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us, router] |
|
|
869
|
+
| **query** | `string` | Keyword search across matched event titles. | [Optional] [Defaults to `undefined`] |
|
|
870
|
+
| **category** | `string` | Filter matches by category. | [Optional] [Defaults to `undefined`] |
|
|
864
871
|
| **event** | [](.md) | Pass a UnifiedEvent directly instead of eventId/slug. | [Optional] [Defaults to `undefined`] |
|
|
865
|
-
| **eventId** | `string` |
|
|
872
|
+
| **eventId** | `string` | Lookup a specific event by ID. Omit for browse mode. | [Optional] [Defaults to `undefined`] |
|
|
866
873
|
| **slug** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
867
874
|
| **relation** | `identity`, `subset`, `superset`, `overlap`, `disjoint` | | [Optional] [Defaults to `undefined`] [Enum: identity, subset, superset, overlap, disjoint] |
|
|
868
875
|
| **minConfidence** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
@@ -886,7 +893,7 @@ No authorization required
|
|
|
886
893
|
### HTTP response details
|
|
887
894
|
| Status code | Description | Response headers |
|
|
888
895
|
|-------------|-------------|------------------|
|
|
889
|
-
| **200** |
|
|
896
|
+
| **200** | Event Matches response | - |
|
|
890
897
|
|
|
891
898
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
892
899
|
|
|
@@ -1069,12 +1076,10 @@ No authorization required
|
|
|
1069
1076
|
|
|
1070
1077
|
## fetchHedges
|
|
1071
1078
|
|
|
1072
|
-
> CompareMarketPrices200Response fetchHedges(exchange, market, marketId, slug, url, relation, minConfidence, limit, includePrices)
|
|
1079
|
+
> CompareMarketPrices200Response fetchHedges(exchange, query, category, market, marketId, slug, url, relation, minConfidence, limit, includePrices, minDifference, sort)
|
|
1073
1080
|
|
|
1074
1081
|
Find Hedging Opportunities
|
|
1075
1082
|
|
|
1076
|
-
Find hedging opportunities across venues. Discovers subset/superset market relationships where one market\'s outcome implies another, enabling cross-venue hedging strategies with live prices.
|
|
1077
|
-
|
|
1078
1083
|
### Example
|
|
1079
1084
|
|
|
1080
1085
|
```ts
|
|
@@ -1091,9 +1096,13 @@ async function example() {
|
|
|
1091
1096
|
const body = {
|
|
1092
1097
|
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | 'router' | The prediction market exchange to target.
|
|
1093
1098
|
exchange: exchange_example,
|
|
1099
|
+
// string | Keyword search across matched market titles. (optional)
|
|
1100
|
+
query: query_example,
|
|
1101
|
+
// string | Filter matches by category. (optional)
|
|
1102
|
+
category: category_example,
|
|
1094
1103
|
// UnifiedMarket | Pass a UnifiedMarket directly instead of marketId/slug/url. (optional)
|
|
1095
1104
|
market: ...,
|
|
1096
|
-
// string (optional)
|
|
1105
|
+
// string | Lookup a specific market by ID. Omit for browse mode. (optional)
|
|
1097
1106
|
marketId: marketId_example,
|
|
1098
1107
|
// string (optional)
|
|
1099
1108
|
slug: slug_example,
|
|
@@ -1107,6 +1116,10 @@ async function example() {
|
|
|
1107
1116
|
limit: 8.14,
|
|
1108
1117
|
// boolean (optional)
|
|
1109
1118
|
includePrices: true,
|
|
1119
|
+
// number | Minimum price difference between venues. Browse mode only. (optional)
|
|
1120
|
+
minDifference: 8.14,
|
|
1121
|
+
// 'confidence' | 'volume' | 'priceDifference' | Sort order. Browse mode only. (optional)
|
|
1122
|
+
sort: sort_example,
|
|
1110
1123
|
} satisfies FetchHedgesRequest;
|
|
1111
1124
|
|
|
1112
1125
|
try {
|
|
@@ -1127,14 +1140,18 @@ example().catch(console.error);
|
|
|
1127
1140
|
| Name | Type | Description | Notes |
|
|
1128
1141
|
|------------- | ------------- | ------------- | -------------|
|
|
1129
1142
|
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us`, `router` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us, router] |
|
|
1143
|
+
| **query** | `string` | Keyword search across matched market titles. | [Optional] [Defaults to `undefined`] |
|
|
1144
|
+
| **category** | `string` | Filter matches by category. | [Optional] [Defaults to `undefined`] |
|
|
1130
1145
|
| **market** | [](.md) | Pass a UnifiedMarket directly instead of marketId/slug/url. | [Optional] [Defaults to `undefined`] |
|
|
1131
|
-
| **marketId** | `string` |
|
|
1146
|
+
| **marketId** | `string` | Lookup a specific market by ID. Omit for browse mode. | [Optional] [Defaults to `undefined`] |
|
|
1132
1147
|
| **slug** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1133
1148
|
| **url** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1134
1149
|
| **relation** | `identity`, `subset`, `superset`, `overlap`, `disjoint` | | [Optional] [Defaults to `undefined`] [Enum: identity, subset, superset, overlap, disjoint] |
|
|
1135
1150
|
| **minConfidence** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1136
1151
|
| **limit** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1137
1152
|
| **includePrices** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
1153
|
+
| **minDifference** | `number` | Minimum price difference between venues. Browse mode only. | [Optional] [Defaults to `undefined`] |
|
|
1154
|
+
| **sort** | `confidence`, `volume`, `priceDifference` | Sort order. Browse mode only. | [Optional] [Defaults to `undefined`] [Enum: confidence, volume, priceDifference] |
|
|
1138
1155
|
|
|
1139
1156
|
### Return type
|
|
1140
1157
|
|
|
@@ -1263,11 +1280,11 @@ No authorization required
|
|
|
1263
1280
|
|
|
1264
1281
|
## fetchMarketMatches
|
|
1265
1282
|
|
|
1266
|
-
> FetchMarketMatches200Response fetchMarketMatches(exchange, market, marketId, slug, url, relation, minConfidence, limit, includePrices)
|
|
1283
|
+
> FetchMarketMatches200Response fetchMarketMatches(exchange, query, category, market, marketId, slug, url, relation, minConfidence, limit, includePrices, minDifference, sort)
|
|
1267
1284
|
|
|
1268
|
-
|
|
1285
|
+
Market Matches
|
|
1269
1286
|
|
|
1270
|
-
Find the same or related market on other venues. Given a market on one venue, discover semantically equivalent markets across every other venue PMXT ingests
|
|
1287
|
+
Find the same or related market on other venues. Two modes: **Lookup mode** (marketId/slug/url provided): Given a market on one venue, discover semantically equivalent markets across every other venue PMXT ingests. **Browse mode** (no identifier): Returns all matched market pairs from the catalog. Supports query, category, minDifference, and sort params for filtering.
|
|
1271
1288
|
|
|
1272
1289
|
### Example
|
|
1273
1290
|
|
|
@@ -1285,9 +1302,13 @@ async function example() {
|
|
|
1285
1302
|
const body = {
|
|
1286
1303
|
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | 'router' | The prediction market exchange to target.
|
|
1287
1304
|
exchange: exchange_example,
|
|
1305
|
+
// string | Keyword search across matched market titles. (optional)
|
|
1306
|
+
query: query_example,
|
|
1307
|
+
// string | Filter matches by category. (optional)
|
|
1308
|
+
category: category_example,
|
|
1288
1309
|
// UnifiedMarket | Pass a UnifiedMarket directly instead of marketId/slug/url. (optional)
|
|
1289
1310
|
market: ...,
|
|
1290
|
-
// string (optional)
|
|
1311
|
+
// string | Lookup a specific market by ID. Omit for browse mode. (optional)
|
|
1291
1312
|
marketId: marketId_example,
|
|
1292
1313
|
// string (optional)
|
|
1293
1314
|
slug: slug_example,
|
|
@@ -1301,6 +1322,10 @@ async function example() {
|
|
|
1301
1322
|
limit: 8.14,
|
|
1302
1323
|
// boolean (optional)
|
|
1303
1324
|
includePrices: true,
|
|
1325
|
+
// number | Minimum price difference between venues. Browse mode only. (optional)
|
|
1326
|
+
minDifference: 8.14,
|
|
1327
|
+
// 'confidence' | 'volume' | 'priceDifference' | Sort order. Browse mode only. (optional)
|
|
1328
|
+
sort: sort_example,
|
|
1304
1329
|
} satisfies FetchMarketMatchesRequest;
|
|
1305
1330
|
|
|
1306
1331
|
try {
|
|
@@ -1321,14 +1346,18 @@ example().catch(console.error);
|
|
|
1321
1346
|
| Name | Type | Description | Notes |
|
|
1322
1347
|
|------------- | ------------- | ------------- | -------------|
|
|
1323
1348
|
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us`, `router` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us, router] |
|
|
1349
|
+
| **query** | `string` | Keyword search across matched market titles. | [Optional] [Defaults to `undefined`] |
|
|
1350
|
+
| **category** | `string` | Filter matches by category. | [Optional] [Defaults to `undefined`] |
|
|
1324
1351
|
| **market** | [](.md) | Pass a UnifiedMarket directly instead of marketId/slug/url. | [Optional] [Defaults to `undefined`] |
|
|
1325
|
-
| **marketId** | `string` |
|
|
1352
|
+
| **marketId** | `string` | Lookup a specific market by ID. Omit for browse mode. | [Optional] [Defaults to `undefined`] |
|
|
1326
1353
|
| **slug** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1327
1354
|
| **url** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1328
1355
|
| **relation** | `identity`, `subset`, `superset`, `overlap`, `disjoint` | | [Optional] [Defaults to `undefined`] [Enum: identity, subset, superset, overlap, disjoint] |
|
|
1329
1356
|
| **minConfidence** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1330
1357
|
| **limit** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1331
1358
|
| **includePrices** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
1359
|
+
| **minDifference** | `number` | Minimum price difference between venues. Browse mode only. | [Optional] [Defaults to `undefined`] |
|
|
1360
|
+
| **sort** | `confidence`, `volume`, `priceDifference` | Sort order. Browse mode only. | [Optional] [Defaults to `undefined`] [Enum: confidence, volume, priceDifference] |
|
|
1332
1361
|
|
|
1333
1362
|
### Return type
|
|
1334
1363
|
|
|
@@ -1347,7 +1376,7 @@ No authorization required
|
|
|
1347
1376
|
### HTTP response details
|
|
1348
1377
|
| Status code | Description | Response headers |
|
|
1349
1378
|
|-------------|-------------|------------------|
|
|
1350
|
-
| **200** |
|
|
1379
|
+
| **200** | Market Matches response | - |
|
|
1351
1380
|
|
|
1352
1381
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1353
1382
|
|
|
@@ -1531,6 +1560,160 @@ No authorization required
|
|
|
1531
1560
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1532
1561
|
|
|
1533
1562
|
|
|
1563
|
+
## fetchMatchedMarkets
|
|
1564
|
+
|
|
1565
|
+
> FetchMatchedMarkets200Response fetchMatchedMarkets(exchange, minDifference, category, limit, relations)
|
|
1566
|
+
|
|
1567
|
+
Matched Markets
|
|
1568
|
+
|
|
1569
|
+
### Example
|
|
1570
|
+
|
|
1571
|
+
```ts
|
|
1572
|
+
import {
|
|
1573
|
+
Configuration,
|
|
1574
|
+
DefaultApi,
|
|
1575
|
+
} from 'pmxtjs';
|
|
1576
|
+
import type { FetchMatchedMarketsRequest } from 'pmxtjs';
|
|
1577
|
+
|
|
1578
|
+
async function example() {
|
|
1579
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
1580
|
+
const api = new DefaultApi();
|
|
1581
|
+
|
|
1582
|
+
const body = {
|
|
1583
|
+
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | 'router' | The prediction market exchange to target.
|
|
1584
|
+
exchange: exchange_example,
|
|
1585
|
+
// number (optional)
|
|
1586
|
+
minDifference: 8.14,
|
|
1587
|
+
// string (optional)
|
|
1588
|
+
category: category_example,
|
|
1589
|
+
// number (optional)
|
|
1590
|
+
limit: 8.14,
|
|
1591
|
+
// Array<'identity' | 'subset' | 'superset' | 'overlap' | 'disjoint'> | Comma-separated relation types to include (default: \'identity\'). (optional)
|
|
1592
|
+
relations: ...,
|
|
1593
|
+
} satisfies FetchMatchedMarketsRequest;
|
|
1594
|
+
|
|
1595
|
+
try {
|
|
1596
|
+
const data = await api.fetchMatchedMarkets(body);
|
|
1597
|
+
console.log(data);
|
|
1598
|
+
} catch (error) {
|
|
1599
|
+
console.error(error);
|
|
1600
|
+
}
|
|
1601
|
+
}
|
|
1602
|
+
|
|
1603
|
+
// Run the test
|
|
1604
|
+
example().catch(console.error);
|
|
1605
|
+
```
|
|
1606
|
+
|
|
1607
|
+
### Parameters
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
| Name | Type | Description | Notes |
|
|
1611
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1612
|
+
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us`, `router` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us, router] |
|
|
1613
|
+
| **minDifference** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1614
|
+
| **category** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1615
|
+
| **limit** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1616
|
+
| **relations** | `identity`, `subset`, `superset`, `overlap`, `disjoint` | Comma-separated relation types to include (default: \'identity\'). | [Optional] [Enum: identity, subset, superset, overlap, disjoint] |
|
|
1617
|
+
|
|
1618
|
+
### Return type
|
|
1619
|
+
|
|
1620
|
+
[**FetchMatchedMarkets200Response**](FetchMatchedMarkets200Response.md)
|
|
1621
|
+
|
|
1622
|
+
### Authorization
|
|
1623
|
+
|
|
1624
|
+
No authorization required
|
|
1625
|
+
|
|
1626
|
+
### HTTP request headers
|
|
1627
|
+
|
|
1628
|
+
- **Content-Type**: Not defined
|
|
1629
|
+
- **Accept**: `application/json`
|
|
1630
|
+
|
|
1631
|
+
|
|
1632
|
+
### HTTP response details
|
|
1633
|
+
| Status code | Description | Response headers |
|
|
1634
|
+
|-------------|-------------|------------------|
|
|
1635
|
+
| **200** | Matched Markets response | - |
|
|
1636
|
+
|
|
1637
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
## fetchMatchedPrices
|
|
1641
|
+
|
|
1642
|
+
> FetchMatchedMarkets200Response fetchMatchedPrices(exchange, minDifference, category, limit, relations)
|
|
1643
|
+
|
|
1644
|
+
Compare Matched Market Prices
|
|
1645
|
+
|
|
1646
|
+
### Example
|
|
1647
|
+
|
|
1648
|
+
```ts
|
|
1649
|
+
import {
|
|
1650
|
+
Configuration,
|
|
1651
|
+
DefaultApi,
|
|
1652
|
+
} from 'pmxtjs';
|
|
1653
|
+
import type { FetchMatchedPricesRequest } from 'pmxtjs';
|
|
1654
|
+
|
|
1655
|
+
async function example() {
|
|
1656
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
1657
|
+
const api = new DefaultApi();
|
|
1658
|
+
|
|
1659
|
+
const body = {
|
|
1660
|
+
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | 'router' | The prediction market exchange to target.
|
|
1661
|
+
exchange: exchange_example,
|
|
1662
|
+
// number (optional)
|
|
1663
|
+
minDifference: 8.14,
|
|
1664
|
+
// string (optional)
|
|
1665
|
+
category: category_example,
|
|
1666
|
+
// number (optional)
|
|
1667
|
+
limit: 8.14,
|
|
1668
|
+
// Array<'identity' | 'subset' | 'superset' | 'overlap' | 'disjoint'> | Comma-separated relation types to include (default: \'identity\'). (optional)
|
|
1669
|
+
relations: ...,
|
|
1670
|
+
} satisfies FetchMatchedPricesRequest;
|
|
1671
|
+
|
|
1672
|
+
try {
|
|
1673
|
+
const data = await api.fetchMatchedPrices(body);
|
|
1674
|
+
console.log(data);
|
|
1675
|
+
} catch (error) {
|
|
1676
|
+
console.error(error);
|
|
1677
|
+
}
|
|
1678
|
+
}
|
|
1679
|
+
|
|
1680
|
+
// Run the test
|
|
1681
|
+
example().catch(console.error);
|
|
1682
|
+
```
|
|
1683
|
+
|
|
1684
|
+
### Parameters
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
| Name | Type | Description | Notes |
|
|
1688
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1689
|
+
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us`, `router` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us, router] |
|
|
1690
|
+
| **minDifference** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1691
|
+
| **category** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1692
|
+
| **limit** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1693
|
+
| **relations** | `identity`, `subset`, `superset`, `overlap`, `disjoint` | Comma-separated relation types to include (default: \'identity\'). | [Optional] [Enum: identity, subset, superset, overlap, disjoint] |
|
|
1694
|
+
|
|
1695
|
+
### Return type
|
|
1696
|
+
|
|
1697
|
+
[**FetchMatchedMarkets200Response**](FetchMatchedMarkets200Response.md)
|
|
1698
|
+
|
|
1699
|
+
### Authorization
|
|
1700
|
+
|
|
1701
|
+
No authorization required
|
|
1702
|
+
|
|
1703
|
+
### HTTP request headers
|
|
1704
|
+
|
|
1705
|
+
- **Content-Type**: Not defined
|
|
1706
|
+
- **Accept**: `application/json`
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
### HTTP response details
|
|
1710
|
+
| Status code | Description | Response headers |
|
|
1711
|
+
|-------------|-------------|------------------|
|
|
1712
|
+
| **200** | Compare Matched Market Prices response | - |
|
|
1713
|
+
|
|
1714
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1715
|
+
|
|
1716
|
+
|
|
1534
1717
|
## fetchMyTrades
|
|
1535
1718
|
|
|
1536
1719
|
> FetchMyTrades200Response fetchMyTrades(exchange, outcomeId, marketId, since, until, limit, cursor)
|
|
@@ -1976,6 +2159,109 @@ No authorization required
|
|
|
1976
2159
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1977
2160
|
|
|
1978
2161
|
|
|
2162
|
+
## fetchRelatedMarkets
|
|
2163
|
+
|
|
2164
|
+
> CompareMarketPrices200Response fetchRelatedMarkets(exchange, query, category, market, marketId, slug, url, relation, minConfidence, limit, includePrices, minDifference, sort)
|
|
2165
|
+
|
|
2166
|
+
Find Related Markets
|
|
2167
|
+
|
|
2168
|
+
Find related markets across venues. Discovers subset/superset market relationships where one market\'s outcome implies another, with live prices.
|
|
2169
|
+
|
|
2170
|
+
### Example
|
|
2171
|
+
|
|
2172
|
+
```ts
|
|
2173
|
+
import {
|
|
2174
|
+
Configuration,
|
|
2175
|
+
DefaultApi,
|
|
2176
|
+
} from 'pmxtjs';
|
|
2177
|
+
import type { FetchRelatedMarketsRequest } from 'pmxtjs';
|
|
2178
|
+
|
|
2179
|
+
async function example() {
|
|
2180
|
+
console.log("🚀 Testing pmxtjs SDK...");
|
|
2181
|
+
const api = new DefaultApi();
|
|
2182
|
+
|
|
2183
|
+
const body = {
|
|
2184
|
+
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | 'router' | The prediction market exchange to target.
|
|
2185
|
+
exchange: exchange_example,
|
|
2186
|
+
// string | Keyword search across matched market titles. (optional)
|
|
2187
|
+
query: query_example,
|
|
2188
|
+
// string | Filter matches by category. (optional)
|
|
2189
|
+
category: category_example,
|
|
2190
|
+
// UnifiedMarket | Pass a UnifiedMarket directly instead of marketId/slug/url. (optional)
|
|
2191
|
+
market: ...,
|
|
2192
|
+
// string | Lookup a specific market by ID. Omit for browse mode. (optional)
|
|
2193
|
+
marketId: marketId_example,
|
|
2194
|
+
// string (optional)
|
|
2195
|
+
slug: slug_example,
|
|
2196
|
+
// string (optional)
|
|
2197
|
+
url: url_example,
|
|
2198
|
+
// 'identity' | 'subset' | 'superset' | 'overlap' | 'disjoint' (optional)
|
|
2199
|
+
relation: relation_example,
|
|
2200
|
+
// number (optional)
|
|
2201
|
+
minConfidence: 8.14,
|
|
2202
|
+
// number (optional)
|
|
2203
|
+
limit: 8.14,
|
|
2204
|
+
// boolean (optional)
|
|
2205
|
+
includePrices: true,
|
|
2206
|
+
// number | Minimum price difference between venues. Browse mode only. (optional)
|
|
2207
|
+
minDifference: 8.14,
|
|
2208
|
+
// 'confidence' | 'volume' | 'priceDifference' | Sort order. Browse mode only. (optional)
|
|
2209
|
+
sort: sort_example,
|
|
2210
|
+
} satisfies FetchRelatedMarketsRequest;
|
|
2211
|
+
|
|
2212
|
+
try {
|
|
2213
|
+
const data = await api.fetchRelatedMarkets(body);
|
|
2214
|
+
console.log(data);
|
|
2215
|
+
} catch (error) {
|
|
2216
|
+
console.error(error);
|
|
2217
|
+
}
|
|
2218
|
+
}
|
|
2219
|
+
|
|
2220
|
+
// Run the test
|
|
2221
|
+
example().catch(console.error);
|
|
2222
|
+
```
|
|
2223
|
+
|
|
2224
|
+
### Parameters
|
|
2225
|
+
|
|
2226
|
+
|
|
2227
|
+
| Name | Type | Description | Notes |
|
|
2228
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2229
|
+
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us`, `router` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us, router] |
|
|
2230
|
+
| **query** | `string` | Keyword search across matched market titles. | [Optional] [Defaults to `undefined`] |
|
|
2231
|
+
| **category** | `string` | Filter matches by category. | [Optional] [Defaults to `undefined`] |
|
|
2232
|
+
| **market** | [](.md) | Pass a UnifiedMarket directly instead of marketId/slug/url. | [Optional] [Defaults to `undefined`] |
|
|
2233
|
+
| **marketId** | `string` | Lookup a specific market by ID. Omit for browse mode. | [Optional] [Defaults to `undefined`] |
|
|
2234
|
+
| **slug** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2235
|
+
| **url** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2236
|
+
| **relation** | `identity`, `subset`, `superset`, `overlap`, `disjoint` | | [Optional] [Defaults to `undefined`] [Enum: identity, subset, superset, overlap, disjoint] |
|
|
2237
|
+
| **minConfidence** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
2238
|
+
| **limit** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
2239
|
+
| **includePrices** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
2240
|
+
| **minDifference** | `number` | Minimum price difference between venues. Browse mode only. | [Optional] [Defaults to `undefined`] |
|
|
2241
|
+
| **sort** | `confidence`, `volume`, `priceDifference` | Sort order. Browse mode only. | [Optional] [Defaults to `undefined`] [Enum: confidence, volume, priceDifference] |
|
|
2242
|
+
|
|
2243
|
+
### Return type
|
|
2244
|
+
|
|
2245
|
+
[**CompareMarketPrices200Response**](CompareMarketPrices200Response.md)
|
|
2246
|
+
|
|
2247
|
+
### Authorization
|
|
2248
|
+
|
|
2249
|
+
No authorization required
|
|
2250
|
+
|
|
2251
|
+
### HTTP request headers
|
|
2252
|
+
|
|
2253
|
+
- **Content-Type**: Not defined
|
|
2254
|
+
- **Accept**: `application/json`
|
|
2255
|
+
|
|
2256
|
+
|
|
2257
|
+
### HTTP response details
|
|
2258
|
+
| Status code | Description | Response headers |
|
|
2259
|
+
|-------------|-------------|------------------|
|
|
2260
|
+
| **200** | Find Related Markets response | - |
|
|
2261
|
+
|
|
2262
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2263
|
+
|
|
2264
|
+
|
|
1979
2265
|
## fetchTrades
|
|
1980
2266
|
|
|
1981
2267
|
> FetchTrades200Response fetchTrades(exchange, id, start, end, limit)
|
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`query` | string
|
|
10
|
+
`category` | string
|
|
9
11
|
`event` | [UnifiedEvent](UnifiedEvent.md)
|
|
10
12
|
`eventId` | string
|
|
11
13
|
`slug` | string
|
|
@@ -21,6 +23,8 @@ import type { FetchEventMatchesParams } from 'pmxtjs'
|
|
|
21
23
|
|
|
22
24
|
// TODO: Update the object below with actual values
|
|
23
25
|
const example = {
|
|
26
|
+
"query": null,
|
|
27
|
+
"category": null,
|
|
24
28
|
"event": null,
|
|
25
29
|
"eventId": null,
|
|
26
30
|
"slug": null,
|
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`query` | string
|
|
10
|
+
`category` | string
|
|
9
11
|
`market` | [UnifiedMarket](UnifiedMarket.md)
|
|
10
12
|
`marketId` | string
|
|
11
13
|
`slug` | string
|
|
@@ -14,6 +16,8 @@ Name | Type
|
|
|
14
16
|
`minConfidence` | number
|
|
15
17
|
`limit` | number
|
|
16
18
|
`includePrices` | boolean
|
|
19
|
+
`minDifference` | number
|
|
20
|
+
`sort` | string
|
|
17
21
|
|
|
18
22
|
## Example
|
|
19
23
|
|
|
@@ -22,6 +26,8 @@ import type { FetchMarketMatchesParams } from 'pmxtjs'
|
|
|
22
26
|
|
|
23
27
|
// TODO: Update the object below with actual values
|
|
24
28
|
const example = {
|
|
29
|
+
"query": null,
|
|
30
|
+
"category": null,
|
|
25
31
|
"market": null,
|
|
26
32
|
"marketId": null,
|
|
27
33
|
"slug": null,
|
|
@@ -30,6 +36,8 @@ const example = {
|
|
|
30
36
|
"minConfidence": null,
|
|
31
37
|
"limit": null,
|
|
32
38
|
"includePrices": null,
|
|
39
|
+
"minDifference": null,
|
|
40
|
+
"sort": null,
|
|
33
41
|
} satisfies FetchMarketMatchesParams
|
|
34
42
|
|
|
35
43
|
console.log(example)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# FetchMatchedMarkets200Response
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`success` | boolean
|
|
10
|
+
`error` | [ErrorDetail](ErrorDetail.md)
|
|
11
|
+
`data` | [Array<MatchedMarketPair>](MatchedMarketPair.md)
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { FetchMatchedMarkets200Response } from 'pmxtjs'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"success": true,
|
|
21
|
+
"error": null,
|
|
22
|
+
"data": null,
|
|
23
|
+
} satisfies FetchMatchedMarkets200Response
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as FetchMatchedMarkets200Response
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# FetchMatchedMarketsParams
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`minDifference` | number
|
|
10
|
+
`category` | string
|
|
11
|
+
`limit` | number
|
|
12
|
+
`relations` | Array<string>
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { FetchMatchedMarketsParams } from 'pmxtjs'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"minDifference": null,
|
|
22
|
+
"category": null,
|
|
23
|
+
"limit": null,
|
|
24
|
+
"relations": null,
|
|
25
|
+
} satisfies FetchMatchedMarketsParams
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as FetchMatchedMarketsParams
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`market` | [UnifiedMarket](UnifiedMarket.md)
|
|
10
|
+
`sourceMarket` | [UnifiedMarket](UnifiedMarket.md)
|
|
10
11
|
`relation` | string
|
|
11
12
|
`confidence` | number
|
|
12
13
|
`reasoning` | string
|
|
@@ -21,6 +22,7 @@ import type { MatchResult } from 'pmxtjs'
|
|
|
21
22
|
// TODO: Update the object below with actual values
|
|
22
23
|
const example = {
|
|
23
24
|
"market": null,
|
|
25
|
+
"sourceMarket": null,
|
|
24
26
|
"relation": null,
|
|
25
27
|
"confidence": null,
|
|
26
28
|
"reasoning": null,
|