pmxtjs 2.43.12 → 2.43.14
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 +1 -0
- package/dist/esm/generated/src/apis/DefaultApi.js +3 -0
- package/dist/esm/generated/src/models/FetchOrderBookParams.d.ts +6 -0
- package/dist/esm/generated/src/models/FetchOrderBookParams.js +2 -0
- package/dist/esm/pmxt/models.d.ts +2 -0
- package/dist/generated/src/apis/DefaultApi.d.ts +1 -0
- package/dist/generated/src/apis/DefaultApi.js +3 -0
- package/dist/generated/src/models/FetchOrderBookParams.d.ts +6 -0
- package/dist/generated/src/models/FetchOrderBookParams.js +2 -0
- package/dist/pmxt/models.d.ts +2 -0
- package/generated/docs/DefaultApi.md +4 -1
- package/generated/docs/FetchOrderBookParams.md +2 -0
- package/generated/package.json +1 -1
- package/generated/src/apis/DefaultApi.ts +5 -0
- package/generated/src/models/FetchOrderBookParams.ts +8 -0
- package/package.json +2 -2
- package/pmxt/models.ts +2 -0
|
@@ -1083,6 +1083,9 @@ export class DefaultApi extends runtime.BaseAPI {
|
|
|
1083
1083
|
if (requestParameters['side'] != null) {
|
|
1084
1084
|
queryParameters['side'] = requestParameters['side'];
|
|
1085
1085
|
}
|
|
1086
|
+
if (requestParameters['outcome'] != null) {
|
|
1087
|
+
queryParameters['outcome'] = requestParameters['outcome'];
|
|
1088
|
+
}
|
|
1086
1089
|
if (requestParameters['since'] != null) {
|
|
1087
1090
|
queryParameters['since'] = requestParameters['since'];
|
|
1088
1091
|
}
|
|
@@ -21,6 +21,12 @@ export interface FetchOrderBookParams {
|
|
|
21
21
|
* @memberof FetchOrderBookParams
|
|
22
22
|
*/
|
|
23
23
|
side?: FetchOrderBookParamsSideEnum;
|
|
24
|
+
/**
|
|
25
|
+
* Outcome alias: 'yes' or 'no', or an outcome token ID. When set, the first argument is treated as a market ID and this value selects which outcome's order book to fetch. Accepts the literal strings 'yes'/'no' (resolved via a market lookup) or a raw outcome token ID.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof FetchOrderBookParams
|
|
28
|
+
*/
|
|
29
|
+
outcome?: string;
|
|
24
30
|
/**
|
|
25
31
|
* Unix timestamp (ms) — fetch a historical snapshot at or before this time, or the start of a range when combined with `until` (hosted API only).
|
|
26
32
|
* @type {number}
|
|
@@ -33,6 +33,7 @@ export function FetchOrderBookParamsFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
33
33
|
}
|
|
34
34
|
return {
|
|
35
35
|
'side': json['side'] == null ? undefined : json['side'],
|
|
36
|
+
'outcome': json['outcome'] == null ? undefined : json['outcome'],
|
|
36
37
|
'since': json['since'] == null ? undefined : json['since'],
|
|
37
38
|
'until': json['until'] == null ? undefined : json['until'],
|
|
38
39
|
};
|
|
@@ -46,6 +47,7 @@ export function FetchOrderBookParamsToJSONTyped(value, ignoreDiscriminator = fal
|
|
|
46
47
|
}
|
|
47
48
|
return {
|
|
48
49
|
'side': value['side'],
|
|
50
|
+
'outcome': value['outcome'],
|
|
49
51
|
'since': value['since'],
|
|
50
52
|
'until': value['until'],
|
|
51
53
|
};
|
|
@@ -395,6 +395,8 @@ export interface TradesParams {
|
|
|
395
395
|
export interface FetchOrderBookParams {
|
|
396
396
|
/** Outcome side: 'yes' or 'no' (for exchanges like Limitless) */
|
|
397
397
|
side?: 'yes' | 'no';
|
|
398
|
+
/** Outcome alias: 'yes' or 'no', or a raw outcome token ID */
|
|
399
|
+
outcome?: string;
|
|
398
400
|
/** Unix timestamp (ms) — historical snapshot at or before this time */
|
|
399
401
|
since?: number;
|
|
400
402
|
/** Unix timestamp (ms) — end of range. With `since`, returns OrderBook[] */
|
|
@@ -1120,6 +1120,9 @@ class DefaultApi extends runtime.BaseAPI {
|
|
|
1120
1120
|
if (requestParameters['side'] != null) {
|
|
1121
1121
|
queryParameters['side'] = requestParameters['side'];
|
|
1122
1122
|
}
|
|
1123
|
+
if (requestParameters['outcome'] != null) {
|
|
1124
|
+
queryParameters['outcome'] = requestParameters['outcome'];
|
|
1125
|
+
}
|
|
1123
1126
|
if (requestParameters['since'] != null) {
|
|
1124
1127
|
queryParameters['since'] = requestParameters['since'];
|
|
1125
1128
|
}
|
|
@@ -21,6 +21,12 @@ export interface FetchOrderBookParams {
|
|
|
21
21
|
* @memberof FetchOrderBookParams
|
|
22
22
|
*/
|
|
23
23
|
side?: FetchOrderBookParamsSideEnum;
|
|
24
|
+
/**
|
|
25
|
+
* Outcome alias: 'yes' or 'no', or an outcome token ID. When set, the first argument is treated as a market ID and this value selects which outcome's order book to fetch. Accepts the literal strings 'yes'/'no' (resolved via a market lookup) or a raw outcome token ID.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof FetchOrderBookParams
|
|
28
|
+
*/
|
|
29
|
+
outcome?: string;
|
|
24
30
|
/**
|
|
25
31
|
* Unix timestamp (ms) — fetch a historical snapshot at or before this time, or the start of a range when combined with `until` (hosted API only).
|
|
26
32
|
* @type {number}
|
|
@@ -41,6 +41,7 @@ function FetchOrderBookParamsFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
41
41
|
}
|
|
42
42
|
return {
|
|
43
43
|
'side': json['side'] == null ? undefined : json['side'],
|
|
44
|
+
'outcome': json['outcome'] == null ? undefined : json['outcome'],
|
|
44
45
|
'since': json['since'] == null ? undefined : json['since'],
|
|
45
46
|
'until': json['until'] == null ? undefined : json['until'],
|
|
46
47
|
};
|
|
@@ -54,6 +55,7 @@ function FetchOrderBookParamsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
54
55
|
}
|
|
55
56
|
return {
|
|
56
57
|
'side': value['side'],
|
|
58
|
+
'outcome': value['outcome'],
|
|
57
59
|
'since': value['since'],
|
|
58
60
|
'until': value['until'],
|
|
59
61
|
};
|
package/dist/pmxt/models.d.ts
CHANGED
|
@@ -395,6 +395,8 @@ export interface TradesParams {
|
|
|
395
395
|
export interface FetchOrderBookParams {
|
|
396
396
|
/** Outcome side: 'yes' or 'no' (for exchanges like Limitless) */
|
|
397
397
|
side?: 'yes' | 'no';
|
|
398
|
+
/** Outcome alias: 'yes' or 'no', or a raw outcome token ID */
|
|
399
|
+
outcome?: string;
|
|
398
400
|
/** Unix timestamp (ms) — historical snapshot at or before this time */
|
|
399
401
|
since?: number;
|
|
400
402
|
/** Unix timestamp (ms) — end of range. With `since`, returns OrderBook[] */
|
|
@@ -2017,7 +2017,7 @@ No authorization required
|
|
|
2017
2017
|
|
|
2018
2018
|
## fetchOrderBook
|
|
2019
2019
|
|
|
2020
|
-
> FetchOrderBook200Response fetchOrderBook(exchange, outcomeId, limit, side, since, until)
|
|
2020
|
+
> FetchOrderBook200Response fetchOrderBook(exchange, outcomeId, limit, side, outcome, since, until)
|
|
2021
2021
|
|
|
2022
2022
|
Fetch Order Book
|
|
2023
2023
|
|
|
@@ -2045,6 +2045,8 @@ async function example() {
|
|
|
2045
2045
|
limit: 8.14,
|
|
2046
2046
|
// 'yes' | 'no' | Outcome side: \'yes\' or \'no\'. Required for exchanges like Limitless where the API returns a single orderbook per market. (optional)
|
|
2047
2047
|
side: side_example,
|
|
2048
|
+
// string | Outcome alias: \'yes\' or \'no\', or an outcome token ID. When set, the first argument is treated as a market ID and this value selects which outcome\'s order book to fetch. Accepts the literal strings \'yes\'/\'no\' (resolved via a market lookup) or a raw outcome token ID. (optional)
|
|
2049
|
+
outcome: outcome_example,
|
|
2048
2050
|
// number | Unix timestamp (ms) — fetch a historical snapshot at or before this time, or the start of a range when combined with `until` (hosted API only). (optional)
|
|
2049
2051
|
since: 8.14,
|
|
2050
2052
|
// number | Unix timestamp (ms) — end of a historical range. When combined with `since`, returns an array of reconstructed L2 OrderBook snapshots between `since` and `until` (hosted API only). (optional)
|
|
@@ -2072,6 +2074,7 @@ example().catch(console.error);
|
|
|
2072
2074
|
| **outcomeId** | `string` | | [Defaults to `undefined`] |
|
|
2073
2075
|
| **limit** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
2074
2076
|
| **side** | `yes`, `no` | Outcome side: \'yes\' or \'no\'. Required for exchanges like Limitless where the API returns a single orderbook per market. | [Optional] [Defaults to `undefined`] [Enum: yes, no] |
|
|
2077
|
+
| **outcome** | `string` | Outcome alias: \'yes\' or \'no\', or an outcome token ID. When set, the first argument is treated as a market ID and this value selects which outcome\'s order book to fetch. Accepts the literal strings \'yes\'/\'no\' (resolved via a market lookup) or a raw outcome token ID. | [Optional] [Defaults to `undefined`] |
|
|
2075
2078
|
| **since** | `number` | Unix timestamp (ms) — fetch a historical snapshot at or before this time, or the start of a range when combined with `until` (hosted API only). | [Optional] [Defaults to `undefined`] |
|
|
2076
2079
|
| **until** | `number` | Unix timestamp (ms) — end of a historical range. When combined with `since`, returns an array of reconstructed L2 OrderBook snapshots between `since` and `until` (hosted API only). | [Optional] [Defaults to `undefined`] |
|
|
2077
2080
|
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`side` | string
|
|
10
|
+
`outcome` | string
|
|
10
11
|
`since` | number
|
|
11
12
|
`until` | number
|
|
12
13
|
|
|
@@ -18,6 +19,7 @@ import type { FetchOrderBookParams } from 'pmxtjs'
|
|
|
18
19
|
// TODO: Update the object below with actual values
|
|
19
20
|
const example = {
|
|
20
21
|
"side": null,
|
|
22
|
+
"outcome": null,
|
|
21
23
|
"since": null,
|
|
22
24
|
"until": null,
|
|
23
25
|
} satisfies FetchOrderBookParams
|
package/generated/package.json
CHANGED
|
@@ -372,6 +372,7 @@ export interface FetchOrderBookRequest {
|
|
|
372
372
|
outcomeId: string;
|
|
373
373
|
limit?: number;
|
|
374
374
|
side?: FetchOrderBookSideEnum;
|
|
375
|
+
outcome?: string;
|
|
375
376
|
since?: number;
|
|
376
377
|
until?: number;
|
|
377
378
|
}
|
|
@@ -1921,6 +1922,10 @@ export class DefaultApi extends runtime.BaseAPI {
|
|
|
1921
1922
|
queryParameters['side'] = requestParameters['side'];
|
|
1922
1923
|
}
|
|
1923
1924
|
|
|
1925
|
+
if (requestParameters['outcome'] != null) {
|
|
1926
|
+
queryParameters['outcome'] = requestParameters['outcome'];
|
|
1927
|
+
}
|
|
1928
|
+
|
|
1924
1929
|
if (requestParameters['since'] != null) {
|
|
1925
1930
|
queryParameters['since'] = requestParameters['since'];
|
|
1926
1931
|
}
|
|
@@ -25,6 +25,12 @@ export interface FetchOrderBookParams {
|
|
|
25
25
|
* @memberof FetchOrderBookParams
|
|
26
26
|
*/
|
|
27
27
|
side?: FetchOrderBookParamsSideEnum;
|
|
28
|
+
/**
|
|
29
|
+
* Outcome alias: 'yes' or 'no', or an outcome token ID. When set, the first argument is treated as a market ID and this value selects which outcome's order book to fetch. Accepts the literal strings 'yes'/'no' (resolved via a market lookup) or a raw outcome token ID.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof FetchOrderBookParams
|
|
32
|
+
*/
|
|
33
|
+
outcome?: string;
|
|
28
34
|
/**
|
|
29
35
|
* Unix timestamp (ms) — fetch a historical snapshot at or before this time, or the start of a range when combined with `until` (hosted API only).
|
|
30
36
|
* @type {number}
|
|
@@ -68,6 +74,7 @@ export function FetchOrderBookParamsFromJSONTyped(json: any, ignoreDiscriminator
|
|
|
68
74
|
return {
|
|
69
75
|
|
|
70
76
|
'side': json['side'] == null ? undefined : json['side'],
|
|
77
|
+
'outcome': json['outcome'] == null ? undefined : json['outcome'],
|
|
71
78
|
'since': json['since'] == null ? undefined : json['since'],
|
|
72
79
|
'until': json['until'] == null ? undefined : json['until'],
|
|
73
80
|
};
|
|
@@ -85,6 +92,7 @@ export function FetchOrderBookParamsToJSONTyped(value?: FetchOrderBookParams | n
|
|
|
85
92
|
return {
|
|
86
93
|
|
|
87
94
|
'side': value['side'],
|
|
95
|
+
'outcome': value['outcome'],
|
|
88
96
|
'since': value['since'],
|
|
89
97
|
'until': value['until'],
|
|
90
98
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pmxtjs",
|
|
3
|
-
"version": "2.43.
|
|
3
|
+
"version": "2.43.14",
|
|
4
4
|
"description": "Unified prediction market data API - The ccxt for prediction markets",
|
|
5
5
|
"author": "PMXT Contributors",
|
|
6
6
|
"repository": {
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"unified"
|
|
44
44
|
],
|
|
45
45
|
"dependencies": {
|
|
46
|
-
"pmxt-core": "2.43.
|
|
46
|
+
"pmxt-core": "2.43.14",
|
|
47
47
|
"ws": "^8.18.0"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
package/pmxt/models.ts
CHANGED
|
@@ -528,6 +528,8 @@ export interface TradesParams {
|
|
|
528
528
|
export interface FetchOrderBookParams {
|
|
529
529
|
/** Outcome side: 'yes' or 'no' (for exchanges like Limitless) */
|
|
530
530
|
side?: 'yes' | 'no';
|
|
531
|
+
/** Outcome alias: 'yes' or 'no', or a raw outcome token ID */
|
|
532
|
+
outcome?: string;
|
|
531
533
|
/** Unix timestamp (ms) — historical snapshot at or before this time */
|
|
532
534
|
since?: number;
|
|
533
535
|
/** Unix timestamp (ms) — end of range. With `since`, returns OrderBook[] */
|