pmxtjs 2.27.2 → 2.27.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/generated/src/apis/DefaultApi.d.ts +6 -2
- package/dist/esm/generated/src/apis/DefaultApi.js +10 -6
- package/dist/esm/generated/src/models/Balance.d.ts +8 -8
- package/dist/esm/generated/src/models/Balance.js +12 -4
- package/dist/esm/generated/src/models/BuiltOrder.d.ts +7 -7
- package/dist/esm/generated/src/models/BuiltOrder.js +9 -3
- package/dist/esm/generated/src/models/BuiltOrderTx.d.ts +5 -5
- package/dist/esm/generated/src/models/BuiltOrderTx.js +12 -4
- package/dist/esm/generated/src/models/CreateOrderParams.d.ts +8 -8
- package/dist/esm/generated/src/models/CreateOrderParams.js +2 -2
- package/dist/esm/generated/src/models/EventFetchParams.d.ts +12 -11
- package/dist/esm/generated/src/models/EventFetchParams.js +3 -2
- package/dist/esm/generated/src/models/ExchangeCredentials.d.ts +16 -10
- package/dist/esm/generated/src/models/ExchangeCredentials.js +6 -4
- package/dist/esm/generated/src/models/ExchangeCredentialsSignatureType.d.ts +1 -1
- package/dist/esm/generated/src/models/ExecutionPriceResult.d.ts +3 -3
- package/dist/esm/generated/src/models/ExecutionPriceResult.js +9 -3
- package/dist/esm/generated/src/models/FilterEventsRequestArgsInner.d.ts +2 -2
- package/dist/esm/generated/src/models/FilterEventsRequestArgsInner.js +11 -5
- package/dist/esm/generated/src/models/FilterEventsRequestArgsInnerOneOf.d.ts +73 -0
- package/dist/esm/generated/src/models/FilterEventsRequestArgsInnerOneOf.js +61 -0
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInner.d.ts +1 -1
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInner.js +6 -0
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInnerOneOf.d.ts +88 -4
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInnerOneOf.js +43 -13
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInnerOneOfPrice.d.ts +54 -0
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInnerOneOfPrice.js +56 -0
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInnerOneOfResolutionDate.d.ts +38 -0
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInnerOneOfResolutionDate.js +43 -0
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInnerOneOfVolume24h.d.ts +38 -0
- package/dist/esm/generated/src/models/FilterMarketsRequestArgsInnerOneOfVolume24h.js +43 -0
- package/dist/esm/generated/src/models/HistoryFilterParams.d.ts +4 -4
- package/dist/esm/generated/src/models/MarketFilterParams.d.ts +10 -9
- package/dist/esm/generated/src/models/MarketFilterParams.js +1 -0
- package/dist/esm/generated/src/models/MarketOutcome.d.ts +7 -7
- package/dist/esm/generated/src/models/MarketOutcome.js +9 -3
- package/dist/esm/generated/src/models/MyTradesParams.d.ts +6 -6
- package/dist/esm/generated/src/models/OHLCVParams.d.ts +4 -4
- package/dist/esm/generated/src/models/Order.d.ts +23 -23
- package/dist/esm/generated/src/models/Order.js +32 -12
- package/dist/esm/generated/src/models/OrderBook.d.ts +5 -5
- package/dist/esm/generated/src/models/OrderBook.js +8 -4
- package/dist/esm/generated/src/models/OrderHistoryParams.d.ts +5 -5
- package/dist/esm/generated/src/models/OrderLevel.d.ts +4 -4
- package/dist/esm/generated/src/models/OrderLevel.js +6 -2
- package/dist/esm/generated/src/models/PaginatedMarketsResult.d.ts +6 -6
- package/dist/esm/generated/src/models/PaginatedMarketsResult.js +7 -3
- package/dist/esm/generated/src/models/Position.d.ts +15 -15
- package/dist/esm/generated/src/models/Position.js +21 -7
- package/dist/esm/generated/src/models/PriceCandle.d.ts +11 -11
- package/dist/esm/generated/src/models/PriceCandle.js +15 -5
- package/dist/esm/generated/src/models/Trade.d.ts +17 -11
- package/dist/esm/generated/src/models/Trade.js +18 -6
- package/dist/esm/generated/src/models/TradesParams.d.ts +3 -3
- package/dist/esm/generated/src/models/UnifiedEvent.d.ts +18 -18
- package/dist/esm/generated/src/models/UnifiedEvent.js +22 -8
- package/dist/esm/generated/src/models/UnifiedMarket.d.ts +30 -30
- package/dist/esm/generated/src/models/UnifiedMarket.js +28 -12
- package/dist/esm/generated/src/models/UserTrade.d.ts +13 -19
- package/dist/esm/generated/src/models/UserTrade.js +18 -10
- package/dist/esm/generated/src/models/index.d.ts +4 -0
- package/dist/esm/generated/src/models/index.js +4 -0
- package/dist/generated/src/apis/DefaultApi.d.ts +6 -2
- package/dist/generated/src/apis/DefaultApi.js +10 -6
- package/dist/generated/src/models/Balance.d.ts +8 -8
- package/dist/generated/src/models/Balance.js +12 -4
- package/dist/generated/src/models/BuiltOrder.d.ts +7 -7
- package/dist/generated/src/models/BuiltOrder.js +9 -3
- package/dist/generated/src/models/BuiltOrderTx.d.ts +5 -5
- package/dist/generated/src/models/BuiltOrderTx.js +12 -4
- package/dist/generated/src/models/CreateOrderParams.d.ts +8 -8
- package/dist/generated/src/models/CreateOrderParams.js +2 -2
- package/dist/generated/src/models/EventFetchParams.d.ts +12 -11
- package/dist/generated/src/models/EventFetchParams.js +3 -2
- package/dist/generated/src/models/ExchangeCredentials.d.ts +16 -10
- package/dist/generated/src/models/ExchangeCredentials.js +6 -4
- package/dist/generated/src/models/ExchangeCredentialsSignatureType.d.ts +1 -1
- package/dist/generated/src/models/ExecutionPriceResult.d.ts +3 -3
- package/dist/generated/src/models/ExecutionPriceResult.js +9 -3
- package/dist/generated/src/models/FilterEventsRequestArgsInner.d.ts +2 -2
- package/dist/generated/src/models/FilterEventsRequestArgsInner.js +11 -5
- package/dist/generated/src/models/FilterEventsRequestArgsInnerOneOf.d.ts +73 -0
- package/dist/generated/src/models/FilterEventsRequestArgsInnerOneOf.js +69 -0
- package/dist/generated/src/models/FilterMarketsRequestArgsInner.d.ts +1 -1
- package/dist/generated/src/models/FilterMarketsRequestArgsInner.js +6 -0
- package/dist/generated/src/models/FilterMarketsRequestArgsInnerOneOf.d.ts +88 -4
- package/dist/generated/src/models/FilterMarketsRequestArgsInnerOneOf.js +44 -13
- package/dist/generated/src/models/FilterMarketsRequestArgsInnerOneOfPrice.d.ts +54 -0
- package/dist/generated/src/models/FilterMarketsRequestArgsInnerOneOfPrice.js +64 -0
- package/dist/generated/src/models/FilterMarketsRequestArgsInnerOneOfResolutionDate.d.ts +38 -0
- package/dist/generated/src/models/FilterMarketsRequestArgsInnerOneOfResolutionDate.js +50 -0
- package/dist/generated/src/models/FilterMarketsRequestArgsInnerOneOfVolume24h.d.ts +38 -0
- package/dist/generated/src/models/FilterMarketsRequestArgsInnerOneOfVolume24h.js +50 -0
- package/dist/generated/src/models/HistoryFilterParams.d.ts +4 -4
- package/dist/generated/src/models/MarketFilterParams.d.ts +10 -9
- package/dist/generated/src/models/MarketFilterParams.js +1 -0
- package/dist/generated/src/models/MarketOutcome.d.ts +7 -7
- package/dist/generated/src/models/MarketOutcome.js +9 -3
- package/dist/generated/src/models/MyTradesParams.d.ts +6 -6
- package/dist/generated/src/models/OHLCVParams.d.ts +4 -4
- package/dist/generated/src/models/Order.d.ts +23 -23
- package/dist/generated/src/models/Order.js +32 -12
- package/dist/generated/src/models/OrderBook.d.ts +5 -5
- package/dist/generated/src/models/OrderBook.js +8 -4
- package/dist/generated/src/models/OrderHistoryParams.d.ts +5 -5
- package/dist/generated/src/models/OrderLevel.d.ts +4 -4
- package/dist/generated/src/models/OrderLevel.js +6 -2
- package/dist/generated/src/models/PaginatedMarketsResult.d.ts +6 -6
- package/dist/generated/src/models/PaginatedMarketsResult.js +7 -3
- package/dist/generated/src/models/Position.d.ts +15 -15
- package/dist/generated/src/models/Position.js +21 -7
- package/dist/generated/src/models/PriceCandle.d.ts +11 -11
- package/dist/generated/src/models/PriceCandle.js +15 -5
- package/dist/generated/src/models/Trade.d.ts +17 -11
- package/dist/generated/src/models/Trade.js +18 -6
- package/dist/generated/src/models/TradesParams.d.ts +3 -3
- package/dist/generated/src/models/UnifiedEvent.d.ts +18 -18
- package/dist/generated/src/models/UnifiedEvent.js +22 -8
- package/dist/generated/src/models/UnifiedMarket.d.ts +30 -30
- package/dist/generated/src/models/UnifiedMarket.js +28 -12
- package/dist/generated/src/models/UserTrade.d.ts +13 -19
- package/dist/generated/src/models/UserTrade.js +18 -10
- package/dist/generated/src/models/index.d.ts +4 -0
- package/dist/generated/src/models/index.js +4 -0
- package/generated/.openapi-generator/FILES +8 -0
- package/generated/docs/BuiltOrder.md +0 -1
- package/generated/docs/BuiltOrderTx.md +1 -1
- package/generated/docs/DefaultApi.md +123 -123
- package/generated/docs/EventFetchParams.md +2 -2
- package/generated/docs/ExchangeCredentials.md +7 -5
- package/generated/docs/ExchangeCredentialsSignatureType.md +1 -1
- package/generated/docs/FilterEventsRequestArgsInner.md +12 -0
- package/generated/docs/FilterEventsRequestArgsInnerOneOf.md +44 -0
- package/generated/docs/FilterMarketsRequestArgsInner.md +22 -0
- package/generated/docs/FilterMarketsRequestArgsInnerOneOf.md +22 -0
- package/generated/docs/FilterMarketsRequestArgsInnerOneOfPrice.md +38 -0
- package/generated/docs/FilterMarketsRequestArgsInnerOneOfResolutionDate.md +36 -0
- package/generated/docs/FilterMarketsRequestArgsInnerOneOfVolume24h.md +36 -0
- package/generated/docs/PaginatedMarketsResult.md +1 -0
- package/generated/docs/Trade.md +4 -2
- package/generated/docs/UnifiedEvent.md +1 -1
- package/generated/docs/UnifiedMarket.md +2 -2
- package/generated/docs/UserTrade.md +4 -6
- package/generated/package.json +1 -1
- package/generated/src/apis/DefaultApi.ts +14 -10
- package/generated/src/models/Balance.ts +16 -12
- package/generated/src/models/BuiltOrder.ts +13 -10
- package/generated/src/models/BuiltOrderTx.ts +13 -9
- package/generated/src/models/CreateOrderParams.ts +9 -9
- package/generated/src/models/EventFetchParams.ts +14 -13
- package/generated/src/models/ExchangeCredentials.ts +22 -14
- package/generated/src/models/ExchangeCredentialsSignatureType.ts +1 -1
- package/generated/src/models/ExecutionPriceResult.ts +9 -6
- package/generated/src/models/FilterEventsRequestArgsInner.ts +17 -11
- package/generated/src/models/FilterEventsRequestArgsInnerOneOf.ts +126 -0
- package/generated/src/models/FilterMarketsRequestArgsInner.ts +7 -1
- package/generated/src/models/FilterMarketsRequestArgsInnerOneOf.ts +141 -15
- package/generated/src/models/FilterMarketsRequestArgsInnerOneOfPrice.ts +95 -0
- package/generated/src/models/FilterMarketsRequestArgsInnerOneOfResolutionDate.ts +73 -0
- package/generated/src/models/FilterMarketsRequestArgsInnerOneOfVolume24h.ts +73 -0
- package/generated/src/models/HistoryFilterParams.ts +4 -4
- package/generated/src/models/MarketFilterParams.ts +10 -9
- package/generated/src/models/MarketOutcome.ts +13 -10
- package/generated/src/models/MyTradesParams.ts +6 -6
- package/generated/src/models/OHLCVParams.ts +4 -4
- package/generated/src/models/Order.ts +44 -34
- package/generated/src/models/OrderBook.ts +11 -9
- package/generated/src/models/OrderHistoryParams.ts +5 -5
- package/generated/src/models/OrderLevel.ts +8 -6
- package/generated/src/models/PaginatedMarketsResult.ts +11 -9
- package/generated/src/models/Position.ts +29 -22
- package/generated/src/models/PriceCandle.ts +21 -16
- package/generated/src/models/Trade.ts +30 -17
- package/generated/src/models/TradesParams.ts +3 -3
- package/generated/src/models/UnifiedEvent.ts +33 -26
- package/generated/src/models/UnifiedMarket.ts +50 -42
- package/generated/src/models/UserTrade.ts +26 -29
- package/generated/src/models/index.ts +4 -0
- package/package.json +2 -2
|
@@ -339,15 +339,15 @@ async function example() {
|
|
|
339
339
|
const body = {
|
|
340
340
|
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | The prediction market exchange to target.
|
|
341
341
|
exchange: exchange_example,
|
|
342
|
-
// string |
|
|
342
|
+
// string | required for Limitless (slug) (optional)
|
|
343
343
|
marketId: marketId_example,
|
|
344
|
-
// Date (optional)
|
|
344
|
+
// Date | Only return records after this date (optional)
|
|
345
345
|
since: 2013-10-20T19:20:30+01:00,
|
|
346
|
-
// Date (optional)
|
|
346
|
+
// Date | Only return records before this date (optional)
|
|
347
347
|
until: 2013-10-20T19:20:30+01:00,
|
|
348
|
-
// number (optional)
|
|
349
|
-
limit:
|
|
350
|
-
// string (optional)
|
|
348
|
+
// number | Maximum number of results to return (optional)
|
|
349
|
+
limit: 8.14,
|
|
350
|
+
// string | Opaque pagination cursor from a previous response (optional)
|
|
351
351
|
cursor: cursor_example,
|
|
352
352
|
} satisfies FetchAllOrdersRequest;
|
|
353
353
|
|
|
@@ -369,11 +369,11 @@ example().catch(console.error);
|
|
|
369
369
|
| Name | Type | Description | Notes |
|
|
370
370
|
|------------- | ------------- | ------------- | -------------|
|
|
371
371
|
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
|
|
372
|
-
| **marketId** | `string` |
|
|
373
|
-
| **since** | `Date` |
|
|
374
|
-
| **until** | `Date` |
|
|
375
|
-
| **limit** | `number` |
|
|
376
|
-
| **cursor** | `string` |
|
|
372
|
+
| **marketId** | `string` | required for Limitless (slug) | [Optional] [Defaults to `undefined`] |
|
|
373
|
+
| **since** | `Date` | Only return records after this date | [Optional] [Defaults to `undefined`] |
|
|
374
|
+
| **until** | `Date` | Only return records before this date | [Optional] [Defaults to `undefined`] |
|
|
375
|
+
| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
|
|
376
|
+
| **cursor** | `string` | Opaque pagination cursor from a previous response | [Optional] [Defaults to `undefined`] |
|
|
377
377
|
|
|
378
378
|
### Return type
|
|
379
379
|
|
|
@@ -489,15 +489,15 @@ async function example() {
|
|
|
489
489
|
const body = {
|
|
490
490
|
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | The prediction market exchange to target.
|
|
491
491
|
exchange: exchange_example,
|
|
492
|
-
// string |
|
|
492
|
+
// string | required for Limitless (slug) (optional)
|
|
493
493
|
marketId: marketId_example,
|
|
494
|
-
// Date (optional)
|
|
494
|
+
// Date | Only return records after this date (optional)
|
|
495
495
|
since: 2013-10-20T19:20:30+01:00,
|
|
496
|
-
// Date (optional)
|
|
496
|
+
// Date | Only return records before this date (optional)
|
|
497
497
|
until: 2013-10-20T19:20:30+01:00,
|
|
498
|
-
// number (optional)
|
|
499
|
-
limit:
|
|
500
|
-
// string (optional)
|
|
498
|
+
// number | Maximum number of results to return (optional)
|
|
499
|
+
limit: 8.14,
|
|
500
|
+
// string | Opaque pagination cursor from a previous response (optional)
|
|
501
501
|
cursor: cursor_example,
|
|
502
502
|
} satisfies FetchClosedOrdersRequest;
|
|
503
503
|
|
|
@@ -519,11 +519,11 @@ example().catch(console.error);
|
|
|
519
519
|
| Name | Type | Description | Notes |
|
|
520
520
|
|------------- | ------------- | ------------- | -------------|
|
|
521
521
|
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
|
|
522
|
-
| **marketId** | `string` |
|
|
523
|
-
| **since** | `Date` |
|
|
524
|
-
| **until** | `Date` |
|
|
525
|
-
| **limit** | `number` |
|
|
526
|
-
| **cursor** | `string` |
|
|
522
|
+
| **marketId** | `string` | required for Limitless (slug) | [Optional] [Defaults to `undefined`] |
|
|
523
|
+
| **since** | `Date` | Only return records after this date | [Optional] [Defaults to `undefined`] |
|
|
524
|
+
| **until** | `Date` | Only return records before this date | [Optional] [Defaults to `undefined`] |
|
|
525
|
+
| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
|
|
526
|
+
| **cursor** | `string` | Opaque pagination cursor from a previous response | [Optional] [Defaults to `undefined`] |
|
|
527
527
|
|
|
528
528
|
### Return type
|
|
529
529
|
|
|
@@ -549,7 +549,7 @@ No authorization required
|
|
|
549
549
|
|
|
550
550
|
## fetchEvent
|
|
551
551
|
|
|
552
|
-
> FetchEvent200Response fetchEvent(exchange, query,
|
|
552
|
+
> FetchEvent200Response fetchEvent(exchange, query, limit, offset, sort, status, searchIn, eventId, slug)
|
|
553
553
|
|
|
554
554
|
Fetch Event
|
|
555
555
|
|
|
@@ -571,17 +571,17 @@ async function example() {
|
|
|
571
571
|
const body = {
|
|
572
572
|
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | The prediction market exchange to target.
|
|
573
573
|
exchange: exchange_example,
|
|
574
|
-
// string (optional)
|
|
574
|
+
// string | For keyword search (optional)
|
|
575
575
|
query: query_example,
|
|
576
|
-
//
|
|
576
|
+
// number | Maximum number of results to return (optional)
|
|
577
|
+
limit: 8.14,
|
|
578
|
+
// number | Pagination offset — number of results to skip (optional)
|
|
579
|
+
offset: 8.14,
|
|
580
|
+
// 'volume' | 'liquidity' | 'newest' | Sort order for results (optional)
|
|
577
581
|
sort: sort_example,
|
|
578
|
-
//
|
|
579
|
-
limit: 56,
|
|
580
|
-
// number (optional)
|
|
581
|
-
offset: 56,
|
|
582
|
-
// 'active' | 'closed' | 'all' | Filter by event status (default: active) (optional)
|
|
582
|
+
// 'active' | 'inactive' | 'closed' | 'all' | Filter by event status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) (optional)
|
|
583
583
|
status: status_example,
|
|
584
|
-
// 'title' | 'description' | 'both' (optional)
|
|
584
|
+
// 'title' | 'description' | 'both' | Where to search (default: \'title\') (optional)
|
|
585
585
|
searchIn: searchIn_example,
|
|
586
586
|
// string | Direct lookup by event ID (optional)
|
|
587
587
|
eventId: eventId_example,
|
|
@@ -607,12 +607,12 @@ example().catch(console.error);
|
|
|
607
607
|
| Name | Type | Description | Notes |
|
|
608
608
|
|------------- | ------------- | ------------- | -------------|
|
|
609
609
|
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
|
|
610
|
-
| **query** | `string` |
|
|
611
|
-
| **
|
|
612
|
-
| **
|
|
613
|
-
| **
|
|
614
|
-
| **status** | `active`, `closed`, `all` | Filter by event status (default: active) | [Optional] [Defaults to `undefined`] [Enum: active, closed, all] |
|
|
615
|
-
| **searchIn** | `title`, `description`, `both` |
|
|
610
|
+
| **query** | `string` | For keyword search | [Optional] [Defaults to `undefined`] |
|
|
611
|
+
| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
|
|
612
|
+
| **offset** | `number` | Pagination offset — number of results to skip | [Optional] [Defaults to `undefined`] |
|
|
613
|
+
| **sort** | `volume`, `liquidity`, `newest` | Sort order for results | [Optional] [Defaults to `undefined`] [Enum: volume, liquidity, newest] |
|
|
614
|
+
| **status** | `active`, `inactive`, `closed`, `all` | Filter by event status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) | [Optional] [Defaults to `undefined`] [Enum: active, inactive, closed, all] |
|
|
615
|
+
| **searchIn** | `title`, `description`, `both` | Where to search (default: \'title\') | [Optional] [Defaults to `undefined`] [Enum: title, description, both] |
|
|
616
616
|
| **eventId** | `string` | Direct lookup by event ID | [Optional] [Defaults to `undefined`] |
|
|
617
617
|
| **slug** | `string` | Lookup by event slug | [Optional] [Defaults to `undefined`] |
|
|
618
618
|
|
|
@@ -640,7 +640,7 @@ No authorization required
|
|
|
640
640
|
|
|
641
641
|
## fetchEvents
|
|
642
642
|
|
|
643
|
-
> FetchEvents200Response fetchEvents(exchange, query,
|
|
643
|
+
> FetchEvents200Response fetchEvents(exchange, query, limit, offset, sort, status, searchIn, eventId, slug)
|
|
644
644
|
|
|
645
645
|
Fetch Events
|
|
646
646
|
|
|
@@ -662,17 +662,17 @@ async function example() {
|
|
|
662
662
|
const body = {
|
|
663
663
|
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | The prediction market exchange to target.
|
|
664
664
|
exchange: exchange_example,
|
|
665
|
-
// string (optional)
|
|
665
|
+
// string | For keyword search (optional)
|
|
666
666
|
query: query_example,
|
|
667
|
-
//
|
|
667
|
+
// number | Maximum number of results to return (optional)
|
|
668
|
+
limit: 8.14,
|
|
669
|
+
// number | Pagination offset — number of results to skip (optional)
|
|
670
|
+
offset: 8.14,
|
|
671
|
+
// 'volume' | 'liquidity' | 'newest' | Sort order for results (optional)
|
|
668
672
|
sort: sort_example,
|
|
669
|
-
//
|
|
670
|
-
limit: 56,
|
|
671
|
-
// number (optional)
|
|
672
|
-
offset: 56,
|
|
673
|
-
// 'active' | 'closed' | 'all' | Filter by event status (default: active) (optional)
|
|
673
|
+
// 'active' | 'inactive' | 'closed' | 'all' | Filter by event status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) (optional)
|
|
674
674
|
status: status_example,
|
|
675
|
-
// 'title' | 'description' | 'both' (optional)
|
|
675
|
+
// 'title' | 'description' | 'both' | Where to search (default: \'title\') (optional)
|
|
676
676
|
searchIn: searchIn_example,
|
|
677
677
|
// string | Direct lookup by event ID (optional)
|
|
678
678
|
eventId: eventId_example,
|
|
@@ -698,12 +698,12 @@ example().catch(console.error);
|
|
|
698
698
|
| Name | Type | Description | Notes |
|
|
699
699
|
|------------- | ------------- | ------------- | -------------|
|
|
700
700
|
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
|
|
701
|
-
| **query** | `string` |
|
|
702
|
-
| **
|
|
703
|
-
| **
|
|
704
|
-
| **
|
|
705
|
-
| **status** | `active`, `closed`, `all` | Filter by event status (default: active) | [Optional] [Defaults to `undefined`] [Enum: active, closed, all] |
|
|
706
|
-
| **searchIn** | `title`, `description`, `both` |
|
|
701
|
+
| **query** | `string` | For keyword search | [Optional] [Defaults to `undefined`] |
|
|
702
|
+
| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
|
|
703
|
+
| **offset** | `number` | Pagination offset — number of results to skip | [Optional] [Defaults to `undefined`] |
|
|
704
|
+
| **sort** | `volume`, `liquidity`, `newest` | Sort order for results | [Optional] [Defaults to `undefined`] [Enum: volume, liquidity, newest] |
|
|
705
|
+
| **status** | `active`, `inactive`, `closed`, `all` | Filter by event status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) | [Optional] [Defaults to `undefined`] [Enum: active, inactive, closed, all] |
|
|
706
|
+
| **searchIn** | `title`, `description`, `both` | Where to search (default: \'title\') | [Optional] [Defaults to `undefined`] [Enum: title, description, both] |
|
|
707
707
|
| **eventId** | `string` | Direct lookup by event ID | [Optional] [Defaults to `undefined`] |
|
|
708
708
|
| **slug** | `string` | Lookup by event slug | [Optional] [Defaults to `undefined`] |
|
|
709
709
|
|
|
@@ -753,19 +753,19 @@ async function example() {
|
|
|
753
753
|
const body = {
|
|
754
754
|
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | The prediction market exchange to target.
|
|
755
755
|
exchange: exchange_example,
|
|
756
|
-
// number (optional)
|
|
757
|
-
limit:
|
|
758
|
-
// number (optional)
|
|
759
|
-
offset:
|
|
760
|
-
// 'volume' | 'liquidity' | 'newest' (optional)
|
|
756
|
+
// number | Maximum number of results to return (optional)
|
|
757
|
+
limit: 8.14,
|
|
758
|
+
// number | Pagination offset — number of results to skip (optional)
|
|
759
|
+
offset: 8.14,
|
|
760
|
+
// 'volume' | 'liquidity' | 'newest' | Sort order for results (optional)
|
|
761
761
|
sort: sort_example,
|
|
762
|
-
// 'active' | 'closed' | 'all' | Filter by market status (default: active) (optional)
|
|
762
|
+
// 'active' | 'inactive' | 'closed' | 'all' | Filter by market status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) (optional)
|
|
763
763
|
status: status_example,
|
|
764
|
-
// 'title' | 'description' | 'both' (optional)
|
|
764
|
+
// 'title' | 'description' | 'both' | Where to search (default: \'title\') (optional)
|
|
765
765
|
searchIn: searchIn_example,
|
|
766
|
-
// string (optional)
|
|
766
|
+
// string | For keyword search (optional)
|
|
767
767
|
query: query_example,
|
|
768
|
-
// string (optional)
|
|
768
|
+
// string | For slug/ticker lookup (optional)
|
|
769
769
|
slug: slug_example,
|
|
770
770
|
// string | Direct lookup by market ID (optional)
|
|
771
771
|
marketId: marketId_example,
|
|
@@ -773,9 +773,9 @@ async function example() {
|
|
|
773
773
|
outcomeId: outcomeId_example,
|
|
774
774
|
// string | Find markets belonging to an event (optional)
|
|
775
775
|
eventId: eventId_example,
|
|
776
|
-
// number (optional)
|
|
777
|
-
page:
|
|
778
|
-
// number (optional)
|
|
776
|
+
// number | For pagination (used by Limitless) (optional)
|
|
777
|
+
page: 8.14,
|
|
778
|
+
// number | For semantic search (used by Limitless) (optional)
|
|
779
779
|
similarityThreshold: 8.14,
|
|
780
780
|
} satisfies FetchMarketRequest;
|
|
781
781
|
|
|
@@ -797,18 +797,18 @@ example().catch(console.error);
|
|
|
797
797
|
| Name | Type | Description | Notes |
|
|
798
798
|
|------------- | ------------- | ------------- | -------------|
|
|
799
799
|
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
|
|
800
|
-
| **limit** | `number` |
|
|
801
|
-
| **offset** | `number` |
|
|
802
|
-
| **sort** | `volume`, `liquidity`, `newest` |
|
|
803
|
-
| **status** | `active`, `closed`, `all` | Filter by market status (default: active) | [Optional] [Defaults to `undefined`] [Enum: active, closed, all] |
|
|
804
|
-
| **searchIn** | `title`, `description`, `both` |
|
|
805
|
-
| **query** | `string` |
|
|
806
|
-
| **slug** | `string` |
|
|
800
|
+
| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
|
|
801
|
+
| **offset** | `number` | Pagination offset — number of results to skip | [Optional] [Defaults to `undefined`] |
|
|
802
|
+
| **sort** | `volume`, `liquidity`, `newest` | Sort order for results | [Optional] [Defaults to `undefined`] [Enum: volume, liquidity, newest] |
|
|
803
|
+
| **status** | `active`, `inactive`, `closed`, `all` | Filter by market status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) | [Optional] [Defaults to `undefined`] [Enum: active, inactive, closed, all] |
|
|
804
|
+
| **searchIn** | `title`, `description`, `both` | Where to search (default: \'title\') | [Optional] [Defaults to `undefined`] [Enum: title, description, both] |
|
|
805
|
+
| **query** | `string` | For keyword search | [Optional] [Defaults to `undefined`] |
|
|
806
|
+
| **slug** | `string` | For slug/ticker lookup | [Optional] [Defaults to `undefined`] |
|
|
807
807
|
| **marketId** | `string` | Direct lookup by market ID | [Optional] [Defaults to `undefined`] |
|
|
808
808
|
| **outcomeId** | `string` | Reverse lookup -- find market containing this outcome | [Optional] [Defaults to `undefined`] |
|
|
809
809
|
| **eventId** | `string` | Find markets belonging to an event | [Optional] [Defaults to `undefined`] |
|
|
810
|
-
| **page** | `number` |
|
|
811
|
-
| **similarityThreshold** | `number` |
|
|
810
|
+
| **page** | `number` | For pagination (used by Limitless) | [Optional] [Defaults to `undefined`] |
|
|
811
|
+
| **similarityThreshold** | `number` | For semantic search (used by Limitless) | [Optional] [Defaults to `undefined`] |
|
|
812
812
|
|
|
813
813
|
### Return type
|
|
814
814
|
|
|
@@ -856,19 +856,19 @@ async function example() {
|
|
|
856
856
|
const body = {
|
|
857
857
|
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | The prediction market exchange to target.
|
|
858
858
|
exchange: exchange_example,
|
|
859
|
-
// number (optional)
|
|
860
|
-
limit:
|
|
861
|
-
// number (optional)
|
|
862
|
-
offset:
|
|
863
|
-
// 'volume' | 'liquidity' | 'newest' (optional)
|
|
859
|
+
// number | Maximum number of results to return (optional)
|
|
860
|
+
limit: 8.14,
|
|
861
|
+
// number | Pagination offset — number of results to skip (optional)
|
|
862
|
+
offset: 8.14,
|
|
863
|
+
// 'volume' | 'liquidity' | 'newest' | Sort order for results (optional)
|
|
864
864
|
sort: sort_example,
|
|
865
|
-
// 'active' | 'closed' | 'all' | Filter by market status (default: active) (optional)
|
|
865
|
+
// 'active' | 'inactive' | 'closed' | 'all' | Filter by market status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) (optional)
|
|
866
866
|
status: status_example,
|
|
867
|
-
// 'title' | 'description' | 'both' (optional)
|
|
867
|
+
// 'title' | 'description' | 'both' | Where to search (default: \'title\') (optional)
|
|
868
868
|
searchIn: searchIn_example,
|
|
869
|
-
// string (optional)
|
|
869
|
+
// string | For keyword search (optional)
|
|
870
870
|
query: query_example,
|
|
871
|
-
// string (optional)
|
|
871
|
+
// string | For slug/ticker lookup (optional)
|
|
872
872
|
slug: slug_example,
|
|
873
873
|
// string | Direct lookup by market ID (optional)
|
|
874
874
|
marketId: marketId_example,
|
|
@@ -876,9 +876,9 @@ async function example() {
|
|
|
876
876
|
outcomeId: outcomeId_example,
|
|
877
877
|
// string | Find markets belonging to an event (optional)
|
|
878
878
|
eventId: eventId_example,
|
|
879
|
-
// number (optional)
|
|
880
|
-
page:
|
|
881
|
-
// number (optional)
|
|
879
|
+
// number | For pagination (used by Limitless) (optional)
|
|
880
|
+
page: 8.14,
|
|
881
|
+
// number | For semantic search (used by Limitless) (optional)
|
|
882
882
|
similarityThreshold: 8.14,
|
|
883
883
|
} satisfies FetchMarketsRequest;
|
|
884
884
|
|
|
@@ -900,18 +900,18 @@ example().catch(console.error);
|
|
|
900
900
|
| Name | Type | Description | Notes |
|
|
901
901
|
|------------- | ------------- | ------------- | -------------|
|
|
902
902
|
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
|
|
903
|
-
| **limit** | `number` |
|
|
904
|
-
| **offset** | `number` |
|
|
905
|
-
| **sort** | `volume`, `liquidity`, `newest` |
|
|
906
|
-
| **status** | `active`, `closed`, `all` | Filter by market status (default: active) | [Optional] [Defaults to `undefined`] [Enum: active, closed, all] |
|
|
907
|
-
| **searchIn** | `title`, `description`, `both` |
|
|
908
|
-
| **query** | `string` |
|
|
909
|
-
| **slug** | `string` |
|
|
903
|
+
| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
|
|
904
|
+
| **offset** | `number` | Pagination offset — number of results to skip | [Optional] [Defaults to `undefined`] |
|
|
905
|
+
| **sort** | `volume`, `liquidity`, `newest` | Sort order for results | [Optional] [Defaults to `undefined`] [Enum: volume, liquidity, newest] |
|
|
906
|
+
| **status** | `active`, `inactive`, `closed`, `all` | Filter by market status (default: \'active\', \'inactive\' and \'closed\' are interchangeable) | [Optional] [Defaults to `undefined`] [Enum: active, inactive, closed, all] |
|
|
907
|
+
| **searchIn** | `title`, `description`, `both` | Where to search (default: \'title\') | [Optional] [Defaults to `undefined`] [Enum: title, description, both] |
|
|
908
|
+
| **query** | `string` | For keyword search | [Optional] [Defaults to `undefined`] |
|
|
909
|
+
| **slug** | `string` | For slug/ticker lookup | [Optional] [Defaults to `undefined`] |
|
|
910
910
|
| **marketId** | `string` | Direct lookup by market ID | [Optional] [Defaults to `undefined`] |
|
|
911
911
|
| **outcomeId** | `string` | Reverse lookup -- find market containing this outcome | [Optional] [Defaults to `undefined`] |
|
|
912
912
|
| **eventId** | `string` | Find markets belonging to an event | [Optional] [Defaults to `undefined`] |
|
|
913
|
-
| **page** | `number` |
|
|
914
|
-
| **similarityThreshold** | `number` |
|
|
913
|
+
| **page** | `number` | For pagination (used by Limitless) | [Optional] [Defaults to `undefined`] |
|
|
914
|
+
| **similarityThreshold** | `number` | For semantic search (used by Limitless) | [Optional] [Defaults to `undefined`] |
|
|
915
915
|
|
|
916
916
|
### Return type
|
|
917
917
|
|
|
@@ -1030,17 +1030,17 @@ async function example() {
|
|
|
1030
1030
|
const body = {
|
|
1031
1031
|
// 'polymarket' | 'kalshi' | 'kalshi-demo' | 'limitless' | 'probable' | 'baozi' | 'myriad' | 'opinion' | 'metaculus' | 'smarkets' | 'polymarket_us' | The prediction market exchange to target.
|
|
1032
1032
|
exchange: exchange_example,
|
|
1033
|
-
// string |
|
|
1033
|
+
// string | filter to specific outcome/ticker (optional)
|
|
1034
1034
|
outcomeId: outcomeId_example,
|
|
1035
|
-
// string |
|
|
1035
|
+
// string | filter to specific market (optional)
|
|
1036
1036
|
marketId: marketId_example,
|
|
1037
|
-
// Date (optional)
|
|
1037
|
+
// Date | Only return records after this date (optional)
|
|
1038
1038
|
since: 2013-10-20T19:20:30+01:00,
|
|
1039
|
-
// Date (optional)
|
|
1039
|
+
// Date | Only return records before this date (optional)
|
|
1040
1040
|
until: 2013-10-20T19:20:30+01:00,
|
|
1041
|
-
// number (optional)
|
|
1042
|
-
limit:
|
|
1043
|
-
// string |
|
|
1041
|
+
// number | Maximum number of results to return (optional)
|
|
1042
|
+
limit: 8.14,
|
|
1043
|
+
// string | for Kalshi cursor pagination (optional)
|
|
1044
1044
|
cursor: cursor_example,
|
|
1045
1045
|
} satisfies FetchMyTradesRequest;
|
|
1046
1046
|
|
|
@@ -1062,12 +1062,12 @@ example().catch(console.error);
|
|
|
1062
1062
|
| Name | Type | Description | Notes |
|
|
1063
1063
|
|------------- | ------------- | ------------- | -------------|
|
|
1064
1064
|
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
|
|
1065
|
-
| **outcomeId** | `string` |
|
|
1066
|
-
| **marketId** | `string` |
|
|
1067
|
-
| **since** | `Date` |
|
|
1068
|
-
| **until** | `Date` |
|
|
1069
|
-
| **limit** | `number` |
|
|
1070
|
-
| **cursor** | `string` |
|
|
1065
|
+
| **outcomeId** | `string` | filter to specific outcome/ticker | [Optional] [Defaults to `undefined`] |
|
|
1066
|
+
| **marketId** | `string` | filter to specific market | [Optional] [Defaults to `undefined`] |
|
|
1067
|
+
| **since** | `Date` | Only return records after this date | [Optional] [Defaults to `undefined`] |
|
|
1068
|
+
| **until** | `Date` | Only return records before this date | [Optional] [Defaults to `undefined`] |
|
|
1069
|
+
| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
|
|
1070
|
+
| **cursor** | `string` | for Kalshi cursor pagination | [Optional] [Defaults to `undefined`] |
|
|
1071
1071
|
|
|
1072
1072
|
### Return type
|
|
1073
1073
|
|
|
@@ -1117,14 +1117,14 @@ async function example() {
|
|
|
1117
1117
|
exchange: exchange_example,
|
|
1118
1118
|
// string
|
|
1119
1119
|
id: id_example,
|
|
1120
|
-
// '1m' | '5m' | '15m' | '1h' | '6h' | '1d' |
|
|
1120
|
+
// '1m' | '5m' | '15m' | '1h' | '6h' | '1d' | Required for candle aggregation (optional)
|
|
1121
1121
|
resolution: resolution_example,
|
|
1122
|
-
// Date (optional)
|
|
1122
|
+
// Date | Start of the time range (optional)
|
|
1123
1123
|
start: 2013-10-20T19:20:30+01:00,
|
|
1124
|
-
// Date (optional)
|
|
1124
|
+
// Date | End of the time range (optional)
|
|
1125
1125
|
end: 2013-10-20T19:20:30+01:00,
|
|
1126
|
-
// number (optional)
|
|
1127
|
-
limit:
|
|
1126
|
+
// number | Maximum number of results to return (optional)
|
|
1127
|
+
limit: 8.14,
|
|
1128
1128
|
} satisfies FetchOHLCVRequest;
|
|
1129
1129
|
|
|
1130
1130
|
try {
|
|
@@ -1146,10 +1146,10 @@ example().catch(console.error);
|
|
|
1146
1146
|
|------------- | ------------- | ------------- | -------------|
|
|
1147
1147
|
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
|
|
1148
1148
|
| **id** | `string` | | [Defaults to `undefined`] |
|
|
1149
|
-
| **resolution** | `1m`, `5m`, `15m`, `1h`, `6h`, `1d` |
|
|
1150
|
-
| **start** | `Date` |
|
|
1151
|
-
| **end** | `Date` |
|
|
1152
|
-
| **limit** | `number` |
|
|
1149
|
+
| **resolution** | `1m`, `5m`, `15m`, `1h`, `6h`, `1d` | Required for candle aggregation | [Optional] [Defaults to `undefined`] [Enum: 1m, 5m, 15m, 1h, 6h, 1d] |
|
|
1150
|
+
| **start** | `Date` | Start of the time range | [Optional] [Defaults to `undefined`] |
|
|
1151
|
+
| **end** | `Date` | End of the time range | [Optional] [Defaults to `undefined`] |
|
|
1152
|
+
| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
|
|
1153
1153
|
|
|
1154
1154
|
### Return type
|
|
1155
1155
|
|
|
@@ -1479,12 +1479,12 @@ async function example() {
|
|
|
1479
1479
|
exchange: exchange_example,
|
|
1480
1480
|
// string
|
|
1481
1481
|
id: id_example,
|
|
1482
|
-
// Date (optional)
|
|
1482
|
+
// Date | Start of the time range (optional)
|
|
1483
1483
|
start: 2013-10-20T19:20:30+01:00,
|
|
1484
|
-
// Date (optional)
|
|
1484
|
+
// Date | End of the time range (optional)
|
|
1485
1485
|
end: 2013-10-20T19:20:30+01:00,
|
|
1486
|
-
// number (optional)
|
|
1487
|
-
limit:
|
|
1486
|
+
// number | Maximum number of results to return (optional)
|
|
1487
|
+
limit: 8.14,
|
|
1488
1488
|
} satisfies FetchTradesRequest;
|
|
1489
1489
|
|
|
1490
1490
|
try {
|
|
@@ -1506,9 +1506,9 @@ example().catch(console.error);
|
|
|
1506
1506
|
|------------- | ------------- | ------------- | -------------|
|
|
1507
1507
|
| **exchange** | `polymarket`, `kalshi`, `kalshi-demo`, `limitless`, `probable`, `baozi`, `myriad`, `opinion`, `metaculus`, `smarkets`, `polymarket_us` | The prediction market exchange to target. | [Defaults to `undefined`] [Enum: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us] |
|
|
1508
1508
|
| **id** | `string` | | [Defaults to `undefined`] |
|
|
1509
|
-
| **start** | `Date` |
|
|
1510
|
-
| **end** | `Date` |
|
|
1511
|
-
| **limit** | `number` |
|
|
1509
|
+
| **start** | `Date` | Start of the time range | [Optional] [Defaults to `undefined`] |
|
|
1510
|
+
| **end** | `Date` | End of the time range | [Optional] [Defaults to `undefined`] |
|
|
1511
|
+
| **limit** | `number` | Maximum number of results to return | [Optional] [Defaults to `undefined`] |
|
|
1512
1512
|
|
|
1513
1513
|
### Return type
|
|
1514
1514
|
|
|
@@ -7,9 +7,9 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`query` | string
|
|
10
|
-
`sort` | string
|
|
11
10
|
`limit` | number
|
|
12
11
|
`offset` | number
|
|
12
|
+
`sort` | string
|
|
13
13
|
`status` | string
|
|
14
14
|
`searchIn` | string
|
|
15
15
|
`eventId` | string
|
|
@@ -23,9 +23,9 @@ import type { EventFetchParams } from 'pmxtjs'
|
|
|
23
23
|
// TODO: Update the object below with actual values
|
|
24
24
|
const example = {
|
|
25
25
|
"query": null,
|
|
26
|
-
"sort": null,
|
|
27
26
|
"limit": null,
|
|
28
27
|
"offset": null,
|
|
28
|
+
"sort": null,
|
|
29
29
|
"status": null,
|
|
30
30
|
"searchIn": null,
|
|
31
31
|
"eventId": null,
|
|
@@ -1,18 +1,19 @@
|
|
|
1
1
|
|
|
2
2
|
# ExchangeCredentials
|
|
3
3
|
|
|
4
|
-
Optional authentication credentials for exchange operations
|
|
4
|
+
Optional authentication credentials for exchange operations.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`apiKey` | string
|
|
11
|
-
`privateKey` | string
|
|
12
11
|
`apiSecret` | string
|
|
13
12
|
`passphrase` | string
|
|
14
|
-
`
|
|
13
|
+
`apiToken` | string
|
|
14
|
+
`privateKey` | string
|
|
15
15
|
`signatureType` | [ExchangeCredentialsSignatureType](ExchangeCredentialsSignatureType.md)
|
|
16
|
+
`funderAddress` | string
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -22,11 +23,12 @@ import type { ExchangeCredentials } from 'pmxtjs'
|
|
|
22
23
|
// TODO: Update the object below with actual values
|
|
23
24
|
const example = {
|
|
24
25
|
"apiKey": null,
|
|
25
|
-
"privateKey": null,
|
|
26
26
|
"apiSecret": null,
|
|
27
27
|
"passphrase": null,
|
|
28
|
-
"
|
|
28
|
+
"apiToken": null,
|
|
29
|
+
"privateKey": null,
|
|
29
30
|
"signatureType": null,
|
|
31
|
+
"funderAddress": null,
|
|
30
32
|
} satisfies ExchangeCredentials
|
|
31
33
|
|
|
32
34
|
console.log(example)
|
|
@@ -6,6 +6,12 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`text` | string
|
|
10
|
+
`searchIn` | Array<string>
|
|
11
|
+
`category` | string
|
|
12
|
+
`tags` | Array<string>
|
|
13
|
+
`marketCount` | [FilterMarketsRequestArgsInnerOneOfVolume24h](FilterMarketsRequestArgsInnerOneOfVolume24h.md)
|
|
14
|
+
`totalVolume` | [FilterMarketsRequestArgsInnerOneOfVolume24h](FilterMarketsRequestArgsInnerOneOfVolume24h.md)
|
|
9
15
|
|
|
10
16
|
## Example
|
|
11
17
|
|
|
@@ -14,6 +20,12 @@ import type { FilterEventsRequestArgsInner } from 'pmxtjs'
|
|
|
14
20
|
|
|
15
21
|
// TODO: Update the object below with actual values
|
|
16
22
|
const example = {
|
|
23
|
+
"text": null,
|
|
24
|
+
"searchIn": null,
|
|
25
|
+
"category": null,
|
|
26
|
+
"tags": null,
|
|
27
|
+
"marketCount": null,
|
|
28
|
+
"totalVolume": null,
|
|
17
29
|
} satisfies FilterEventsRequestArgsInner
|
|
18
30
|
|
|
19
31
|
console.log(example)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
|
|
2
|
+
# FilterEventsRequestArgsInnerOneOf
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`text` | string
|
|
10
|
+
`searchIn` | Array<string>
|
|
11
|
+
`category` | string
|
|
12
|
+
`tags` | Array<string>
|
|
13
|
+
`marketCount` | [FilterMarketsRequestArgsInnerOneOfVolume24h](FilterMarketsRequestArgsInnerOneOfVolume24h.md)
|
|
14
|
+
`totalVolume` | [FilterMarketsRequestArgsInnerOneOfVolume24h](FilterMarketsRequestArgsInnerOneOfVolume24h.md)
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { FilterEventsRequestArgsInnerOneOf } from 'pmxtjs'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"text": null,
|
|
24
|
+
"searchIn": null,
|
|
25
|
+
"category": null,
|
|
26
|
+
"tags": null,
|
|
27
|
+
"marketCount": null,
|
|
28
|
+
"totalVolume": null,
|
|
29
|
+
} satisfies FilterEventsRequestArgsInnerOneOf
|
|
30
|
+
|
|
31
|
+
console.log(example)
|
|
32
|
+
|
|
33
|
+
// Convert the instance to a JSON string
|
|
34
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
35
|
+
console.log(exampleJSON)
|
|
36
|
+
|
|
37
|
+
// Parse the JSON string back to an object
|
|
38
|
+
const exampleParsed = JSON.parse(exampleJSON) as FilterEventsRequestArgsInnerOneOf
|
|
39
|
+
console.log(exampleParsed)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
43
|
+
|
|
44
|
+
|
|
@@ -6,6 +6,17 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`text` | string
|
|
10
|
+
`searchIn` | Array<string>
|
|
11
|
+
`volume24h` | [FilterMarketsRequestArgsInnerOneOfVolume24h](FilterMarketsRequestArgsInnerOneOfVolume24h.md)
|
|
12
|
+
`volume` | [FilterMarketsRequestArgsInnerOneOfVolume24h](FilterMarketsRequestArgsInnerOneOfVolume24h.md)
|
|
13
|
+
`liquidity` | [FilterMarketsRequestArgsInnerOneOfVolume24h](FilterMarketsRequestArgsInnerOneOfVolume24h.md)
|
|
14
|
+
`openInterest` | [FilterMarketsRequestArgsInnerOneOfVolume24h](FilterMarketsRequestArgsInnerOneOfVolume24h.md)
|
|
15
|
+
`resolutionDate` | [FilterMarketsRequestArgsInnerOneOfResolutionDate](FilterMarketsRequestArgsInnerOneOfResolutionDate.md)
|
|
16
|
+
`category` | string
|
|
17
|
+
`tags` | Array<string>
|
|
18
|
+
`price` | [FilterMarketsRequestArgsInnerOneOfPrice](FilterMarketsRequestArgsInnerOneOfPrice.md)
|
|
19
|
+
`priceChange24h` | [FilterMarketsRequestArgsInnerOneOfPrice](FilterMarketsRequestArgsInnerOneOfPrice.md)
|
|
9
20
|
|
|
10
21
|
## Example
|
|
11
22
|
|
|
@@ -14,6 +25,17 @@ import type { FilterMarketsRequestArgsInner } from 'pmxtjs'
|
|
|
14
25
|
|
|
15
26
|
// TODO: Update the object below with actual values
|
|
16
27
|
const example = {
|
|
28
|
+
"text": null,
|
|
29
|
+
"searchIn": null,
|
|
30
|
+
"volume24h": null,
|
|
31
|
+
"volume": null,
|
|
32
|
+
"liquidity": null,
|
|
33
|
+
"openInterest": null,
|
|
34
|
+
"resolutionDate": null,
|
|
35
|
+
"category": null,
|
|
36
|
+
"tags": null,
|
|
37
|
+
"price": null,
|
|
38
|
+
"priceChange24h": null,
|
|
17
39
|
} satisfies FilterMarketsRequestArgsInner
|
|
18
40
|
|
|
19
41
|
console.log(example)
|