@structbuild/sdk 0.3.10-staging.0 → 0.3.10-staging.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/generated/polymarket.d.ts +885 -220
- package/dist/generated/webhooks.d.ts +575 -6
- package/dist/generated/ws-alerts.d.ts +2043 -1014
- package/dist/generated/ws.d.ts +1921 -41
- package/dist/index.cjs +23 -11
- package/dist/index.cjs.map +5 -5
- package/dist/index.js +23 -11
- package/dist/index.js.map +5 -5
- package/dist/namespaces/analytics.d.ts +7 -7
- package/dist/namespaces/events.d.ts +2 -1
- package/dist/namespaces/markets.d.ts +4 -1
- package/dist/types/index.d.ts +24 -7
- package/dist/types/ws.d.ts +10 -2
- package/package.json +1 -1
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Do not make direct changes to the file.
|
|
4
4
|
*/
|
|
5
5
|
export interface paths {
|
|
6
|
-
"/polymarket/analytics/
|
|
6
|
+
"/polymarket/analytics/changes": {
|
|
7
7
|
parameters: {
|
|
8
8
|
query?: never;
|
|
9
9
|
header?: never;
|
|
@@ -11,10 +11,10 @@ export interface paths {
|
|
|
11
11
|
cookie?: never;
|
|
12
12
|
};
|
|
13
13
|
/**
|
|
14
|
-
* Global analytics
|
|
15
|
-
* @description Returns
|
|
14
|
+
* Global analytics % change
|
|
15
|
+
* @description Returns % change for each metric over the requested lookback window. `null` fields mean the window predates the available data.
|
|
16
16
|
*/
|
|
17
|
-
get: operations["
|
|
17
|
+
get: operations["get_global_analytics_changes"];
|
|
18
18
|
put?: never;
|
|
19
19
|
post?: never;
|
|
20
20
|
delete?: never;
|
|
@@ -23,7 +23,7 @@ export interface paths {
|
|
|
23
23
|
patch?: never;
|
|
24
24
|
trace?: never;
|
|
25
25
|
};
|
|
26
|
-
"/polymarket/analytics/
|
|
26
|
+
"/polymarket/analytics/counts": {
|
|
27
27
|
parameters: {
|
|
28
28
|
query?: never;
|
|
29
29
|
header?: never;
|
|
@@ -31,10 +31,10 @@ export interface paths {
|
|
|
31
31
|
cookie?: never;
|
|
32
32
|
};
|
|
33
33
|
/**
|
|
34
|
-
* Global analytics
|
|
35
|
-
* @description Returns
|
|
34
|
+
* Global analytics snapshot
|
|
35
|
+
* @description Returns the latest cumulative analytics metrics across all of Polymarket: volume, traders, txn counts, fees, yes/no splits, and buy distribution.
|
|
36
36
|
*/
|
|
37
|
-
get: operations["
|
|
37
|
+
get: operations["get_analytics_counts"];
|
|
38
38
|
put?: never;
|
|
39
39
|
post?: never;
|
|
40
40
|
delete?: never;
|
|
@@ -43,7 +43,7 @@ export interface paths {
|
|
|
43
43
|
patch?: never;
|
|
44
44
|
trace?: never;
|
|
45
45
|
};
|
|
46
|
-
"/polymarket/analytics/
|
|
46
|
+
"/polymarket/analytics/deltas": {
|
|
47
47
|
parameters: {
|
|
48
48
|
query?: never;
|
|
49
49
|
header?: never;
|
|
@@ -51,10 +51,10 @@ export interface paths {
|
|
|
51
51
|
cookie?: never;
|
|
52
52
|
};
|
|
53
53
|
/**
|
|
54
|
-
* Global analytics
|
|
55
|
-
* @description Returns
|
|
54
|
+
* Global analytics candles (per-bucket deltas)
|
|
55
|
+
* @description Returns per-bucket deltas (volume, traders, fees etc. that happened *during* each bucket). Use for bar-chart visualisations of activity over time.
|
|
56
56
|
*/
|
|
57
|
-
get: operations["
|
|
57
|
+
get: operations["get_global_analytics_deltas"];
|
|
58
58
|
put?: never;
|
|
59
59
|
post?: never;
|
|
60
60
|
delete?: never;
|
|
@@ -203,7 +203,7 @@ export interface paths {
|
|
|
203
203
|
patch?: never;
|
|
204
204
|
trace?: never;
|
|
205
205
|
};
|
|
206
|
-
"/polymarket/events/
|
|
206
|
+
"/polymarket/events/top-traders": {
|
|
207
207
|
parameters: {
|
|
208
208
|
query?: never;
|
|
209
209
|
header?: never;
|
|
@@ -211,10 +211,10 @@ export interface paths {
|
|
|
211
211
|
cookie?: never;
|
|
212
212
|
};
|
|
213
213
|
/**
|
|
214
|
-
*
|
|
215
|
-
* @description
|
|
214
|
+
* Get top traders for an event
|
|
215
|
+
* @description Top traders ranked by realized PnL for a given event.
|
|
216
216
|
*/
|
|
217
|
-
get: operations["
|
|
217
|
+
get: operations["get_event_top_traders"];
|
|
218
218
|
put?: never;
|
|
219
219
|
post?: never;
|
|
220
220
|
delete?: never;
|
|
@@ -243,6 +243,26 @@ export interface paths {
|
|
|
243
243
|
patch?: never;
|
|
244
244
|
trace?: never;
|
|
245
245
|
};
|
|
246
|
+
"/polymarket/events/{event_slug}/analytics/deltas": {
|
|
247
|
+
parameters: {
|
|
248
|
+
query?: never;
|
|
249
|
+
header?: never;
|
|
250
|
+
path?: never;
|
|
251
|
+
cookie?: never;
|
|
252
|
+
};
|
|
253
|
+
/**
|
|
254
|
+
* Event analytics candles (per-bucket deltas)
|
|
255
|
+
* @description Returns per-bucket deltas for a specific event (what happened during each bucket).
|
|
256
|
+
*/
|
|
257
|
+
get: operations["get_event_analytics_deltas"];
|
|
258
|
+
put?: never;
|
|
259
|
+
post?: never;
|
|
260
|
+
delete?: never;
|
|
261
|
+
options?: never;
|
|
262
|
+
head?: never;
|
|
263
|
+
patch?: never;
|
|
264
|
+
trace?: never;
|
|
265
|
+
};
|
|
246
266
|
"/polymarket/events/{event_slug}/analytics/timeseries": {
|
|
247
267
|
parameters: {
|
|
248
268
|
query?: never;
|
|
@@ -292,7 +312,7 @@ export interface paths {
|
|
|
292
312
|
};
|
|
293
313
|
/**
|
|
294
314
|
* Get market holders
|
|
295
|
-
* @description Retrieve holders of a market grouped by outcome, sorted by shares held. Identify the market with either `condition_id` or `market_slug` — exactly one must be provided. Set `include_pnl=true` to include a nested holder `pnl` object.
|
|
315
|
+
* @description Retrieve holders of a market grouped by outcome, sorted by shares held. Identify the market with either `condition_id` or `market_slug` — exactly one must be provided. Set `include_pnl=true` to include a nested holder `pnl` object. Uses cursor-based pagination.
|
|
296
316
|
*/
|
|
297
317
|
get: operations["get_market_holders"];
|
|
298
318
|
put?: never;
|
|
@@ -392,7 +412,7 @@ export interface paths {
|
|
|
392
412
|
};
|
|
393
413
|
/**
|
|
394
414
|
* Get bonds
|
|
395
|
-
* @description Retrieve bond markets with sorting, probability range filter, and
|
|
415
|
+
* @description Retrieve bond markets with sorting, probability range filter, and deterministic keyset pagination.
|
|
396
416
|
*/
|
|
397
417
|
get: operations["get_bonds"];
|
|
398
418
|
put?: never;
|
|
@@ -463,6 +483,26 @@ export interface paths {
|
|
|
463
483
|
patch?: never;
|
|
464
484
|
trace?: never;
|
|
465
485
|
};
|
|
486
|
+
"/polymarket/market/oracle-events": {
|
|
487
|
+
parameters: {
|
|
488
|
+
query?: never;
|
|
489
|
+
header?: never;
|
|
490
|
+
path?: never;
|
|
491
|
+
cookie?: never;
|
|
492
|
+
};
|
|
493
|
+
/**
|
|
494
|
+
* List oracle events
|
|
495
|
+
* @description Retrieve on-chain oracle lifecycle events (resolutions, disputes, assertions, emergency resolutions). Filter by `condition_ids` or `event_types` and paginate with `limit`/`pagination_key`.
|
|
496
|
+
*/
|
|
497
|
+
get: operations["get_oracle_events"];
|
|
498
|
+
put?: never;
|
|
499
|
+
post?: never;
|
|
500
|
+
delete?: never;
|
|
501
|
+
options?: never;
|
|
502
|
+
head?: never;
|
|
503
|
+
patch?: never;
|
|
504
|
+
trace?: never;
|
|
505
|
+
};
|
|
466
506
|
"/polymarket/market/position/candlestick": {
|
|
467
507
|
parameters: {
|
|
468
508
|
query?: never;
|
|
@@ -503,6 +543,26 @@ export interface paths {
|
|
|
503
543
|
patch?: never;
|
|
504
544
|
trace?: never;
|
|
505
545
|
};
|
|
546
|
+
"/polymarket/market/position/top-traders": {
|
|
547
|
+
parameters: {
|
|
548
|
+
query?: never;
|
|
549
|
+
header?: never;
|
|
550
|
+
path?: never;
|
|
551
|
+
cookie?: never;
|
|
552
|
+
};
|
|
553
|
+
/**
|
|
554
|
+
* Get top traders for a position id / outcome
|
|
555
|
+
* @description Top traders ranked by realized PnL on a specific position (ERC1155 outcome token).
|
|
556
|
+
*/
|
|
557
|
+
get: operations["get_position_top_traders"];
|
|
558
|
+
put?: never;
|
|
559
|
+
post?: never;
|
|
560
|
+
delete?: never;
|
|
561
|
+
options?: never;
|
|
562
|
+
head?: never;
|
|
563
|
+
patch?: never;
|
|
564
|
+
trace?: never;
|
|
565
|
+
};
|
|
506
566
|
"/polymarket/market/position/volume-chart": {
|
|
507
567
|
parameters: {
|
|
508
568
|
query?: never;
|
|
@@ -563,6 +623,26 @@ export interface paths {
|
|
|
563
623
|
patch?: never;
|
|
564
624
|
trace?: never;
|
|
565
625
|
};
|
|
626
|
+
"/polymarket/market/top-traders": {
|
|
627
|
+
parameters: {
|
|
628
|
+
query?: never;
|
|
629
|
+
header?: never;
|
|
630
|
+
path?: never;
|
|
631
|
+
cookie?: never;
|
|
632
|
+
};
|
|
633
|
+
/**
|
|
634
|
+
* Get top traders for a market
|
|
635
|
+
* @description Top traders ranked by realized PnL for a given market (condition_id or market_slug).
|
|
636
|
+
*/
|
|
637
|
+
get: operations["get_market_top_traders"];
|
|
638
|
+
put?: never;
|
|
639
|
+
post?: never;
|
|
640
|
+
delete?: never;
|
|
641
|
+
options?: never;
|
|
642
|
+
head?: never;
|
|
643
|
+
patch?: never;
|
|
644
|
+
trace?: never;
|
|
645
|
+
};
|
|
566
646
|
"/polymarket/market/trades": {
|
|
567
647
|
parameters: {
|
|
568
648
|
query?: never;
|
|
@@ -623,7 +703,7 @@ export interface paths {
|
|
|
623
703
|
patch?: never;
|
|
624
704
|
trace?: never;
|
|
625
705
|
};
|
|
626
|
-
"/polymarket/market/{condition_id}/analytics/
|
|
706
|
+
"/polymarket/market/{condition_id}/analytics/changes": {
|
|
627
707
|
parameters: {
|
|
628
708
|
query?: never;
|
|
629
709
|
header?: never;
|
|
@@ -631,10 +711,10 @@ export interface paths {
|
|
|
631
711
|
cookie?: never;
|
|
632
712
|
};
|
|
633
713
|
/**
|
|
634
|
-
* Market analytics
|
|
635
|
-
* @description
|
|
714
|
+
* Market analytics % change
|
|
715
|
+
* @description Per-metric % change over the requested lookback window for a specific market.
|
|
636
716
|
*/
|
|
637
|
-
get: operations["
|
|
717
|
+
get: operations["get_market_analytics_changes"];
|
|
638
718
|
put?: never;
|
|
639
719
|
post?: never;
|
|
640
720
|
delete?: never;
|
|
@@ -643,7 +723,7 @@ export interface paths {
|
|
|
643
723
|
patch?: never;
|
|
644
724
|
trace?: never;
|
|
645
725
|
};
|
|
646
|
-
"/polymarket/market/{condition_id}/analytics/
|
|
726
|
+
"/polymarket/market/{condition_id}/analytics/deltas": {
|
|
647
727
|
parameters: {
|
|
648
728
|
query?: never;
|
|
649
729
|
header?: never;
|
|
@@ -651,10 +731,10 @@ export interface paths {
|
|
|
651
731
|
cookie?: never;
|
|
652
732
|
};
|
|
653
733
|
/**
|
|
654
|
-
* Market analytics
|
|
655
|
-
* @description
|
|
734
|
+
* Market analytics candles (per-bucket deltas)
|
|
735
|
+
* @description Returns per-bucket deltas for a specific market (what happened during each bucket).
|
|
656
736
|
*/
|
|
657
|
-
get: operations["
|
|
737
|
+
get: operations["get_market_analytics_deltas"];
|
|
658
738
|
put?: never;
|
|
659
739
|
post?: never;
|
|
660
740
|
delete?: never;
|
|
@@ -852,7 +932,7 @@ export interface paths {
|
|
|
852
932
|
};
|
|
853
933
|
/**
|
|
854
934
|
* Get tags
|
|
855
|
-
* @description Retrieve all available event tags/categories.
|
|
935
|
+
* @description Retrieve all available event tags/categories. Default listing is alphabetical (cursor-paginated). If either `sort` or `timeframe` is provided, the listing is ranked by the chosen metric+window (offset-paginated): sort defaults to `volume` when only `timeframe` is set, timeframe defaults to `24h` when only `sort` is set.
|
|
856
936
|
*/
|
|
857
937
|
get: operations["get_tags"];
|
|
858
938
|
put?: never;
|
|
@@ -872,7 +952,7 @@ export interface paths {
|
|
|
872
952
|
};
|
|
873
953
|
/**
|
|
874
954
|
* Get tag by slug
|
|
875
|
-
* @description Retrieve a single tag by its ID or slug
|
|
955
|
+
* @description Retrieve a single tag by its ID or slug. Pass `include_metrics=true` to attach analytics metrics (volume_usd, txn_count, unique_traders, fees_usd) — adds +1 credit. Use `timeframe` to select the window; defaults to `1d`.
|
|
876
956
|
*/
|
|
877
957
|
get: operations["get_tag_by_id"];
|
|
878
958
|
put?: never;
|
|
@@ -883,7 +963,7 @@ export interface paths {
|
|
|
883
963
|
patch?: never;
|
|
884
964
|
trace?: never;
|
|
885
965
|
};
|
|
886
|
-
"/polymarket/tags/{tag}/analytics/
|
|
966
|
+
"/polymarket/tags/{tag}/analytics/changes": {
|
|
887
967
|
parameters: {
|
|
888
968
|
query?: never;
|
|
889
969
|
header?: never;
|
|
@@ -891,10 +971,10 @@ export interface paths {
|
|
|
891
971
|
cookie?: never;
|
|
892
972
|
};
|
|
893
973
|
/**
|
|
894
|
-
* Tag analytics
|
|
895
|
-
* @description
|
|
974
|
+
* Tag analytics % change
|
|
975
|
+
* @description Per-metric % change over the requested lookback window for a specific tag.
|
|
896
976
|
*/
|
|
897
|
-
get: operations["
|
|
977
|
+
get: operations["get_tag_analytics_changes"];
|
|
898
978
|
put?: never;
|
|
899
979
|
post?: never;
|
|
900
980
|
delete?: never;
|
|
@@ -903,7 +983,7 @@ export interface paths {
|
|
|
903
983
|
patch?: never;
|
|
904
984
|
trace?: never;
|
|
905
985
|
};
|
|
906
|
-
"/polymarket/tags/{tag}/analytics/
|
|
986
|
+
"/polymarket/tags/{tag}/analytics/deltas": {
|
|
907
987
|
parameters: {
|
|
908
988
|
query?: never;
|
|
909
989
|
header?: never;
|
|
@@ -911,10 +991,10 @@ export interface paths {
|
|
|
911
991
|
cookie?: never;
|
|
912
992
|
};
|
|
913
993
|
/**
|
|
914
|
-
* Tag analytics
|
|
915
|
-
* @description
|
|
994
|
+
* Tag analytics candles (per-bucket deltas)
|
|
995
|
+
* @description Returns per-bucket deltas for a specific tag (what happened during each bucket).
|
|
916
996
|
*/
|
|
917
|
-
get: operations["
|
|
997
|
+
get: operations["get_tag_analytics_deltas"];
|
|
918
998
|
put?: never;
|
|
919
999
|
post?: never;
|
|
920
1000
|
delete?: never;
|
|
@@ -1092,7 +1172,7 @@ export interface paths {
|
|
|
1092
1172
|
};
|
|
1093
1173
|
/**
|
|
1094
1174
|
* Get trader position PnL
|
|
1095
|
-
* @description Retrieve per-outcome-token lifetime PnL for a trader
|
|
1175
|
+
* @description Retrieve per-outcome-token lifetime PnL for a trader. Includes open/closed state, win/loss outcome, redemption payouts, and share quantities. Filter by status and won/lost to segment portfolio views.
|
|
1096
1176
|
*/
|
|
1097
1177
|
get: operations["get_trader_position_pnl"];
|
|
1098
1178
|
put?: never;
|
|
@@ -1183,7 +1263,7 @@ export interface paths {
|
|
|
1183
1263
|
patch?: never;
|
|
1184
1264
|
trace?: never;
|
|
1185
1265
|
};
|
|
1186
|
-
"/polymarket/trader/{address}/analytics/
|
|
1266
|
+
"/polymarket/trader/{address}/analytics/changes": {
|
|
1187
1267
|
parameters: {
|
|
1188
1268
|
query?: never;
|
|
1189
1269
|
header?: never;
|
|
@@ -1191,10 +1271,10 @@ export interface paths {
|
|
|
1191
1271
|
cookie?: never;
|
|
1192
1272
|
};
|
|
1193
1273
|
/**
|
|
1194
|
-
* Trader analytics
|
|
1195
|
-
* @description
|
|
1274
|
+
* Trader analytics % change
|
|
1275
|
+
* @description Per-metric % change over the requested lookback window for a specific trader address.
|
|
1196
1276
|
*/
|
|
1197
|
-
get: operations["
|
|
1277
|
+
get: operations["get_trader_analytics_changes"];
|
|
1198
1278
|
put?: never;
|
|
1199
1279
|
post?: never;
|
|
1200
1280
|
delete?: never;
|
|
@@ -1203,7 +1283,7 @@ export interface paths {
|
|
|
1203
1283
|
patch?: never;
|
|
1204
1284
|
trace?: never;
|
|
1205
1285
|
};
|
|
1206
|
-
"/polymarket/trader/{address}/analytics/
|
|
1286
|
+
"/polymarket/trader/{address}/analytics/deltas": {
|
|
1207
1287
|
parameters: {
|
|
1208
1288
|
query?: never;
|
|
1209
1289
|
header?: never;
|
|
@@ -1211,10 +1291,10 @@ export interface paths {
|
|
|
1211
1291
|
cookie?: never;
|
|
1212
1292
|
};
|
|
1213
1293
|
/**
|
|
1214
|
-
* Trader analytics
|
|
1215
|
-
* @description
|
|
1294
|
+
* Trader analytics candles (per-bucket deltas)
|
|
1295
|
+
* @description Returns per-bucket deltas for a specific trader address (what happened during each bucket).
|
|
1216
1296
|
*/
|
|
1217
|
-
get: operations["
|
|
1297
|
+
get: operations["get_trader_analytics_deltas"];
|
|
1218
1298
|
put?: never;
|
|
1219
1299
|
post?: never;
|
|
1220
1300
|
delete?: never;
|
|
@@ -1247,6 +1327,14 @@ export interface paths {
|
|
|
1247
1327
|
export type webhooks = Record<string, never>;
|
|
1248
1328
|
export interface components {
|
|
1249
1329
|
schemas: {
|
|
1330
|
+
/**
|
|
1331
|
+
* @description Resolution for `/analytics/timeseries` and `/analytics/deltas`.
|
|
1332
|
+
* Superset of `CandlestickResolution` — adds 7-day (`W`/`1W`) and calendar
|
|
1333
|
+
* month (`M`/`1M`) buckets, which are pre-aggregated for global and tag
|
|
1334
|
+
* domains and re-bucketed from the `_1d` MV for market/event/trader.
|
|
1335
|
+
* @enum {string}
|
|
1336
|
+
*/
|
|
1337
|
+
AnalyticsResolution: "60" | "240" | "D" | "1D" | "W" | "1W" | "M" | "1M";
|
|
1250
1338
|
/** @description Output payload for ERC1155 setApprovalForAll events. */
|
|
1251
1339
|
ApprovalTrade: {
|
|
1252
1340
|
id: string;
|
|
@@ -1417,6 +1505,8 @@ export interface components {
|
|
|
1417
1505
|
/** Format: double */
|
|
1418
1506
|
price: number;
|
|
1419
1507
|
};
|
|
1508
|
+
/** @enum {string} */
|
|
1509
|
+
BondsSortBy: "end_date" | "apy" | "liquidity" | "volume";
|
|
1420
1510
|
/** @description Output payload for Cancelled orders. */
|
|
1421
1511
|
CancelledTrade: {
|
|
1422
1512
|
id: string;
|
|
@@ -1444,7 +1534,7 @@ export interface components {
|
|
|
1444
1534
|
* @description Lookback window for `/analytics/changes` endpoints.
|
|
1445
1535
|
* @enum {string}
|
|
1446
1536
|
*/
|
|
1447
|
-
ChangeTimeframe: "1h" | "24h" | "7d" | "30d" | "1y";
|
|
1537
|
+
ChangeTimeframe: "1h" | "24h" | "7d" | "30d" | "1mo" | "1y";
|
|
1448
1538
|
/** @enum {string} */
|
|
1449
1539
|
ChartResolution: "1H" | "6H" | "1D" | "1W" | "1M" | "ALL";
|
|
1450
1540
|
/** @description CLOB reward (public API format) */
|
|
@@ -1532,6 +1622,36 @@ export interface components {
|
|
|
1532
1622
|
slug?: string | null;
|
|
1533
1623
|
event_slug?: string | null;
|
|
1534
1624
|
};
|
|
1625
|
+
/** @description V2 UMA OOv2: a proposed price was disputed. */
|
|
1626
|
+
DisputePriceEvent: {
|
|
1627
|
+
id: string;
|
|
1628
|
+
hash: string;
|
|
1629
|
+
/** Format: int64 */
|
|
1630
|
+
block?: number | null;
|
|
1631
|
+
/** Format: int64 */
|
|
1632
|
+
confirmed_at?: number | null;
|
|
1633
|
+
/** Format: int64 */
|
|
1634
|
+
received_at?: number | null;
|
|
1635
|
+
/** Format: int64 */
|
|
1636
|
+
log_index?: number | null;
|
|
1637
|
+
/** Format: int64 */
|
|
1638
|
+
block_index?: number | null;
|
|
1639
|
+
oracle_contract: string;
|
|
1640
|
+
requester: string;
|
|
1641
|
+
proposer: string;
|
|
1642
|
+
disputer: string;
|
|
1643
|
+
identifier: string;
|
|
1644
|
+
timestamp: string;
|
|
1645
|
+
ancillary_data: string;
|
|
1646
|
+
/** Format: int64 */
|
|
1647
|
+
proposed_price: number;
|
|
1648
|
+
condition_id?: string | null;
|
|
1649
|
+
proposed_outcome?: string | null;
|
|
1650
|
+
question?: string | null;
|
|
1651
|
+
image_url?: string | null;
|
|
1652
|
+
slug?: string | null;
|
|
1653
|
+
event_slug?: string | null;
|
|
1654
|
+
};
|
|
1535
1655
|
/** @description Enriched market data for event API responses */
|
|
1536
1656
|
EventMarket: {
|
|
1537
1657
|
/** @default */
|
|
@@ -1629,6 +1749,105 @@ export interface components {
|
|
|
1629
1749
|
EventPnlSortBy: "realized_pnl_usd" | "total_volume_usd" | "markets_traded" | "total_fees" | "realized_pnl_pct";
|
|
1630
1750
|
/** @enum {string} */
|
|
1631
1751
|
EventSortBy: "volume" | "txns" | "unique_traders" | "title" | "creation_date" | "start_date" | "end_date" | "relevance";
|
|
1752
|
+
/**
|
|
1753
|
+
* @description Response body for `GET /polymarket/analytics/counts`.
|
|
1754
|
+
* Cumulative analytics metrics plus entity-count enrichment.
|
|
1755
|
+
*/
|
|
1756
|
+
GlobalCountsResponse: {
|
|
1757
|
+
/**
|
|
1758
|
+
* Format: int32
|
|
1759
|
+
* @description Unix-second timestamp of the latest block reflected in the metrics.
|
|
1760
|
+
*/
|
|
1761
|
+
ts: number;
|
|
1762
|
+
/**
|
|
1763
|
+
* Format: int64
|
|
1764
|
+
* @description Latest block number processed.
|
|
1765
|
+
*/
|
|
1766
|
+
block: number;
|
|
1767
|
+
/** Format: double */
|
|
1768
|
+
volume_usd: number;
|
|
1769
|
+
/** Format: double */
|
|
1770
|
+
buy_volume_usd: number;
|
|
1771
|
+
/** Format: double */
|
|
1772
|
+
sell_volume_usd: number;
|
|
1773
|
+
/**
|
|
1774
|
+
* Format: int64
|
|
1775
|
+
* @description Distinct addresses that have ever traded on Polymarket (lifetime).
|
|
1776
|
+
*/
|
|
1777
|
+
unique_traders: number;
|
|
1778
|
+
/**
|
|
1779
|
+
* Format: int64
|
|
1780
|
+
* @description Distinct makers ever active (lifetime distinct).
|
|
1781
|
+
*/
|
|
1782
|
+
unique_makers: number;
|
|
1783
|
+
/**
|
|
1784
|
+
* Format: int64
|
|
1785
|
+
* @description Distinct takers ever active (lifetime distinct).
|
|
1786
|
+
*/
|
|
1787
|
+
unique_takers: number;
|
|
1788
|
+
/** Format: int64 */
|
|
1789
|
+
txn_count: number;
|
|
1790
|
+
/** Format: int64 */
|
|
1791
|
+
buy_count: number;
|
|
1792
|
+
/** Format: int64 */
|
|
1793
|
+
sell_count: number;
|
|
1794
|
+
/** Format: int64 */
|
|
1795
|
+
redemption_count: number;
|
|
1796
|
+
/** Format: double */
|
|
1797
|
+
redemption_volume_usd: number;
|
|
1798
|
+
/** Format: int64 */
|
|
1799
|
+
merge_count: number;
|
|
1800
|
+
/** Format: double */
|
|
1801
|
+
merge_volume_usd: number;
|
|
1802
|
+
/** Format: int64 */
|
|
1803
|
+
split_count: number;
|
|
1804
|
+
/** Format: double */
|
|
1805
|
+
split_volume_usd: number;
|
|
1806
|
+
/** Format: double */
|
|
1807
|
+
fees_usd: number;
|
|
1808
|
+
/** Format: double */
|
|
1809
|
+
shares_volume: number;
|
|
1810
|
+
/** Format: double */
|
|
1811
|
+
yes_volume_usd: number;
|
|
1812
|
+
/** Format: double */
|
|
1813
|
+
no_volume_usd: number;
|
|
1814
|
+
/** Format: int64 */
|
|
1815
|
+
yes_count: number;
|
|
1816
|
+
/** Format: int64 */
|
|
1817
|
+
no_count: number;
|
|
1818
|
+
/** Format: int64 */
|
|
1819
|
+
buy_dist_under_10: number;
|
|
1820
|
+
/** Format: int64 */
|
|
1821
|
+
buy_dist_10_100: number;
|
|
1822
|
+
/** Format: int64 */
|
|
1823
|
+
buy_dist_100_1k: number;
|
|
1824
|
+
/** Format: int64 */
|
|
1825
|
+
buy_dist_1k_10k: number;
|
|
1826
|
+
/** Format: int64 */
|
|
1827
|
+
buy_dist_10k_50k: number;
|
|
1828
|
+
/** Format: int64 */
|
|
1829
|
+
buy_dist_50k_plus: number;
|
|
1830
|
+
/**
|
|
1831
|
+
* Format: int64
|
|
1832
|
+
* @description Estimated total number of tags.
|
|
1833
|
+
*/
|
|
1834
|
+
tags: number;
|
|
1835
|
+
/**
|
|
1836
|
+
* Format: int64
|
|
1837
|
+
* @description Estimated total number of events.
|
|
1838
|
+
*/
|
|
1839
|
+
events: number;
|
|
1840
|
+
/**
|
|
1841
|
+
* Format: int64
|
|
1842
|
+
* @description Estimated total number of markets.
|
|
1843
|
+
*/
|
|
1844
|
+
markets: number;
|
|
1845
|
+
/**
|
|
1846
|
+
* Format: int64
|
|
1847
|
+
* @description Estimated total number of unique positions / traders.
|
|
1848
|
+
*/
|
|
1849
|
+
positions: number;
|
|
1850
|
+
};
|
|
1632
1851
|
/** @enum {string} */
|
|
1633
1852
|
GlobalPnlSortBy: "realized_pnl_usd" | "buys" | "sells" | "redemptions" | "merges" | "avg_hold_time" | "markets_traded" | "events_traded" | "markets_won" | "volume_usd" | "fees" | "best_trade";
|
|
1634
1853
|
/** @description Individual trader entry in the global PnL leaderboard */
|
|
@@ -1725,47 +1944,6 @@ export interface components {
|
|
|
1725
1944
|
/** Format: int64 */
|
|
1726
1945
|
last_trade_at?: number | null;
|
|
1727
1946
|
};
|
|
1728
|
-
/** @description Latest cumulative metrics snapshot — read from `analytics_global_all FINAL`. */
|
|
1729
|
-
LatestMetricsRow: {
|
|
1730
|
-
/** Format: int32 */
|
|
1731
|
-
ts: number;
|
|
1732
|
-
/** Format: int64 */
|
|
1733
|
-
block: number;
|
|
1734
|
-
/** Format: double */
|
|
1735
|
-
volume_usd: number;
|
|
1736
|
-
/** Format: double */
|
|
1737
|
-
buy_volume_usd: number;
|
|
1738
|
-
/** Format: double */
|
|
1739
|
-
sell_volume_usd: number;
|
|
1740
|
-
/** Format: int64 */
|
|
1741
|
-
unique_traders: number;
|
|
1742
|
-
/** Format: int64 */
|
|
1743
|
-
txn_count: number;
|
|
1744
|
-
/** Format: int64 */
|
|
1745
|
-
buy_count: number;
|
|
1746
|
-
/** Format: int64 */
|
|
1747
|
-
sell_count: number;
|
|
1748
|
-
/** Format: int64 */
|
|
1749
|
-
redemption_count: number;
|
|
1750
|
-
/** Format: double */
|
|
1751
|
-
redemption_volume_usd: number;
|
|
1752
|
-
/** Format: int64 */
|
|
1753
|
-
merge_count: number;
|
|
1754
|
-
/** Format: int64 */
|
|
1755
|
-
split_count: number;
|
|
1756
|
-
/** Format: double */
|
|
1757
|
-
fees_usd: number;
|
|
1758
|
-
/** Format: double */
|
|
1759
|
-
shares_volume: number;
|
|
1760
|
-
/** Format: double */
|
|
1761
|
-
yes_volume_usd: number;
|
|
1762
|
-
/** Format: double */
|
|
1763
|
-
no_volume_usd: number;
|
|
1764
|
-
/** Format: int64 */
|
|
1765
|
-
yes_count: number;
|
|
1766
|
-
/** Format: int64 */
|
|
1767
|
-
no_count: number;
|
|
1768
|
-
};
|
|
1769
1947
|
/**
|
|
1770
1948
|
* @description Market category filter for the trader leaderboard.
|
|
1771
1949
|
* Mirrors `common::gamma::categories::Category` plus `overall` (= all).
|
|
@@ -1773,11 +1951,10 @@ export interface components {
|
|
|
1773
1951
|
*/
|
|
1774
1952
|
LeaderboardCategory: "overall" | "politics" | "sports" | "crypto" | "finance" | "culture" | "mentions" | "weather" | "economics" | "tech";
|
|
1775
1953
|
/**
|
|
1776
|
-
* @description Flat response row. `trader` is the canonical `TraderInfo` used across
|
|
1777
|
-
*
|
|
1778
|
-
*
|
|
1779
|
-
*
|
|
1780
|
-
* a row for that address in the selected timeframe.
|
|
1954
|
+
* @description Flat response row. `trader` is the canonical `TraderInfo` used across
|
|
1955
|
+
* endpoints; enrichment fields sit at the top level. Fields other than
|
|
1956
|
+
* `trader`, `rank`, `pnl`, and `timeframe` may be `null` when PnL data for
|
|
1957
|
+
* the trader in the selected timeframe isn't yet available.
|
|
1781
1958
|
*/
|
|
1782
1959
|
LeaderboardEntry: {
|
|
1783
1960
|
/** Format: int64 */
|
|
@@ -2006,8 +2183,16 @@ export interface components {
|
|
|
2006
2183
|
/** Format: double */
|
|
2007
2184
|
sell_volume_usd?: number | null;
|
|
2008
2185
|
/** Format: double */
|
|
2186
|
+
merge_volume_usd?: number | null;
|
|
2187
|
+
/** Format: double */
|
|
2188
|
+
split_volume_usd?: number | null;
|
|
2189
|
+
/** Format: double */
|
|
2009
2190
|
unique_traders?: number | null;
|
|
2010
2191
|
/** Format: double */
|
|
2192
|
+
unique_makers?: number | null;
|
|
2193
|
+
/** Format: double */
|
|
2194
|
+
unique_takers?: number | null;
|
|
2195
|
+
/** Format: double */
|
|
2011
2196
|
txn_count?: number | null;
|
|
2012
2197
|
/** Format: double */
|
|
2013
2198
|
fees_usd?: number | null;
|
|
@@ -2042,6 +2227,62 @@ export interface components {
|
|
|
2042
2227
|
slug?: string | null;
|
|
2043
2228
|
event_slug?: string | null;
|
|
2044
2229
|
};
|
|
2230
|
+
/**
|
|
2231
|
+
* @description Tagged enum for all oracle event types — serializes with `"event_type": "..."` discriminator
|
|
2232
|
+
* and only includes fields relevant to each type.
|
|
2233
|
+
*/
|
|
2234
|
+
OracleEventTyped: (components["schemas"]["AssertionMadeEvent"] & {
|
|
2235
|
+
/** @enum {string} */
|
|
2236
|
+
event_type: "AssertionMade";
|
|
2237
|
+
}) | (components["schemas"]["AssertionDisputedEvent"] & {
|
|
2238
|
+
/** @enum {string} */
|
|
2239
|
+
event_type: "AssertionDisputed";
|
|
2240
|
+
}) | (components["schemas"]["AssertionSettledEvent"] & {
|
|
2241
|
+
/** @enum {string} */
|
|
2242
|
+
event_type: "AssertionSettled";
|
|
2243
|
+
}) | (components["schemas"]["RequestPriceEvent"] & {
|
|
2244
|
+
/** @enum {string} */
|
|
2245
|
+
event_type: "RequestPrice";
|
|
2246
|
+
}) | (components["schemas"]["ProposePriceEvent"] & {
|
|
2247
|
+
/** @enum {string} */
|
|
2248
|
+
event_type: "ProposePrice";
|
|
2249
|
+
}) | (components["schemas"]["DisputePriceEvent"] & {
|
|
2250
|
+
/** @enum {string} */
|
|
2251
|
+
event_type: "DisputePrice";
|
|
2252
|
+
}) | (components["schemas"]["SettleEvent"] & {
|
|
2253
|
+
/** @enum {string} */
|
|
2254
|
+
event_type: "Settle";
|
|
2255
|
+
}) | (components["schemas"]["QuestionResolvedEvent"] & {
|
|
2256
|
+
/** @enum {string} */
|
|
2257
|
+
event_type: "QuestionResolved";
|
|
2258
|
+
}) | (components["schemas"]["QuestionEmergencyResolvedEvent"] & {
|
|
2259
|
+
/** @enum {string} */
|
|
2260
|
+
event_type: "QuestionEmergencyResolved";
|
|
2261
|
+
}) | (components["schemas"]["QuestionResetEvent"] & {
|
|
2262
|
+
/** @enum {string} */
|
|
2263
|
+
event_type: "QuestionReset";
|
|
2264
|
+
}) | (components["schemas"]["QuestionInitializedEvent"] & {
|
|
2265
|
+
/** @enum {string} */
|
|
2266
|
+
event_type: "QuestionInitialized";
|
|
2267
|
+
}) | (components["schemas"]["QuestionPausedEvent"] & {
|
|
2268
|
+
/** @enum {string} */
|
|
2269
|
+
event_type: "QuestionPaused";
|
|
2270
|
+
}) | (components["schemas"]["QuestionUnpausedEvent"] & {
|
|
2271
|
+
/** @enum {string} */
|
|
2272
|
+
event_type: "QuestionUnpaused";
|
|
2273
|
+
}) | (components["schemas"]["QuestionFlaggedEvent"] & {
|
|
2274
|
+
/** @enum {string} */
|
|
2275
|
+
event_type: "QuestionFlagged";
|
|
2276
|
+
}) | (components["schemas"]["QuestionUnflaggedEvent"] & {
|
|
2277
|
+
/** @enum {string} */
|
|
2278
|
+
event_type: "QuestionUnflagged";
|
|
2279
|
+
}) | (components["schemas"]["ConditionResolutionEvent"] & {
|
|
2280
|
+
/** @enum {string} */
|
|
2281
|
+
event_type: "ConditionResolution";
|
|
2282
|
+
}) | (components["schemas"]["NegRiskOutcomeReportedEvent"] & {
|
|
2283
|
+
/** @enum {string} */
|
|
2284
|
+
event_type: "NegRiskOutcomeReported";
|
|
2285
|
+
});
|
|
2045
2286
|
/** @description Output payload for OrderFilled and OrdersMatched trades (actual buy/sell). */
|
|
2046
2287
|
OrderFilledTrade: {
|
|
2047
2288
|
id: string;
|
|
@@ -2089,6 +2330,11 @@ export interface components {
|
|
|
2089
2330
|
* trades and may be `0x0000…` for V2 trades placed without a builder code.
|
|
2090
2331
|
*/
|
|
2091
2332
|
builder_code?: string | null;
|
|
2333
|
+
/**
|
|
2334
|
+
* Format: double
|
|
2335
|
+
* @description Builder fee in USDC. Absent when no builder code is attached.
|
|
2336
|
+
*/
|
|
2337
|
+
builder_fee?: number | null;
|
|
2092
2338
|
};
|
|
2093
2339
|
OrderbookHistoryRow: {
|
|
2094
2340
|
/** Format: int64 */
|
|
@@ -2408,6 +2654,39 @@ export interface components {
|
|
|
2408
2654
|
label: string;
|
|
2409
2655
|
/** @default null */
|
|
2410
2656
|
slug: string | null;
|
|
2657
|
+
/**
|
|
2658
|
+
* Format: double
|
|
2659
|
+
* @default null
|
|
2660
|
+
*/
|
|
2661
|
+
volume_usd: number;
|
|
2662
|
+
/**
|
|
2663
|
+
* Format: int64
|
|
2664
|
+
* @default null
|
|
2665
|
+
*/
|
|
2666
|
+
txn_count: number;
|
|
2667
|
+
/**
|
|
2668
|
+
* Format: int64
|
|
2669
|
+
* @description Distinct active traders in the window.
|
|
2670
|
+
* @default null
|
|
2671
|
+
*/
|
|
2672
|
+
unique_traders: number;
|
|
2673
|
+
/**
|
|
2674
|
+
* Format: int64
|
|
2675
|
+
* @description Distinct active makers in the window.
|
|
2676
|
+
* @default null
|
|
2677
|
+
*/
|
|
2678
|
+
unique_makers: number;
|
|
2679
|
+
/**
|
|
2680
|
+
* Format: int64
|
|
2681
|
+
* @description Distinct active takers in the window.
|
|
2682
|
+
* @default null
|
|
2683
|
+
*/
|
|
2684
|
+
unique_takers: number;
|
|
2685
|
+
/**
|
|
2686
|
+
* Format: double
|
|
2687
|
+
* @default null
|
|
2688
|
+
*/
|
|
2689
|
+
fees_usd: number;
|
|
2411
2690
|
};
|
|
2412
2691
|
/** @description Polymarket user profile (public API format) */
|
|
2413
2692
|
PolymarketUserProfile: {
|
|
@@ -2446,7 +2725,7 @@ export interface components {
|
|
|
2446
2725
|
* @description Outcome index (0 = Yes, 1 = No for binary)
|
|
2447
2726
|
*/
|
|
2448
2727
|
outcome_index: number;
|
|
2449
|
-
/** @description Outcome name (e.g. "Yes", "No") —
|
|
2728
|
+
/** @description Outcome name (e.g. "Yes", "No"). Optional — may be omitted when the market metadata isn't yet available. */
|
|
2450
2729
|
outcome?: string | null;
|
|
2451
2730
|
/** @description Amount of shares created/burned/redeemed for this position */
|
|
2452
2731
|
amount: string;
|
|
@@ -2598,6 +2877,37 @@ export interface components {
|
|
|
2598
2877
|
};
|
|
2599
2878
|
/** @enum {string} */
|
|
2600
2879
|
PriceJumpResolution: "1" | "5" | "15" | "30" | "60" | "240";
|
|
2880
|
+
/** @description V2 UMA OOv2: a price was proposed (resolution proposal). */
|
|
2881
|
+
ProposePriceEvent: {
|
|
2882
|
+
id: string;
|
|
2883
|
+
hash: string;
|
|
2884
|
+
/** Format: int64 */
|
|
2885
|
+
block?: number | null;
|
|
2886
|
+
/** Format: int64 */
|
|
2887
|
+
confirmed_at?: number | null;
|
|
2888
|
+
/** Format: int64 */
|
|
2889
|
+
received_at?: number | null;
|
|
2890
|
+
/** Format: int64 */
|
|
2891
|
+
log_index?: number | null;
|
|
2892
|
+
/** Format: int64 */
|
|
2893
|
+
block_index?: number | null;
|
|
2894
|
+
oracle_contract: string;
|
|
2895
|
+
requester: string;
|
|
2896
|
+
proposer: string;
|
|
2897
|
+
identifier: string;
|
|
2898
|
+
timestamp: string;
|
|
2899
|
+
ancillary_data: string;
|
|
2900
|
+
/** Format: int64 */
|
|
2901
|
+
proposed_price: number;
|
|
2902
|
+
expiration_timestamp: string;
|
|
2903
|
+
currency: string;
|
|
2904
|
+
condition_id?: string | null;
|
|
2905
|
+
proposed_outcome?: string | null;
|
|
2906
|
+
question?: string | null;
|
|
2907
|
+
image_url?: string | null;
|
|
2908
|
+
slug?: string | null;
|
|
2909
|
+
event_slug?: string | null;
|
|
2910
|
+
};
|
|
2601
2911
|
/** @description UMA CTF Adapter: admin emergency resolution. */
|
|
2602
2912
|
QuestionEmergencyResolvedEvent: {
|
|
2603
2913
|
id: string;
|
|
@@ -2828,6 +3138,41 @@ export interface components {
|
|
|
2828
3138
|
event_slug?: string | null;
|
|
2829
3139
|
exchange: components["schemas"]["PolymarketExchange"];
|
|
2830
3140
|
};
|
|
3141
|
+
/** @description V2 UMA OOv2: a price request was made (market initialization). */
|
|
3142
|
+
RequestPriceEvent: {
|
|
3143
|
+
id: string;
|
|
3144
|
+
hash: string;
|
|
3145
|
+
/** Format: int64 */
|
|
3146
|
+
block?: number | null;
|
|
3147
|
+
/** Format: int64 */
|
|
3148
|
+
confirmed_at?: number | null;
|
|
3149
|
+
/** Format: int64 */
|
|
3150
|
+
received_at?: number | null;
|
|
3151
|
+
/** Format: int64 */
|
|
3152
|
+
log_index?: number | null;
|
|
3153
|
+
/** Format: int64 */
|
|
3154
|
+
block_index?: number | null;
|
|
3155
|
+
oracle_contract: string;
|
|
3156
|
+
requester: string;
|
|
3157
|
+
identifier: string;
|
|
3158
|
+
/**
|
|
3159
|
+
* @description UMA request timestamp (seconds, decimal string).
|
|
3160
|
+
* The point in time the requester is asking the oracle to resolve the
|
|
3161
|
+
* price for — part of the request identity tuple
|
|
3162
|
+
* `(requester, identifier, timestamp, ancillaryData)`. Not the block
|
|
3163
|
+
* timestamp of this event; see `confirmed_at` for that.
|
|
3164
|
+
*/
|
|
3165
|
+
timestamp: string;
|
|
3166
|
+
ancillary_data: string;
|
|
3167
|
+
currency: string;
|
|
3168
|
+
reward: string;
|
|
3169
|
+
final_fee: string;
|
|
3170
|
+
condition_id?: string | null;
|
|
3171
|
+
question?: string | null;
|
|
3172
|
+
image_url?: string | null;
|
|
3173
|
+
slug?: string | null;
|
|
3174
|
+
event_slug?: string | null;
|
|
3175
|
+
};
|
|
2831
3176
|
SearchResponse: {
|
|
2832
3177
|
events?: components["schemas"]["PolymarketEvent"][] | null;
|
|
2833
3178
|
events_pagination?: null | components["schemas"]["PaginationMeta"];
|
|
@@ -2841,6 +3186,38 @@ export interface components {
|
|
|
2841
3186
|
* @enum {string}
|
|
2842
3187
|
*/
|
|
2843
3188
|
SearchSortBy: "volume" | "txns" | "unique_traders" | "relevance" | "title" | "creation_date" | "start_date" | "end_date" | "liquidity" | "holders" | "end_time" | "start_time" | "created_time";
|
|
3189
|
+
/** @description V2 UMA OOv2: a price request was settled (final resolution). */
|
|
3190
|
+
SettleEvent: {
|
|
3191
|
+
id: string;
|
|
3192
|
+
hash: string;
|
|
3193
|
+
/** Format: int64 */
|
|
3194
|
+
block?: number | null;
|
|
3195
|
+
/** Format: int64 */
|
|
3196
|
+
confirmed_at?: number | null;
|
|
3197
|
+
/** Format: int64 */
|
|
3198
|
+
received_at?: number | null;
|
|
3199
|
+
/** Format: int64 */
|
|
3200
|
+
log_index?: number | null;
|
|
3201
|
+
/** Format: int64 */
|
|
3202
|
+
block_index?: number | null;
|
|
3203
|
+
oracle_contract: string;
|
|
3204
|
+
requester: string;
|
|
3205
|
+
proposer: string;
|
|
3206
|
+
disputer: string;
|
|
3207
|
+
identifier: string;
|
|
3208
|
+
timestamp: string;
|
|
3209
|
+
ancillary_data: string;
|
|
3210
|
+
/** Format: int64 */
|
|
3211
|
+
proposed_price: number;
|
|
3212
|
+
payout: string;
|
|
3213
|
+
disputed: boolean;
|
|
3214
|
+
condition_id?: string | null;
|
|
3215
|
+
proposed_outcome?: string | null;
|
|
3216
|
+
question?: string | null;
|
|
3217
|
+
image_url?: string | null;
|
|
3218
|
+
slug?: string | null;
|
|
3219
|
+
event_slug?: string | null;
|
|
3220
|
+
};
|
|
2844
3221
|
SimpleTimeframeMetrics: {
|
|
2845
3222
|
/**
|
|
2846
3223
|
* Format: double
|
|
@@ -2920,11 +3297,32 @@ export interface components {
|
|
|
2920
3297
|
ask_levels?: number | null;
|
|
2921
3298
|
};
|
|
2922
3299
|
/**
|
|
2923
|
-
* @description
|
|
3300
|
+
* @description Metric to order by when `sort=<value>` is provided.
|
|
3301
|
+
*
|
|
3302
|
+
* `unique_*` ranks by window-distinct addresses — exact `uniqExact` count
|
|
3303
|
+
* of addresses active in the timeframe.
|
|
3304
|
+
* @enum {string}
|
|
3305
|
+
*/
|
|
3306
|
+
TagSortBy: "volume" | "txns" | "unique_traders" | "unique_makers" | "unique_takers" | "fees";
|
|
3307
|
+
/**
|
|
3308
|
+
* @description Timeframe for `?sort=...` — defines the window the metric is summed over
|
|
3309
|
+
* (or `lifetime` for all-time cumulative).
|
|
3310
|
+
* @enum {string}
|
|
3311
|
+
*/
|
|
3312
|
+
TagSortTimeframe: "lifetime" | "1h" | "24h" | "7d" | "30d" | "1mo" | "1y";
|
|
3313
|
+
/**
|
|
3314
|
+
* @description Bucket row returned by both `/analytics/timeseries` (cumulative values
|
|
3315
|
+
* at end of bucket) and `/analytics/deltas` (per-bucket deltas). All metrics
|
|
3316
|
+
* the snapshot `/counts` returns are included.
|
|
3317
|
+
*
|
|
2924
3318
|
* Short field names for compact JSON responses:
|
|
2925
3319
|
* t=bucket (unix seconds), v=volume_usd, bv=buy_volume_usd, sv=sell_volume_usd,
|
|
2926
|
-
* ut=unique_traders,
|
|
2927
|
-
*
|
|
3320
|
+
* ut=unique_traders, um=unique_makers, uk=unique_takers,
|
|
3321
|
+
* tc=txn_count, bc=buy_count, sc=sell_count,
|
|
3322
|
+
* rc=redemption_count, rv=redemption_volume_usd, mc=merge_count, mv=merge_volume_usd,
|
|
3323
|
+
* sp=split_count, spv=split_volume_usd, f=fees_usd, sh=shares_volume,
|
|
3324
|
+
* yv=yes_volume_usd, nv=no_volume_usd, yc=yes_count, nc=no_count,
|
|
3325
|
+
* bd_*=buy distribution by USD bucket
|
|
2928
3326
|
*/
|
|
2929
3327
|
TimeBucketRow: {
|
|
2930
3328
|
/** Format: int32 */
|
|
@@ -2936,9 +3334,23 @@ export interface components {
|
|
|
2936
3334
|
/** Format: double */
|
|
2937
3335
|
sv: number;
|
|
2938
3336
|
/** Format: int64 */
|
|
2939
|
-
ut: number;
|
|
2940
|
-
/** Format: int64 */
|
|
2941
3337
|
tc: number;
|
|
3338
|
+
/** Format: int64 */
|
|
3339
|
+
bc: number;
|
|
3340
|
+
/** Format: int64 */
|
|
3341
|
+
sc: number;
|
|
3342
|
+
/** Format: int64 */
|
|
3343
|
+
rc: number;
|
|
3344
|
+
/** Format: double */
|
|
3345
|
+
rv: number;
|
|
3346
|
+
/** Format: int64 */
|
|
3347
|
+
mc: number;
|
|
3348
|
+
/** Format: double */
|
|
3349
|
+
mv: number;
|
|
3350
|
+
/** Format: int64 */
|
|
3351
|
+
sp: number;
|
|
3352
|
+
/** Format: double */
|
|
3353
|
+
spv: number;
|
|
2942
3354
|
/** Format: double */
|
|
2943
3355
|
f: number;
|
|
2944
3356
|
/** Format: double */
|
|
@@ -2947,6 +3359,40 @@ export interface components {
|
|
|
2947
3359
|
yv: number;
|
|
2948
3360
|
/** Format: double */
|
|
2949
3361
|
nv: number;
|
|
3362
|
+
/** Format: int64 */
|
|
3363
|
+
yc: number;
|
|
3364
|
+
/** Format: int64 */
|
|
3365
|
+
nc: number;
|
|
3366
|
+
/**
|
|
3367
|
+
* Format: int64
|
|
3368
|
+
* @description Buy distribution — count of buy trades falling in each USD bucket.
|
|
3369
|
+
*/
|
|
3370
|
+
bd_u10: number;
|
|
3371
|
+
/** Format: int64 */
|
|
3372
|
+
bd_100: number;
|
|
3373
|
+
/** Format: int64 */
|
|
3374
|
+
bd_1k: number;
|
|
3375
|
+
/** Format: int64 */
|
|
3376
|
+
bd_10k: number;
|
|
3377
|
+
/** Format: int64 */
|
|
3378
|
+
bd_50k: number;
|
|
3379
|
+
/** Format: int64 */
|
|
3380
|
+
bd_50p: number;
|
|
3381
|
+
/**
|
|
3382
|
+
* Format: int64
|
|
3383
|
+
* @description Distinct traders ACTIVE in this bucket (window-unique, not first-time).
|
|
3384
|
+
*/
|
|
3385
|
+
ut: number;
|
|
3386
|
+
/**
|
|
3387
|
+
* Format: int64
|
|
3388
|
+
* @description Distinct makers active in this bucket.
|
|
3389
|
+
*/
|
|
3390
|
+
um: number;
|
|
3391
|
+
/**
|
|
3392
|
+
* Format: int64
|
|
3393
|
+
* @description Distinct takers active in this bucket.
|
|
3394
|
+
*/
|
|
3395
|
+
uk: number;
|
|
2950
3396
|
};
|
|
2951
3397
|
/** @description Token outcome (position) */
|
|
2952
3398
|
TokenOutcome: {
|
|
@@ -3135,6 +3581,33 @@ export interface components {
|
|
|
3135
3581
|
/** Format: double */
|
|
3136
3582
|
realized_pnl_pct?: number | null;
|
|
3137
3583
|
};
|
|
3584
|
+
/**
|
|
3585
|
+
* @description Per-metric percentage change over a lookback window for one trader
|
|
3586
|
+
* address. A `null` field means the window predates the trader's first
|
|
3587
|
+
* activity or the prior value was zero (percentage undefined).
|
|
3588
|
+
*/
|
|
3589
|
+
TraderMetricPctChange: {
|
|
3590
|
+
/** Format: double */
|
|
3591
|
+
volume_usd?: number | null;
|
|
3592
|
+
/** Format: double */
|
|
3593
|
+
buy_volume_usd?: number | null;
|
|
3594
|
+
/** Format: double */
|
|
3595
|
+
sell_volume_usd?: number | null;
|
|
3596
|
+
/** Format: double */
|
|
3597
|
+
merge_volume_usd?: number | null;
|
|
3598
|
+
/** Format: double */
|
|
3599
|
+
split_volume_usd?: number | null;
|
|
3600
|
+
/** Format: double */
|
|
3601
|
+
txn_count?: number | null;
|
|
3602
|
+
/** Format: double */
|
|
3603
|
+
fees_usd?: number | null;
|
|
3604
|
+
/** Format: double */
|
|
3605
|
+
shares_volume?: number | null;
|
|
3606
|
+
/** Format: double */
|
|
3607
|
+
yes_volume_usd?: number | null;
|
|
3608
|
+
/** Format: double */
|
|
3609
|
+
no_volume_usd?: number | null;
|
|
3610
|
+
};
|
|
3138
3611
|
/** @description Outcome-level PnL entry (per outcome token / position_id) */
|
|
3139
3612
|
TraderOutcomePnlEntry: {
|
|
3140
3613
|
position_id?: string | null;
|
|
@@ -3255,6 +3728,65 @@ export interface components {
|
|
|
3255
3728
|
/** Format: int64 */
|
|
3256
3729
|
last_trade_at?: number | null;
|
|
3257
3730
|
};
|
|
3731
|
+
/**
|
|
3732
|
+
* @description Bucket row returned by the per-trader `/analytics/timeseries` and
|
|
3733
|
+
* `/analytics/deltas` endpoints. Mirrors `TimeBucketRow` minus the
|
|
3734
|
+
* distinct-address counters (`new_*` / `unique_*`) — those only carry
|
|
3735
|
+
* information for aggregations over many addresses (market, event, tag,
|
|
3736
|
+
* global), not for a single trader.
|
|
3737
|
+
*/
|
|
3738
|
+
TraderTimeBucketRow: {
|
|
3739
|
+
/** Format: int32 */
|
|
3740
|
+
t: number;
|
|
3741
|
+
/** Format: double */
|
|
3742
|
+
v: number;
|
|
3743
|
+
/** Format: double */
|
|
3744
|
+
bv: number;
|
|
3745
|
+
/** Format: double */
|
|
3746
|
+
sv: number;
|
|
3747
|
+
/** Format: int64 */
|
|
3748
|
+
tc: number;
|
|
3749
|
+
/** Format: int64 */
|
|
3750
|
+
bc: number;
|
|
3751
|
+
/** Format: int64 */
|
|
3752
|
+
sc: number;
|
|
3753
|
+
/** Format: int64 */
|
|
3754
|
+
rc: number;
|
|
3755
|
+
/** Format: double */
|
|
3756
|
+
rv: number;
|
|
3757
|
+
/** Format: int64 */
|
|
3758
|
+
mc: number;
|
|
3759
|
+
/** Format: double */
|
|
3760
|
+
mv: number;
|
|
3761
|
+
/** Format: int64 */
|
|
3762
|
+
sp: number;
|
|
3763
|
+
/** Format: double */
|
|
3764
|
+
spv: number;
|
|
3765
|
+
/** Format: double */
|
|
3766
|
+
f: number;
|
|
3767
|
+
/** Format: double */
|
|
3768
|
+
sh: number;
|
|
3769
|
+
/** Format: double */
|
|
3770
|
+
yv: number;
|
|
3771
|
+
/** Format: double */
|
|
3772
|
+
nv: number;
|
|
3773
|
+
/** Format: int64 */
|
|
3774
|
+
yc: number;
|
|
3775
|
+
/** Format: int64 */
|
|
3776
|
+
nc: number;
|
|
3777
|
+
/** Format: int64 */
|
|
3778
|
+
bd_u10: number;
|
|
3779
|
+
/** Format: int64 */
|
|
3780
|
+
bd_100: number;
|
|
3781
|
+
/** Format: int64 */
|
|
3782
|
+
bd_1k: number;
|
|
3783
|
+
/** Format: int64 */
|
|
3784
|
+
bd_10k: number;
|
|
3785
|
+
/** Format: int64 */
|
|
3786
|
+
bd_50k: number;
|
|
3787
|
+
/** Format: int64 */
|
|
3788
|
+
bd_50p: number;
|
|
3789
|
+
};
|
|
3258
3790
|
TraderVolumeChartResponse: {
|
|
3259
3791
|
volumes: components["schemas"]["TraderVolumeDataPoint"][];
|
|
3260
3792
|
has_more: boolean;
|
|
@@ -3297,19 +3829,11 @@ export interface components {
|
|
|
3297
3829
|
}
|
|
3298
3830
|
export type $defs = Record<string, never>;
|
|
3299
3831
|
export interface operations {
|
|
3300
|
-
|
|
3832
|
+
get_global_analytics_changes: {
|
|
3301
3833
|
parameters: {
|
|
3302
3834
|
query?: {
|
|
3303
|
-
/** @description
|
|
3304
|
-
|
|
3305
|
-
/** @description Start timestamp (Unix seconds). Omit for all-time. */
|
|
3306
|
-
from?: number;
|
|
3307
|
-
/** @description End timestamp (Unix seconds) */
|
|
3308
|
-
to?: number;
|
|
3309
|
-
/** @description Max data points (default: 500, max: 2500) */
|
|
3310
|
-
count_back?: number;
|
|
3311
|
-
/** @description Cursor from previous response for next page */
|
|
3312
|
-
pagination_key?: string;
|
|
3835
|
+
/** @description Lookback window: 1h, 24h, 7d, 30d, 1mo, 1y (default: 24h) */
|
|
3836
|
+
timeframe?: components["schemas"]["ChangeTimeframe"];
|
|
3313
3837
|
};
|
|
3314
3838
|
header?: never;
|
|
3315
3839
|
path?: never;
|
|
@@ -3317,56 +3841,64 @@ export interface operations {
|
|
|
3317
3841
|
};
|
|
3318
3842
|
requestBody?: never;
|
|
3319
3843
|
responses: {
|
|
3320
|
-
/** @description
|
|
3844
|
+
/** @description Per-metric pct change */
|
|
3321
3845
|
200: {
|
|
3322
3846
|
headers: {
|
|
3323
3847
|
[name: string]: unknown;
|
|
3324
3848
|
};
|
|
3325
3849
|
content: {
|
|
3326
|
-
"application/json": components["schemas"]["
|
|
3850
|
+
"application/json": components["schemas"]["MetricPctChange"];
|
|
3327
3851
|
};
|
|
3328
3852
|
};
|
|
3329
3853
|
};
|
|
3330
3854
|
};
|
|
3331
|
-
|
|
3855
|
+
get_analytics_counts: {
|
|
3332
3856
|
parameters: {
|
|
3333
|
-
query
|
|
3334
|
-
/** @description Lookback window: 1h, 24h, 7d, 30d, 1y */
|
|
3335
|
-
timeframe: components["schemas"]["ChangeTimeframe"];
|
|
3336
|
-
};
|
|
3857
|
+
query?: never;
|
|
3337
3858
|
header?: never;
|
|
3338
3859
|
path?: never;
|
|
3339
3860
|
cookie?: never;
|
|
3340
3861
|
};
|
|
3341
3862
|
requestBody?: never;
|
|
3342
3863
|
responses: {
|
|
3343
|
-
/** @description
|
|
3864
|
+
/** @description Latest global metrics snapshot */
|
|
3344
3865
|
200: {
|
|
3345
3866
|
headers: {
|
|
3346
3867
|
[name: string]: unknown;
|
|
3347
3868
|
};
|
|
3348
3869
|
content: {
|
|
3349
|
-
"application/json": components["schemas"]["
|
|
3870
|
+
"application/json": components["schemas"]["GlobalCountsResponse"];
|
|
3350
3871
|
};
|
|
3351
3872
|
};
|
|
3352
3873
|
};
|
|
3353
3874
|
};
|
|
3354
|
-
|
|
3875
|
+
get_global_analytics_deltas: {
|
|
3355
3876
|
parameters: {
|
|
3356
|
-
query?:
|
|
3877
|
+
query?: {
|
|
3878
|
+
/** @description Bucket size: 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
|
|
3879
|
+
resolution?: components["schemas"]["AnalyticsResolution"];
|
|
3880
|
+
/** @description Start timestamp (Unix seconds). Omit for all-time. */
|
|
3881
|
+
from?: number;
|
|
3882
|
+
/** @description End timestamp (Unix seconds) */
|
|
3883
|
+
to?: number;
|
|
3884
|
+
/** @description Max data points (default: 500, max: 2500) */
|
|
3885
|
+
count_back?: number;
|
|
3886
|
+
/** @description Cursor from previous response for next page */
|
|
3887
|
+
pagination_key?: string;
|
|
3888
|
+
};
|
|
3357
3889
|
header?: never;
|
|
3358
3890
|
path?: never;
|
|
3359
3891
|
cookie?: never;
|
|
3360
3892
|
};
|
|
3361
3893
|
requestBody?: never;
|
|
3362
3894
|
responses: {
|
|
3363
|
-
/** @description
|
|
3895
|
+
/** @description Delta time-bucketed analytics */
|
|
3364
3896
|
200: {
|
|
3365
3897
|
headers: {
|
|
3366
3898
|
[name: string]: unknown;
|
|
3367
3899
|
};
|
|
3368
3900
|
content: {
|
|
3369
|
-
"application/json": components["schemas"]["
|
|
3901
|
+
"application/json": components["schemas"]["TimeBucketRow"][];
|
|
3370
3902
|
};
|
|
3371
3903
|
};
|
|
3372
3904
|
};
|
|
@@ -3374,8 +3906,8 @@ export interface operations {
|
|
|
3374
3906
|
get_global_analytics_timeseries: {
|
|
3375
3907
|
parameters: {
|
|
3376
3908
|
query?: {
|
|
3377
|
-
/** @description Bucket size:
|
|
3378
|
-
resolution?: components["schemas"]["
|
|
3909
|
+
/** @description Bucket size: 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
|
|
3910
|
+
resolution?: components["schemas"]["AnalyticsResolution"];
|
|
3379
3911
|
/** @description Start timestamp (Unix seconds). Omit for all-time. */
|
|
3380
3912
|
from?: number;
|
|
3381
3913
|
/** @description End timestamp (Unix seconds) */
|
|
@@ -3668,21 +4200,40 @@ export interface operations {
|
|
|
3668
4200
|
};
|
|
3669
4201
|
};
|
|
3670
4202
|
};
|
|
3671
|
-
|
|
4203
|
+
get_event_top_traders: {
|
|
3672
4204
|
parameters: {
|
|
3673
|
-
query
|
|
3674
|
-
/** @description
|
|
3675
|
-
|
|
3676
|
-
/** @description
|
|
3677
|
-
|
|
3678
|
-
/** @description
|
|
3679
|
-
|
|
3680
|
-
/** @description
|
|
3681
|
-
count_back?: number;
|
|
3682
|
-
/** @description Cursor from previous response */
|
|
4205
|
+
query: {
|
|
4206
|
+
/** @description Event slug */
|
|
4207
|
+
event_slug: string;
|
|
4208
|
+
/** @description Timeframe: 1d, 7d, 30d, lifetime (default: lifetime) */
|
|
4209
|
+
timeframe?: components["schemas"]["PnlTimeframe"];
|
|
4210
|
+
/** @description Results limit (default: 10, max: 200) */
|
|
4211
|
+
limit?: number;
|
|
4212
|
+
/** @description Pagination key from the previous response */
|
|
3683
4213
|
pagination_key?: string;
|
|
3684
4214
|
};
|
|
3685
4215
|
header?: never;
|
|
4216
|
+
path?: never;
|
|
4217
|
+
cookie?: never;
|
|
4218
|
+
};
|
|
4219
|
+
requestBody?: never;
|
|
4220
|
+
responses: {
|
|
4221
|
+
/** @description Top traders sorted by realized PnL desc. */
|
|
4222
|
+
200: {
|
|
4223
|
+
headers: {
|
|
4224
|
+
[name: string]: unknown;
|
|
4225
|
+
};
|
|
4226
|
+
content?: never;
|
|
4227
|
+
};
|
|
4228
|
+
};
|
|
4229
|
+
};
|
|
4230
|
+
get_event_analytics_changes: {
|
|
4231
|
+
parameters: {
|
|
4232
|
+
query?: {
|
|
4233
|
+
/** @description Lookback window: 1h, 24h, 7d, 30d, 1mo, 1y (default: 24h) */
|
|
4234
|
+
timeframe?: components["schemas"]["ChangeTimeframe"];
|
|
4235
|
+
};
|
|
4236
|
+
header?: never;
|
|
3686
4237
|
path: {
|
|
3687
4238
|
/** @description Event slug */
|
|
3688
4239
|
event_slug: string;
|
|
@@ -3691,22 +4242,30 @@ export interface operations {
|
|
|
3691
4242
|
};
|
|
3692
4243
|
requestBody?: never;
|
|
3693
4244
|
responses: {
|
|
3694
|
-
/** @description
|
|
4245
|
+
/** @description Per-metric pct change */
|
|
3695
4246
|
200: {
|
|
3696
4247
|
headers: {
|
|
3697
4248
|
[name: string]: unknown;
|
|
3698
4249
|
};
|
|
3699
4250
|
content: {
|
|
3700
|
-
"application/json": components["schemas"]["
|
|
4251
|
+
"application/json": components["schemas"]["MetricPctChange"];
|
|
3701
4252
|
};
|
|
3702
4253
|
};
|
|
3703
4254
|
};
|
|
3704
4255
|
};
|
|
3705
|
-
|
|
4256
|
+
get_event_analytics_deltas: {
|
|
3706
4257
|
parameters: {
|
|
3707
|
-
query
|
|
3708
|
-
/** @description
|
|
3709
|
-
|
|
4258
|
+
query?: {
|
|
4259
|
+
/** @description Bucket size: 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
|
|
4260
|
+
resolution?: components["schemas"]["AnalyticsResolution"];
|
|
4261
|
+
/** @description Start timestamp (Unix seconds) */
|
|
4262
|
+
from?: number;
|
|
4263
|
+
/** @description End timestamp (Unix seconds) */
|
|
4264
|
+
to?: number;
|
|
4265
|
+
/** @description Max data points (default: 500, max: 2500) */
|
|
4266
|
+
count_back?: number;
|
|
4267
|
+
/** @description Cursor from previous response */
|
|
4268
|
+
pagination_key?: string;
|
|
3710
4269
|
};
|
|
3711
4270
|
header?: never;
|
|
3712
4271
|
path: {
|
|
@@ -3717,13 +4276,13 @@ export interface operations {
|
|
|
3717
4276
|
};
|
|
3718
4277
|
requestBody?: never;
|
|
3719
4278
|
responses: {
|
|
3720
|
-
/** @description
|
|
4279
|
+
/** @description Delta time-bucketed event analytics */
|
|
3721
4280
|
200: {
|
|
3722
4281
|
headers: {
|
|
3723
4282
|
[name: string]: unknown;
|
|
3724
4283
|
};
|
|
3725
4284
|
content: {
|
|
3726
|
-
"application/json": components["schemas"]["
|
|
4285
|
+
"application/json": components["schemas"]["TimeBucketRow"][];
|
|
3727
4286
|
};
|
|
3728
4287
|
};
|
|
3729
4288
|
};
|
|
@@ -3731,8 +4290,8 @@ export interface operations {
|
|
|
3731
4290
|
get_event_analytics_timeseries: {
|
|
3732
4291
|
parameters: {
|
|
3733
4292
|
query?: {
|
|
3734
|
-
/** @description Bucket size:
|
|
3735
|
-
resolution?: components["schemas"]["
|
|
4293
|
+
/** @description Bucket size: 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
|
|
4294
|
+
resolution?: components["schemas"]["AnalyticsResolution"];
|
|
3736
4295
|
/** @description Start timestamp (Unix seconds) */
|
|
3737
4296
|
from?: number;
|
|
3738
4297
|
/** @description End timestamp (Unix seconds) */
|
|
@@ -3808,8 +4367,10 @@ export interface operations {
|
|
|
3808
4367
|
condition_id?: string;
|
|
3809
4368
|
/** @description Market slug (e.g. `will-trump-win`) */
|
|
3810
4369
|
market_slug?: string;
|
|
3811
|
-
/** @description Results limit (default: 10, max: 100) */
|
|
4370
|
+
/** @description Results limit per outcome (default: 10, max: 100) */
|
|
3812
4371
|
limit?: number;
|
|
4372
|
+
/** @description Cursor-based pagination key */
|
|
4373
|
+
pagination_key?: string;
|
|
3813
4374
|
/** @description Minimum shares held (decimal string) */
|
|
3814
4375
|
min_shares?: string;
|
|
3815
4376
|
/** @description Maximum shares held (decimal string) */
|
|
@@ -3825,7 +4386,7 @@ export interface operations {
|
|
|
3825
4386
|
};
|
|
3826
4387
|
requestBody?: never;
|
|
3827
4388
|
responses: {
|
|
3828
|
-
/** @description Market holders grouped by outcome (sorted by shares DESC). Holder `pnl` is included only when `include_pnl=true`. */
|
|
4389
|
+
/** @description Market holders grouped by outcome (sorted by shares DESC). Holder `pnl` is included only when `include_pnl=true`. Response includes `pagination: { has_more, pagination_key }` for cursor-based pagination. */
|
|
3829
4390
|
200: {
|
|
3830
4391
|
headers: {
|
|
3831
4392
|
[name: string]: unknown;
|
|
@@ -4075,12 +4636,12 @@ export interface operations {
|
|
|
4075
4636
|
/** @description Maximum hours until market end */
|
|
4076
4637
|
max_hours?: number;
|
|
4077
4638
|
/** @description Sort by: apy, liquidity, volume, end_date (default: end_date) */
|
|
4078
|
-
sort_by?:
|
|
4639
|
+
sort_by?: components["schemas"]["BondsSortBy"];
|
|
4079
4640
|
/** @description Number of results (default: 10, max: 250) */
|
|
4080
4641
|
limit?: number;
|
|
4081
|
-
/** @description
|
|
4642
|
+
/** @description Initial skip (default: 0). Applied only on the first page; ignored when pagination_key is supplied. */
|
|
4082
4643
|
offset?: number;
|
|
4083
|
-
/** @description
|
|
4644
|
+
/** @description Keyset cursor from previous response. Opaque token — pass verbatim to fetch the next page. */
|
|
4084
4645
|
pagination_key?: string;
|
|
4085
4646
|
};
|
|
4086
4647
|
header?: never;
|
|
@@ -4194,6 +4755,43 @@ export interface operations {
|
|
|
4194
4755
|
};
|
|
4195
4756
|
};
|
|
4196
4757
|
};
|
|
4758
|
+
get_oracle_events: {
|
|
4759
|
+
parameters: {
|
|
4760
|
+
query?: {
|
|
4761
|
+
/** @description Comma-separated condition IDs (max 20) */
|
|
4762
|
+
condition_ids?: string;
|
|
4763
|
+
/** @description Comma-separated event names: Initialization, Proposal, Dispute, Settled, Resolution, ConditionResolution, Reset, Flag, Unflag, Pause, Unpause, ManualResolution, NegRiskOutcomeReported. Empty = all oracle event types. */
|
|
4764
|
+
event_types?: string;
|
|
4765
|
+
/** @description Start timestamp (Unix seconds) */
|
|
4766
|
+
from?: number;
|
|
4767
|
+
/** @description End timestamp (Unix seconds) */
|
|
4768
|
+
to?: number;
|
|
4769
|
+
/** @description Results per page (default 10, max 250) */
|
|
4770
|
+
limit?: number;
|
|
4771
|
+
/** @description Pagination offset. Takes precedence over pagination_key. */
|
|
4772
|
+
offset?: number;
|
|
4773
|
+
/** @description Cursor-based pagination key */
|
|
4774
|
+
pagination_key?: string;
|
|
4775
|
+
/** @description Sort direction (default true = newest first) */
|
|
4776
|
+
sort_desc?: boolean;
|
|
4777
|
+
};
|
|
4778
|
+
header?: never;
|
|
4779
|
+
path?: never;
|
|
4780
|
+
cookie?: never;
|
|
4781
|
+
};
|
|
4782
|
+
requestBody?: never;
|
|
4783
|
+
responses: {
|
|
4784
|
+
/** @description Oracle events matching the filter */
|
|
4785
|
+
200: {
|
|
4786
|
+
headers: {
|
|
4787
|
+
[name: string]: unknown;
|
|
4788
|
+
};
|
|
4789
|
+
content: {
|
|
4790
|
+
"application/json": components["schemas"]["TradeEvent"][];
|
|
4791
|
+
};
|
|
4792
|
+
};
|
|
4793
|
+
};
|
|
4794
|
+
};
|
|
4197
4795
|
get_position_candlestick: {
|
|
4198
4796
|
parameters: {
|
|
4199
4797
|
query: {
|
|
@@ -4259,6 +4857,33 @@ export interface operations {
|
|
|
4259
4857
|
};
|
|
4260
4858
|
};
|
|
4261
4859
|
};
|
|
4860
|
+
get_position_top_traders: {
|
|
4861
|
+
parameters: {
|
|
4862
|
+
query: {
|
|
4863
|
+
/** @description Position ID (ERC1155 token ID) */
|
|
4864
|
+
position_id: string;
|
|
4865
|
+
/** @description Filter by position status (omit for all) */
|
|
4866
|
+
status?: "open" | "closed";
|
|
4867
|
+
/** @description Results limit (default: 10, max: 200) */
|
|
4868
|
+
limit?: number;
|
|
4869
|
+
/** @description Pagination key from the previous response */
|
|
4870
|
+
pagination_key?: string;
|
|
4871
|
+
};
|
|
4872
|
+
header?: never;
|
|
4873
|
+
path?: never;
|
|
4874
|
+
cookie?: never;
|
|
4875
|
+
};
|
|
4876
|
+
requestBody?: never;
|
|
4877
|
+
responses: {
|
|
4878
|
+
/** @description Top traders sorted by realized PnL desc. */
|
|
4879
|
+
200: {
|
|
4880
|
+
headers: {
|
|
4881
|
+
[name: string]: unknown;
|
|
4882
|
+
};
|
|
4883
|
+
content?: never;
|
|
4884
|
+
};
|
|
4885
|
+
};
|
|
4886
|
+
};
|
|
4262
4887
|
get_position_volume_chart: {
|
|
4263
4888
|
parameters: {
|
|
4264
4889
|
query: {
|
|
@@ -4429,6 +5054,35 @@ export interface operations {
|
|
|
4429
5054
|
};
|
|
4430
5055
|
};
|
|
4431
5056
|
};
|
|
5057
|
+
get_market_top_traders: {
|
|
5058
|
+
parameters: {
|
|
5059
|
+
query?: {
|
|
5060
|
+
/** @description Market condition ID */
|
|
5061
|
+
condition_id?: string;
|
|
5062
|
+
/** @description Market slug (alternative to condition_id) */
|
|
5063
|
+
market_slug?: string;
|
|
5064
|
+
/** @description Timeframe: 1d, 7d, 30d, lifetime (default: lifetime) */
|
|
5065
|
+
timeframe?: components["schemas"]["PnlTimeframe"];
|
|
5066
|
+
/** @description Results limit (default: 10, max: 200) */
|
|
5067
|
+
limit?: number;
|
|
5068
|
+
/** @description Pagination key from the previous response */
|
|
5069
|
+
pagination_key?: string;
|
|
5070
|
+
};
|
|
5071
|
+
header?: never;
|
|
5072
|
+
path?: never;
|
|
5073
|
+
cookie?: never;
|
|
5074
|
+
};
|
|
5075
|
+
requestBody?: never;
|
|
5076
|
+
responses: {
|
|
5077
|
+
/** @description Top traders sorted by realized PnL desc. */
|
|
5078
|
+
200: {
|
|
5079
|
+
headers: {
|
|
5080
|
+
[name: string]: unknown;
|
|
5081
|
+
};
|
|
5082
|
+
content?: never;
|
|
5083
|
+
};
|
|
5084
|
+
};
|
|
5085
|
+
};
|
|
4432
5086
|
get_market_trades: {
|
|
4433
5087
|
parameters: {
|
|
4434
5088
|
query?: {
|
|
@@ -4440,6 +5094,8 @@ export interface operations {
|
|
|
4440
5094
|
position_ids?: string;
|
|
4441
5095
|
/** @description Comma-separated trader addresses (max 25) */
|
|
4442
5096
|
traders?: string;
|
|
5097
|
+
/** @description Comma-separated builder codes (max 25) */
|
|
5098
|
+
builder_codes?: string;
|
|
4443
5099
|
/** @description Trade side: 0 (Buy), 1 (Sell) */
|
|
4444
5100
|
side?: components["schemas"]["TradeSide"];
|
|
4445
5101
|
/** @description Outcome name filter (e.g. Yes, No) */
|
|
@@ -4464,8 +5120,6 @@ export interface operations {
|
|
|
4464
5120
|
from?: number;
|
|
4465
5121
|
/** @description End timestamp (ms) */
|
|
4466
5122
|
to?: number;
|
|
4467
|
-
/** @description Return all-time trades, not just last 30 days (default: false) */
|
|
4468
|
-
all?: boolean;
|
|
4469
5123
|
/** @description Results per page (default: 10, max: 250) */
|
|
4470
5124
|
limit?: number;
|
|
4471
5125
|
/** @description Pagination offset (number of results to skip). Takes precedence over pagination_key. */
|
|
@@ -4633,19 +5287,11 @@ export interface operations {
|
|
|
4633
5287
|
};
|
|
4634
5288
|
};
|
|
4635
5289
|
};
|
|
4636
|
-
|
|
5290
|
+
get_market_analytics_changes: {
|
|
4637
5291
|
parameters: {
|
|
4638
5292
|
query?: {
|
|
4639
|
-
/** @description
|
|
4640
|
-
|
|
4641
|
-
/** @description Start timestamp (Unix seconds) */
|
|
4642
|
-
from?: number;
|
|
4643
|
-
/** @description End timestamp (Unix seconds) */
|
|
4644
|
-
to?: number;
|
|
4645
|
-
/** @description Max data points (default: 500, max: 2500) */
|
|
4646
|
-
count_back?: number;
|
|
4647
|
-
/** @description Cursor from previous response */
|
|
4648
|
-
pagination_key?: string;
|
|
5293
|
+
/** @description Lookback window: 1h, 24h, 7d, 30d, 1mo, 1y (default: 24h) */
|
|
5294
|
+
timeframe?: components["schemas"]["ChangeTimeframe"];
|
|
4649
5295
|
};
|
|
4650
5296
|
header?: never;
|
|
4651
5297
|
path: {
|
|
@@ -4656,22 +5302,30 @@ export interface operations {
|
|
|
4656
5302
|
};
|
|
4657
5303
|
requestBody?: never;
|
|
4658
5304
|
responses: {
|
|
4659
|
-
/** @description
|
|
5305
|
+
/** @description Per-metric pct change */
|
|
4660
5306
|
200: {
|
|
4661
5307
|
headers: {
|
|
4662
5308
|
[name: string]: unknown;
|
|
4663
5309
|
};
|
|
4664
5310
|
content: {
|
|
4665
|
-
"application/json": components["schemas"]["
|
|
5311
|
+
"application/json": components["schemas"]["MetricPctChange"];
|
|
4666
5312
|
};
|
|
4667
5313
|
};
|
|
4668
5314
|
};
|
|
4669
5315
|
};
|
|
4670
|
-
|
|
5316
|
+
get_market_analytics_deltas: {
|
|
4671
5317
|
parameters: {
|
|
4672
|
-
query
|
|
4673
|
-
/** @description
|
|
4674
|
-
|
|
5318
|
+
query?: {
|
|
5319
|
+
/** @description Bucket size: 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
|
|
5320
|
+
resolution?: components["schemas"]["AnalyticsResolution"];
|
|
5321
|
+
/** @description Start timestamp (Unix seconds) */
|
|
5322
|
+
from?: number;
|
|
5323
|
+
/** @description End timestamp (Unix seconds) */
|
|
5324
|
+
to?: number;
|
|
5325
|
+
/** @description Max data points (default: 500, max: 2500) */
|
|
5326
|
+
count_back?: number;
|
|
5327
|
+
/** @description Cursor from previous response */
|
|
5328
|
+
pagination_key?: string;
|
|
4675
5329
|
};
|
|
4676
5330
|
header?: never;
|
|
4677
5331
|
path: {
|
|
@@ -4682,13 +5336,13 @@ export interface operations {
|
|
|
4682
5336
|
};
|
|
4683
5337
|
requestBody?: never;
|
|
4684
5338
|
responses: {
|
|
4685
|
-
/** @description
|
|
5339
|
+
/** @description Delta time-bucketed market analytics */
|
|
4686
5340
|
200: {
|
|
4687
5341
|
headers: {
|
|
4688
5342
|
[name: string]: unknown;
|
|
4689
5343
|
};
|
|
4690
5344
|
content: {
|
|
4691
|
-
"application/json": components["schemas"]["
|
|
5345
|
+
"application/json": components["schemas"]["TimeBucketRow"][];
|
|
4692
5346
|
};
|
|
4693
5347
|
};
|
|
4694
5348
|
};
|
|
@@ -4696,8 +5350,8 @@ export interface operations {
|
|
|
4696
5350
|
get_market_analytics_timeseries: {
|
|
4697
5351
|
parameters: {
|
|
4698
5352
|
query?: {
|
|
4699
|
-
/** @description Bucket size:
|
|
4700
|
-
resolution?: components["schemas"]["
|
|
5353
|
+
/** @description Bucket size: 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
|
|
5354
|
+
resolution?: components["schemas"]["AnalyticsResolution"];
|
|
4701
5355
|
/** @description Start timestamp (Unix seconds) */
|
|
4702
5356
|
from?: number;
|
|
4703
5357
|
/** @description End timestamp (Unix seconds) */
|
|
@@ -5152,8 +5806,14 @@ export interface operations {
|
|
|
5152
5806
|
limit?: number;
|
|
5153
5807
|
/** @description Offset-based pagination (number of results to skip). Takes precedence over pagination_key. */
|
|
5154
5808
|
offset?: number;
|
|
5155
|
-
/** @description Cursor-based pagination key */
|
|
5809
|
+
/** @description Cursor-based pagination key (alphabetical mode only). */
|
|
5156
5810
|
pagination_key?: string;
|
|
5811
|
+
/** @description Sort metric. Defaults to `volume` when only `timeframe` is set. Setting either `sort` or `timeframe` adds +2 credits. */
|
|
5812
|
+
sort?: components["schemas"]["TagSortBy"];
|
|
5813
|
+
/** @description Window for the sort metric. Defaults to `24h` when only `sort` is set. Setting either `sort` or `timeframe` adds +2 credits. */
|
|
5814
|
+
timeframe?: components["schemas"]["TagSortTimeframe"];
|
|
5815
|
+
/** @description Sort direction (default: true = highest first). Only applies to sort/timeframe mode. */
|
|
5816
|
+
sort_desc?: boolean;
|
|
5157
5817
|
};
|
|
5158
5818
|
header?: never;
|
|
5159
5819
|
path?: never;
|
|
@@ -5174,7 +5834,12 @@ export interface operations {
|
|
|
5174
5834
|
};
|
|
5175
5835
|
get_tag_by_id: {
|
|
5176
5836
|
parameters: {
|
|
5177
|
-
query?:
|
|
5837
|
+
query?: {
|
|
5838
|
+
/** @description Attach analytics metrics. +1 credit. */
|
|
5839
|
+
include_metrics?: boolean;
|
|
5840
|
+
/** @description Metrics window. Default `1d` (= `24h`). Ignored unless `include_metrics=true`. */
|
|
5841
|
+
timeframe?: components["schemas"]["TagSortTimeframe"];
|
|
5842
|
+
};
|
|
5178
5843
|
header?: never;
|
|
5179
5844
|
path: {
|
|
5180
5845
|
/** @description Tag ID or slug */
|
|
@@ -5202,19 +5867,11 @@ export interface operations {
|
|
|
5202
5867
|
};
|
|
5203
5868
|
};
|
|
5204
5869
|
};
|
|
5205
|
-
|
|
5870
|
+
get_tag_analytics_changes: {
|
|
5206
5871
|
parameters: {
|
|
5207
5872
|
query?: {
|
|
5208
|
-
/** @description
|
|
5209
|
-
|
|
5210
|
-
/** @description Start timestamp (Unix seconds) */
|
|
5211
|
-
from?: number;
|
|
5212
|
-
/** @description End timestamp (Unix seconds) */
|
|
5213
|
-
to?: number;
|
|
5214
|
-
/** @description Max data points (default: 500, max: 2500) */
|
|
5215
|
-
count_back?: number;
|
|
5216
|
-
/** @description Cursor from previous response */
|
|
5217
|
-
pagination_key?: string;
|
|
5873
|
+
/** @description Lookback window: 1h, 24h, 7d, 30d, 1mo, 1y (default: 24h) */
|
|
5874
|
+
timeframe?: components["schemas"]["ChangeTimeframe"];
|
|
5218
5875
|
};
|
|
5219
5876
|
header?: never;
|
|
5220
5877
|
path: {
|
|
@@ -5225,22 +5882,30 @@ export interface operations {
|
|
|
5225
5882
|
};
|
|
5226
5883
|
requestBody?: never;
|
|
5227
5884
|
responses: {
|
|
5228
|
-
/** @description
|
|
5885
|
+
/** @description Per-metric pct change */
|
|
5229
5886
|
200: {
|
|
5230
5887
|
headers: {
|
|
5231
5888
|
[name: string]: unknown;
|
|
5232
5889
|
};
|
|
5233
5890
|
content: {
|
|
5234
|
-
"application/json": components["schemas"]["
|
|
5891
|
+
"application/json": components["schemas"]["MetricPctChange"];
|
|
5235
5892
|
};
|
|
5236
5893
|
};
|
|
5237
5894
|
};
|
|
5238
5895
|
};
|
|
5239
|
-
|
|
5896
|
+
get_tag_analytics_deltas: {
|
|
5240
5897
|
parameters: {
|
|
5241
|
-
query
|
|
5242
|
-
/** @description
|
|
5243
|
-
|
|
5898
|
+
query?: {
|
|
5899
|
+
/** @description Bucket size: 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
|
|
5900
|
+
resolution?: components["schemas"]["AnalyticsResolution"];
|
|
5901
|
+
/** @description Start timestamp (Unix seconds) */
|
|
5902
|
+
from?: number;
|
|
5903
|
+
/** @description End timestamp (Unix seconds) */
|
|
5904
|
+
to?: number;
|
|
5905
|
+
/** @description Max data points (default: 500, max: 2500) */
|
|
5906
|
+
count_back?: number;
|
|
5907
|
+
/** @description Cursor from previous response */
|
|
5908
|
+
pagination_key?: string;
|
|
5244
5909
|
};
|
|
5245
5910
|
header?: never;
|
|
5246
5911
|
path: {
|
|
@@ -5251,13 +5916,13 @@ export interface operations {
|
|
|
5251
5916
|
};
|
|
5252
5917
|
requestBody?: never;
|
|
5253
5918
|
responses: {
|
|
5254
|
-
/** @description
|
|
5919
|
+
/** @description Delta time-bucketed tag analytics */
|
|
5255
5920
|
200: {
|
|
5256
5921
|
headers: {
|
|
5257
5922
|
[name: string]: unknown;
|
|
5258
5923
|
};
|
|
5259
5924
|
content: {
|
|
5260
|
-
"application/json": components["schemas"]["
|
|
5925
|
+
"application/json": components["schemas"]["TimeBucketRow"][];
|
|
5261
5926
|
};
|
|
5262
5927
|
};
|
|
5263
5928
|
};
|
|
@@ -5265,8 +5930,8 @@ export interface operations {
|
|
|
5265
5930
|
get_tag_analytics_timeseries: {
|
|
5266
5931
|
parameters: {
|
|
5267
5932
|
query?: {
|
|
5268
|
-
/** @description Bucket size:
|
|
5269
|
-
resolution?: components["schemas"]["
|
|
5933
|
+
/** @description Bucket size: 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
|
|
5934
|
+
resolution?: components["schemas"]["AnalyticsResolution"];
|
|
5270
5935
|
/** @description Start timestamp (Unix seconds) */
|
|
5271
5936
|
from?: number;
|
|
5272
5937
|
/** @description End timestamp (Unix seconds) */
|
|
@@ -5642,6 +6307,8 @@ export interface operations {
|
|
|
5642
6307
|
slugs?: string;
|
|
5643
6308
|
/** @description Comma-separated position IDs */
|
|
5644
6309
|
position_ids?: string;
|
|
6310
|
+
/** @description Comma-separated builder codes (max 25) */
|
|
6311
|
+
builder_codes?: string;
|
|
5645
6312
|
/** @description Trade side: 0 (Buy), 1 (Sell) */
|
|
5646
6313
|
side?: components["schemas"]["TradeSide"];
|
|
5647
6314
|
/** @description Outcome name filter (e.g. Yes, No) */
|
|
@@ -5666,8 +6333,6 @@ export interface operations {
|
|
|
5666
6333
|
from?: number;
|
|
5667
6334
|
/** @description End timestamp (ms) */
|
|
5668
6335
|
to?: number;
|
|
5669
|
-
/** @description Return all-time trades, not just last 30 days (default: false) */
|
|
5670
|
-
all?: boolean;
|
|
5671
6336
|
/** @description Results per page (default: 10, max: 250) */
|
|
5672
6337
|
limit?: number;
|
|
5673
6338
|
/** @description Pagination offset (number of results to skip). Takes precedence over pagination_key. */
|
|
@@ -5731,19 +6396,11 @@ export interface operations {
|
|
|
5731
6396
|
};
|
|
5732
6397
|
};
|
|
5733
6398
|
};
|
|
5734
|
-
|
|
6399
|
+
get_trader_analytics_changes: {
|
|
5735
6400
|
parameters: {
|
|
5736
6401
|
query?: {
|
|
5737
|
-
/** @description
|
|
5738
|
-
|
|
5739
|
-
/** @description Start timestamp (Unix seconds) */
|
|
5740
|
-
from?: number;
|
|
5741
|
-
/** @description End timestamp (Unix seconds) */
|
|
5742
|
-
to?: number;
|
|
5743
|
-
/** @description Max data points (default: 500, max: 2500) */
|
|
5744
|
-
count_back?: number;
|
|
5745
|
-
/** @description Cursor from previous response */
|
|
5746
|
-
pagination_key?: string;
|
|
6402
|
+
/** @description Lookback window: 1h, 24h, 7d, 30d, 1mo, 1y (default: 24h) */
|
|
6403
|
+
timeframe?: components["schemas"]["ChangeTimeframe"];
|
|
5747
6404
|
};
|
|
5748
6405
|
header?: never;
|
|
5749
6406
|
path: {
|
|
@@ -5754,22 +6411,30 @@ export interface operations {
|
|
|
5754
6411
|
};
|
|
5755
6412
|
requestBody?: never;
|
|
5756
6413
|
responses: {
|
|
5757
|
-
/** @description
|
|
6414
|
+
/** @description Per-metric pct change */
|
|
5758
6415
|
200: {
|
|
5759
6416
|
headers: {
|
|
5760
6417
|
[name: string]: unknown;
|
|
5761
6418
|
};
|
|
5762
6419
|
content: {
|
|
5763
|
-
"application/json": components["schemas"]["
|
|
6420
|
+
"application/json": components["schemas"]["TraderMetricPctChange"];
|
|
5764
6421
|
};
|
|
5765
6422
|
};
|
|
5766
6423
|
};
|
|
5767
6424
|
};
|
|
5768
|
-
|
|
6425
|
+
get_trader_analytics_deltas: {
|
|
5769
6426
|
parameters: {
|
|
5770
|
-
query
|
|
5771
|
-
/** @description
|
|
5772
|
-
|
|
6427
|
+
query?: {
|
|
6428
|
+
/** @description Bucket size: 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
|
|
6429
|
+
resolution?: components["schemas"]["AnalyticsResolution"];
|
|
6430
|
+
/** @description Start timestamp (Unix seconds) */
|
|
6431
|
+
from?: number;
|
|
6432
|
+
/** @description End timestamp (Unix seconds) */
|
|
6433
|
+
to?: number;
|
|
6434
|
+
/** @description Max data points (default: 500, max: 2500) */
|
|
6435
|
+
count_back?: number;
|
|
6436
|
+
/** @description Cursor from previous response */
|
|
6437
|
+
pagination_key?: string;
|
|
5773
6438
|
};
|
|
5774
6439
|
header?: never;
|
|
5775
6440
|
path: {
|
|
@@ -5780,13 +6445,13 @@ export interface operations {
|
|
|
5780
6445
|
};
|
|
5781
6446
|
requestBody?: never;
|
|
5782
6447
|
responses: {
|
|
5783
|
-
/** @description
|
|
6448
|
+
/** @description Delta time-bucketed trader analytics */
|
|
5784
6449
|
200: {
|
|
5785
6450
|
headers: {
|
|
5786
6451
|
[name: string]: unknown;
|
|
5787
6452
|
};
|
|
5788
6453
|
content: {
|
|
5789
|
-
"application/json": components["schemas"]["
|
|
6454
|
+
"application/json": components["schemas"]["TraderTimeBucketRow"][];
|
|
5790
6455
|
};
|
|
5791
6456
|
};
|
|
5792
6457
|
};
|
|
@@ -5794,8 +6459,8 @@ export interface operations {
|
|
|
5794
6459
|
get_trader_analytics_timeseries: {
|
|
5795
6460
|
parameters: {
|
|
5796
6461
|
query?: {
|
|
5797
|
-
/** @description Bucket size:
|
|
5798
|
-
resolution?: components["schemas"]["
|
|
6462
|
+
/** @description Bucket size: 60, 240, D, 1D, W, 1W, M, 1M (default: 60) */
|
|
6463
|
+
resolution?: components["schemas"]["AnalyticsResolution"];
|
|
5799
6464
|
/** @description Start timestamp (Unix seconds) */
|
|
5800
6465
|
from?: number;
|
|
5801
6466
|
/** @description End timestamp (Unix seconds) */
|
|
@@ -5820,7 +6485,7 @@ export interface operations {
|
|
|
5820
6485
|
[name: string]: unknown;
|
|
5821
6486
|
};
|
|
5822
6487
|
content: {
|
|
5823
|
-
"application/json": components["schemas"]["
|
|
6488
|
+
"application/json": components["schemas"]["TraderTimeBucketRow"][];
|
|
5824
6489
|
};
|
|
5825
6490
|
};
|
|
5826
6491
|
};
|