@structbuild/sdk 0.6.2 → 0.6.4

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.
@@ -169,73 +169,170 @@ export interface components {
169
169
  AssetWindowFilterTimeframe: "5m" | "15m" | "1h" | "4h" | "1d" | "24h";
170
170
  /** @description Category PnL webhook payload. */
171
171
  CategoryPnlPayload: {
172
+ /** @description Trader wallet address. */
172
173
  trader?: string | null;
174
+ /** @description Category. */
173
175
  category?: string | null;
174
176
  /** @description Aggregation timeframe: "1d", "7d", "30d", or "lifetime" */
175
177
  timeframe: string;
176
- /** Format: double */
178
+ /**
179
+ * Format: double
180
+ * @description Realized pnl in USD.
181
+ */
177
182
  realized_pnl_usd?: number | null;
178
- /** Format: int64 */
183
+ /**
184
+ * Format: int64
185
+ * @description Markets in this category.
186
+ */
179
187
  markets_in_category?: number | null;
180
- /** Format: int64 */
188
+ /**
189
+ * Format: int64
190
+ * @description Markets traded.
191
+ */
181
192
  markets_traded?: number | null;
182
- /** Format: int64 */
193
+ /**
194
+ * Format: int64
195
+ * @description Number of outcomes traded.
196
+ */
183
197
  outcomes_traded?: number | null;
184
- /** Format: int64 */
198
+ /**
199
+ * Format: int64
200
+ * @description Total buy count.
201
+ */
185
202
  total_buys?: number | null;
186
- /** Format: int64 */
203
+ /**
204
+ * Format: int64
205
+ * @description Total sell count.
206
+ */
187
207
  total_sells?: number | null;
188
- /** Format: int64 */
208
+ /**
209
+ * Format: int64
210
+ * @description Total redemption count.
211
+ */
189
212
  total_redemptions?: number | null;
190
- /** Format: int64 */
213
+ /**
214
+ * Format: int64
215
+ * @description Total merge count.
216
+ */
191
217
  total_merges?: number | null;
192
- /** Format: int64 */
218
+ /**
219
+ * Format: int64
220
+ * @description Total split count.
221
+ */
193
222
  total_splits?: number | null;
194
- /** Format: double */
223
+ /**
224
+ * Format: double
225
+ * @description Total volume in USD.
226
+ */
195
227
  total_volume_usd?: number | null;
196
- /** Format: double */
228
+ /**
229
+ * Format: double
230
+ * @description Buy in USD.
231
+ */
197
232
  buy_usd?: number | null;
198
- /** Format: double */
233
+ /**
234
+ * Format: double
235
+ * @description Sell in USD.
236
+ */
199
237
  sell_usd?: number | null;
200
- /** Format: double */
238
+ /**
239
+ * Format: double
240
+ * @description Redemption in USD.
241
+ */
201
242
  redemption_usd?: number | null;
202
- /** Format: double */
243
+ /**
244
+ * Format: double
245
+ * @description Merge in USD.
246
+ */
203
247
  merge_usd?: number | null;
204
- /** Format: double */
248
+ /**
249
+ * Format: double
250
+ * @description Convert collateral in USD.
251
+ */
205
252
  convert_collateral_usd?: number | null;
206
- /** Format: double */
253
+ /**
254
+ * Format: double
255
+ * @description Split volume in USD.
256
+ */
207
257
  split_volume_usd?: number | null;
208
- /** Format: double */
258
+ /**
259
+ * Format: double
260
+ * @description Total fees amount.
261
+ */
209
262
  total_fees?: number | null;
210
- /** Format: double */
263
+ /**
264
+ * Format: double
265
+ * @description Total shares bought.
266
+ */
211
267
  total_shares_bought?: number | null;
212
- /** Format: int64 */
268
+ /**
269
+ * Format: int64
270
+ * @description Markets won.
271
+ */
213
272
  markets_won?: number | null;
214
- /** Format: int64 */
273
+ /**
274
+ * Format: int64
275
+ * @description Markets lost.
276
+ */
215
277
  markets_lost?: number | null;
216
- /** Format: double */
278
+ /**
279
+ * Format: double
280
+ * @description Market win rate percent.
281
+ */
217
282
  market_win_rate_pct?: number | null;
218
- /** Format: double */
283
+ /**
284
+ * Format: double
285
+ * @description Average hold time seconds.
286
+ */
219
287
  avg_hold_time_seconds?: number | null;
220
- /** Format: double */
288
+ /**
289
+ * Format: double
290
+ * @description Best trade pnl in USD.
291
+ */
221
292
  best_trade_pnl_usd?: number | null;
293
+ /** @description Best trade condition id. */
222
294
  best_trade_condition_id?: string | null;
223
- /** Format: double */
295
+ /**
296
+ * Format: double
297
+ * @description Worst trade pnl in USD.
298
+ */
224
299
  worst_trade_pnl_usd?: number | null;
300
+ /** @description Worst trade condition id. */
225
301
  worst_trade_condition_id?: string | null;
226
- /** Format: double */
302
+ /**
303
+ * Format: double
304
+ * @description Total wins in USD.
305
+ */
227
306
  total_wins_usd?: number | null;
228
- /** Format: double */
307
+ /**
308
+ * Format: double
309
+ * @description Total losses in USD.
310
+ */
229
311
  total_losses_usd?: number | null;
230
- /** Format: double */
312
+ /**
313
+ * Format: double
314
+ * @description Average win in USD.
315
+ */
231
316
  avg_win_usd?: number | null;
232
- /** Format: double */
317
+ /**
318
+ * Format: double
319
+ * @description Average loss in USD.
320
+ */
233
321
  avg_loss_usd?: number | null;
234
- /** Format: double */
322
+ /**
323
+ * Format: double
324
+ * @description Profit factor.
325
+ */
235
326
  profit_factor?: number | null;
236
- /** Format: int64 */
327
+ /**
328
+ * Format: int64
329
+ * @description First trade timestamp.
330
+ */
237
331
  first_trade_at?: number | null;
238
- /** Format: int64 */
332
+ /**
333
+ * Format: int64
334
+ * @description Last trade timestamp.
335
+ */
239
336
  last_trade_at?: number | null;
240
337
  };
241
338
  /**
@@ -348,6 +445,7 @@ export interface components {
348
445
  threshold: number;
349
446
  };
350
447
  ConditionHolderMetricsFilters: {
448
+ /** @description Market condition IDs to match. */
351
449
  condition_ids?: string[];
352
450
  /**
353
451
  * @description Fire-and-delete: when `true`, delete the subscription after its first
@@ -356,12 +454,22 @@ export interface components {
356
454
  one_shot?: boolean | null;
357
455
  };
358
456
  ConditionHolderMetricsPayload: {
359
- /** Format: int32 */
457
+ /**
458
+ * Format: int32
459
+ * @description Unix timestamp in seconds.
460
+ */
360
461
  ts: number;
361
- /** Format: int64 */
462
+ /**
463
+ * Format: int64
464
+ * @description Block number.
465
+ */
362
466
  block: number;
467
+ /** @description Market condition ID. */
363
468
  condition_id: string;
364
- /** Format: int32 */
469
+ /**
470
+ * Format: int32
471
+ * @description Number of holders.
472
+ */
365
473
  holder_count: number;
366
474
  };
367
475
  /** @description Payload delivered when a market's volume or transaction metrics cross a configured threshold */
@@ -468,6 +576,7 @@ export interface components {
468
576
  };
469
577
  /** @description Delete webhook response */
470
578
  DeleteWebhookResponse: {
579
+ /** @description Whether the webhook was deleted. */
471
580
  deleted: boolean;
472
581
  };
473
582
  /**
@@ -520,6 +629,7 @@ export interface components {
520
629
  event_slug?: string | null;
521
630
  };
522
631
  EventHolderMetricsFilters: {
632
+ /** @description Event slugs to match. */
523
633
  event_slugs?: string[];
524
634
  /**
525
635
  * @description Fire-and-delete: when `true`, delete the subscription after its first
@@ -528,14 +638,75 @@ export interface components {
528
638
  one_shot?: boolean | null;
529
639
  };
530
640
  EventHolderMetricsPayload: {
531
- /** Format: int32 */
641
+ /**
642
+ * Format: int32
643
+ * @description Unix timestamp in seconds.
644
+ */
532
645
  ts: number;
533
- /** Format: int64 */
646
+ /**
647
+ * Format: int64
648
+ * @description Block number.
649
+ */
534
650
  block: number;
651
+ /** @description Event slug. */
535
652
  event_slug: string;
536
- /** Format: int32 */
653
+ /**
654
+ * Format: int32
655
+ * @description Number of holders.
656
+ */
537
657
  holder_count: number;
538
658
  };
659
+ /**
660
+ * @description Subscription filters for the `event_liquidity` event.
661
+ *
662
+ * At least one of `min_liquidity_usd`, `max_liquidity_usd`, or `one_shot` must be set.
663
+ * Thresholds are edge-triggered: a callback fires when liquidity crosses the threshold,
664
+ * then re-arms once it crosses back (unless `one_shot`).
665
+ */
666
+ EventLiquidityFilters: {
667
+ /**
668
+ * @description Fire-and-delete: when `true`, delete the subscription after its first
669
+ * successful delivery.
670
+ */
671
+ one_shot?: boolean | null;
672
+ /**
673
+ * Format: double
674
+ * @description Fire when total liquidity crosses up through this USD value.
675
+ */
676
+ min_liquidity_usd?: number | null;
677
+ /**
678
+ * Format: double
679
+ * @description Fire when total liquidity crosses down through this USD value.
680
+ */
681
+ max_liquidity_usd?: number | null;
682
+ /** @description **Required.** Events to receive liquidity updates for. */
683
+ event_slugs: string[];
684
+ };
685
+ /** @description Event liquidity webhook payload. */
686
+ EventLiquidityPayload: {
687
+ /** @description Event slug. */
688
+ event_slug: string;
689
+ /**
690
+ * Format: double
691
+ * @description Total order-book liquidity in USD at the time of firing.
692
+ */
693
+ liquidity_usd: number;
694
+ /**
695
+ * Format: double
696
+ * @description The threshold (USD) that was crossed.
697
+ */
698
+ threshold_usd: number;
699
+ /**
700
+ * @description `"above"` when liquidity crossed up through `min_liquidity_usd`,
701
+ * `"below"` when it crossed down through `max_liquidity_usd`.
702
+ */
703
+ direction: string;
704
+ /**
705
+ * Format: int64
706
+ * @description Update timestamp (Unix millis).
707
+ */
708
+ liquidity_updated_at: number;
709
+ };
539
710
  /** @description Subscription filters for the `event_metrics` event. All fields are optional. */
540
711
  EventMetricsFilters: {
541
712
  /**
@@ -552,13 +723,25 @@ export interface components {
552
723
  * @description Only fire when aggregated event volume ≥ this value (USD).
553
724
  */
554
725
  min_volume_usd?: number | null;
555
- /** Format: double */
726
+ /**
727
+ * Format: double
728
+ * @description Maximum volume USD.
729
+ */
556
730
  max_volume_usd?: number | null;
557
- /** Format: int64 */
731
+ /**
732
+ * Format: int64
733
+ * @description Minimum transactions.
734
+ */
558
735
  min_txns?: number | null;
559
- /** Format: int64 */
736
+ /**
737
+ * Format: int64
738
+ * @description Minimum unique traders.
739
+ */
560
740
  min_unique_traders?: number | null;
561
- /** Format: double */
741
+ /**
742
+ * Format: double
743
+ * @description Minimum fees.
744
+ */
562
745
  min_fees?: number | null;
563
746
  /** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
564
747
  exclude_shortterm_markets?: boolean | null;
@@ -648,7 +831,9 @@ export interface components {
648
831
  };
649
832
  /** @description Event volume milestone webhook payload */
650
833
  EventVolumeMilestonePayload: {
834
+ /** @description Event slug. */
651
835
  event_slug: string;
836
+ /** @description Metric timeframe. */
652
837
  timeframe: string;
653
838
  /**
654
839
  * Format: double
@@ -697,9 +882,13 @@ export interface components {
697
882
  };
698
883
  /** @description Event volume spike webhook payload */
699
884
  EventVolumeSpikePayload: {
885
+ /** @description Event slug. */
700
886
  event_slug: string;
887
+ /** @description Event title. */
701
888
  event_title?: string | null;
889
+ /** @description Image URL. */
702
890
  image_url?: string | null;
891
+ /** @description Metric timeframe. */
703
892
  timeframe: string;
704
893
  /**
705
894
  * Format: double
@@ -734,26 +923,50 @@ export interface components {
734
923
  };
735
924
  /** @description Exit Markers webhook payload — one position open->closed transition. */
736
925
  ExitMarkersPayload: {
926
+ /** @description Trader wallet address. */
737
927
  trader: string;
928
+ /** @description Outcome token ID. */
738
929
  position_id: string;
930
+ /** @description Market condition ID. */
739
931
  condition_id: string;
932
+ /** @description Event slug. */
740
933
  event_slug: string;
934
+ /** @description Market slug. */
741
935
  market_slug: string;
936
+ /** @description Title. */
742
937
  title: string;
938
+ /** @description Market question. */
743
939
  question: string;
940
+ /** @description Image URL. */
744
941
  image_url: string;
942
+ /** @description Outcome name. */
745
943
  outcome: string;
746
- /** Format: int32 */
944
+ /**
945
+ * Format: int32
946
+ * @description Outcome index.
947
+ */
747
948
  outcome_index?: number | null;
748
- /** Format: double */
949
+ /**
950
+ * Format: double
951
+ * @description Pnl in USD.
952
+ */
749
953
  pnl_usd: number;
750
- /** Format: double */
954
+ /**
955
+ * Format: double
956
+ * @description Pnl percent.
957
+ */
751
958
  pnl_pct: number;
752
- /** Format: double */
959
+ /**
960
+ * Format: double
961
+ * @description Cost basis in USD.
962
+ */
753
963
  cost_basis_usd: number;
754
964
  /** @description resolved_win | resolved_loss | sold_win | sold_loss */
755
965
  reason: string;
756
- /** Format: int64 */
966
+ /**
967
+ * Format: int64
968
+ * @description Block number.
969
+ */
757
970
  block: number;
758
971
  /**
759
972
  * Format: int32
@@ -829,6 +1042,7 @@ export interface components {
829
1042
  };
830
1043
  /** @description Global PnL webhook payload. */
831
1044
  GlobalPnlPayload: {
1045
+ /** @description Trader wallet address. */
832
1046
  trader?: string | null;
833
1047
  /** @description Aggregation timeframe: "1d", "7d", "30d", or "lifetime" */
834
1048
  timeframe: string;
@@ -837,83 +1051,194 @@ export interface components {
837
1051
  * @description Realized PnL for the timeframe (matches REST `/pnl/global`).
838
1052
  */
839
1053
  realized_pnl_usd?: number | null;
840
- /** Format: int64 */
1054
+ /**
1055
+ * Format: int64
1056
+ * @description Events traded.
1057
+ */
841
1058
  events_traded?: number | null;
842
- /** Format: int64 */
1059
+ /**
1060
+ * Format: int64
1061
+ * @description Markets traded.
1062
+ */
843
1063
  markets_traded?: number | null;
844
- /** Format: int64 */
1064
+ /**
1065
+ * Format: int64
1066
+ * @description Total buy count.
1067
+ */
845
1068
  total_buys?: number | null;
846
- /** Format: int64 */
1069
+ /**
1070
+ * Format: int64
1071
+ * @description Total sell count.
1072
+ */
847
1073
  total_sells?: number | null;
848
- /** Format: int64 */
1074
+ /**
1075
+ * Format: int64
1076
+ * @description Total redemption count.
1077
+ */
849
1078
  total_redemptions?: number | null;
850
- /** Format: int64 */
1079
+ /**
1080
+ * Format: int64
1081
+ * @description Total merge count.
1082
+ */
851
1083
  total_merges?: number | null;
852
- /** Format: int64 */
1084
+ /**
1085
+ * Format: int64
1086
+ * @description Total split count.
1087
+ */
853
1088
  total_splits?: number | null;
854
- /** Format: double */
1089
+ /**
1090
+ * Format: double
1091
+ * @description Total volume in USD.
1092
+ */
855
1093
  total_volume_usd?: number | null;
856
- /** Format: double */
1094
+ /**
1095
+ * Format: double
1096
+ * @description Buy volume in USD.
1097
+ */
857
1098
  buy_volume_usd?: number | null;
858
- /** Format: double */
1099
+ /**
1100
+ * Format: double
1101
+ * @description Sell volume in USD.
1102
+ */
859
1103
  sell_volume_usd?: number | null;
860
- /** Format: double */
861
- redemption_volume_usd?: number | null;
862
- /** Format: double */
1104
+ /**
1105
+ * Format: double
1106
+ * @description Redemption volume in USD.
1107
+ */
1108
+ redemption_volume_usd?: number | null;
1109
+ /**
1110
+ * Format: double
1111
+ * @description Merge volume in USD.
1112
+ */
863
1113
  merge_volume_usd?: number | null;
864
- /** Format: double */
1114
+ /**
1115
+ * Format: double
1116
+ * @description Convert collateral in USD.
1117
+ */
865
1118
  convert_collateral_usd?: number | null;
866
- /** Format: double */
1119
+ /**
1120
+ * Format: double
1121
+ * @description Split volume in USD.
1122
+ */
867
1123
  split_volume_usd?: number | null;
868
- /** Format: int64 */
1124
+ /**
1125
+ * Format: int64
1126
+ * @description Maker rebate count.
1127
+ */
869
1128
  maker_rebate_count?: number | null;
870
- /** Format: double */
1129
+ /**
1130
+ * Format: double
1131
+ * @description Maker rebate in USD.
1132
+ */
871
1133
  maker_rebate_usd?: number | null;
872
- /** Format: int64 */
1134
+ /**
1135
+ * Format: int64
1136
+ * @description Reward count.
1137
+ */
873
1138
  reward_count?: number | null;
874
- /** Format: double */
1139
+ /**
1140
+ * Format: double
1141
+ * @description Reward in USD.
1142
+ */
875
1143
  reward_usd?: number | null;
876
- /** Format: int64 */
1144
+ /**
1145
+ * Format: int64
1146
+ * @description Yield count.
1147
+ */
877
1148
  yield_count?: number | null;
878
- /** Format: double */
1149
+ /**
1150
+ * Format: double
1151
+ * @description Yield in USD.
1152
+ */
879
1153
  yield_usd?: number | null;
880
- /** Format: int64 */
1154
+ /**
1155
+ * Format: int64
1156
+ * @description Total credit count.
1157
+ */
881
1158
  total_credit_count?: number | null;
882
- /** Format: double */
1159
+ /**
1160
+ * Format: double
1161
+ * @description Total credit in USD.
1162
+ */
883
1163
  total_credit_usd?: number | null;
884
- /** Format: int64 */
1164
+ /**
1165
+ * Format: int64
1166
+ * @description Markets won.
1167
+ */
885
1168
  markets_won?: number | null;
886
- /** Format: int64 */
1169
+ /**
1170
+ * Format: int64
1171
+ * @description Markets lost.
1172
+ */
887
1173
  markets_lost?: number | null;
888
- /** Format: double */
1174
+ /**
1175
+ * Format: double
1176
+ * @description Market win rate percent.
1177
+ */
889
1178
  market_win_rate_pct?: number | null;
890
- /** Format: double */
1179
+ /**
1180
+ * Format: double
1181
+ * @description Total wins in USD.
1182
+ */
891
1183
  total_wins_usd?: number | null;
892
- /** Format: double */
1184
+ /**
1185
+ * Format: double
1186
+ * @description Total losses in USD.
1187
+ */
893
1188
  total_losses_usd?: number | null;
894
- /** Format: double */
1189
+ /**
1190
+ * Format: double
1191
+ * @description Average win in USD.
1192
+ */
895
1193
  avg_win_usd?: number | null;
896
- /** Format: double */
1194
+ /**
1195
+ * Format: double
1196
+ * @description Average loss in USD.
1197
+ */
897
1198
  avg_loss_usd?: number | null;
898
- /** Format: double */
1199
+ /**
1200
+ * Format: double
1201
+ * @description Profit factor.
1202
+ */
899
1203
  profit_factor?: number | null;
900
- /** Format: double */
1204
+ /**
1205
+ * Format: double
1206
+ * @description Average hold time seconds.
1207
+ */
901
1208
  avg_hold_time_seconds?: number | null;
902
- /** Format: double */
1209
+ /**
1210
+ * Format: double
1211
+ * @description Total fees amount.
1212
+ */
903
1213
  total_fees?: number | null;
904
- /** Format: double */
1214
+ /**
1215
+ * Format: double
1216
+ * @description Best trade pnl in USD.
1217
+ */
905
1218
  best_trade_pnl_usd?: number | null;
1219
+ /** @description Best trade condition id. */
906
1220
  best_trade_condition_id?: string | null;
907
- /** Format: double */
1221
+ /**
1222
+ * Format: double
1223
+ * @description Worst trade pnl in USD.
1224
+ */
908
1225
  worst_trade_pnl_usd?: number | null;
1226
+ /** @description Worst trade condition id. */
909
1227
  worst_trade_condition_id?: string | null;
910
- /** Format: int64 */
1228
+ /**
1229
+ * Format: int64
1230
+ * @description First trade timestamp.
1231
+ */
911
1232
  first_trade_at?: number | null;
912
- /** Format: int64 */
1233
+ /**
1234
+ * Format: int64
1235
+ * @description Last trade timestamp.
1236
+ */
913
1237
  last_trade_at?: number | null;
914
1238
  };
915
1239
  /** @description Response for GET /v1/webhook/events */
916
1240
  ListEventsResponse: {
1241
+ /** @description Supported webhook events. */
917
1242
  events: components["schemas"]["WebhookEventInfo"][];
918
1243
  };
919
1244
  /** @description Subscription filters for the `market_created` event. All fields are optional. */
@@ -1025,6 +1350,57 @@ export interface components {
1025
1350
  */
1026
1351
  confirmed_at?: number | null;
1027
1352
  };
1353
+ /**
1354
+ * @description Subscription filters for the `market_liquidity` event.
1355
+ *
1356
+ * At least one of `min_liquidity_usd`, `max_liquidity_usd`, or `one_shot` must be set.
1357
+ * Thresholds are edge-triggered: a callback fires when liquidity crosses the threshold,
1358
+ * then re-arms once it crosses back (unless `one_shot`).
1359
+ */
1360
+ MarketLiquidityFilters: {
1361
+ /**
1362
+ * @description Fire-and-delete: when `true`, delete the subscription after its first
1363
+ * successful delivery.
1364
+ */
1365
+ one_shot?: boolean | null;
1366
+ /**
1367
+ * Format: double
1368
+ * @description Fire when total liquidity crosses up through this USD value.
1369
+ */
1370
+ min_liquidity_usd?: number | null;
1371
+ /**
1372
+ * Format: double
1373
+ * @description Fire when total liquidity crosses down through this USD value.
1374
+ */
1375
+ max_liquidity_usd?: number | null;
1376
+ /** @description **Required.** Markets to receive liquidity updates for. */
1377
+ condition_ids: string[];
1378
+ };
1379
+ /** @description Market liquidity webhook payload. */
1380
+ MarketLiquidityPayload: {
1381
+ /** @description Market condition ID. */
1382
+ condition_id: string;
1383
+ /**
1384
+ * Format: double
1385
+ * @description Total order-book liquidity in USD at the time of firing.
1386
+ */
1387
+ liquidity_usd: number;
1388
+ /**
1389
+ * Format: double
1390
+ * @description The threshold (USD) that was crossed.
1391
+ */
1392
+ threshold_usd: number;
1393
+ /**
1394
+ * @description `"above"` when liquidity crossed up through `min_liquidity_usd`,
1395
+ * `"below"` when it crossed down through `max_liquidity_usd`.
1396
+ */
1397
+ direction: string;
1398
+ /**
1399
+ * Format: int64
1400
+ * @description Update timestamp (Unix millis).
1401
+ */
1402
+ liquidity_updated_at: number;
1403
+ };
1028
1404
  /** @description Subscription filters for the `condition_metrics` event. All fields are optional. */
1029
1405
  MarketMetricsFilters: {
1030
1406
  /**
@@ -1064,47 +1440,105 @@ export interface components {
1064
1440
  };
1065
1441
  /** @description Market PnL webhook payload. */
1066
1442
  MarketPnlPayload: {
1443
+ /** @description Trader wallet address. */
1067
1444
  trader?: string | null;
1445
+ /** @description Market condition ID. */
1068
1446
  condition_id?: string | null;
1447
+ /** @description Event slug. */
1069
1448
  event_slug?: string | null;
1449
+ /** @description Category. */
1070
1450
  category?: string | null;
1071
1451
  /** @description Aggregation timeframe: "1d", "7d", "30d", or "lifetime" */
1072
1452
  timeframe: string;
1073
- /** Format: double */
1453
+ /**
1454
+ * Format: double
1455
+ * @description Realized pnl in USD.
1456
+ */
1074
1457
  realized_pnl_usd?: number | null;
1075
- /** Format: double */
1458
+ /**
1459
+ * Format: double
1460
+ * @description Current shares balance.
1461
+ */
1076
1462
  current_shares_balance?: number | null;
1077
- /** Format: int64 */
1463
+ /**
1464
+ * Format: int64
1465
+ * @description Number of outcomes traded.
1466
+ */
1078
1467
  outcomes_traded?: number | null;
1079
- /** Format: int64 */
1468
+ /**
1469
+ * Format: int64
1470
+ * @description Total buy count.
1471
+ */
1080
1472
  total_buys?: number | null;
1081
- /** Format: int64 */
1473
+ /**
1474
+ * Format: int64
1475
+ * @description Total sell count.
1476
+ */
1082
1477
  total_sells?: number | null;
1083
- /** Format: int64 */
1478
+ /**
1479
+ * Format: int64
1480
+ * @description Total redemption count.
1481
+ */
1084
1482
  total_redemptions?: number | null;
1085
- /** Format: int64 */
1483
+ /**
1484
+ * Format: int64
1485
+ * @description Total merge count.
1486
+ */
1086
1487
  total_merges?: number | null;
1087
- /** Format: int64 */
1488
+ /**
1489
+ * Format: int64
1490
+ * @description Total split count.
1491
+ */
1088
1492
  total_splits?: number | null;
1089
- /** Format: double */
1493
+ /**
1494
+ * Format: double
1495
+ * @description Buy in USD.
1496
+ */
1090
1497
  buy_usd?: number | null;
1091
- /** Format: double */
1498
+ /**
1499
+ * Format: double
1500
+ * @description Sell in USD.
1501
+ */
1092
1502
  sell_usd?: number | null;
1093
- /** Format: double */
1503
+ /**
1504
+ * Format: double
1505
+ * @description Redemption in USD.
1506
+ */
1094
1507
  redemption_usd?: number | null;
1095
- /** Format: double */
1508
+ /**
1509
+ * Format: double
1510
+ * @description Merge in USD.
1511
+ */
1096
1512
  merge_usd?: number | null;
1097
- /** Format: double */
1513
+ /**
1514
+ * Format: double
1515
+ * @description Convert collateral in USD.
1516
+ */
1098
1517
  convert_collateral_usd?: number | null;
1099
- /** Format: double */
1518
+ /**
1519
+ * Format: double
1520
+ * @description Split volume in USD.
1521
+ */
1100
1522
  split_volume_usd?: number | null;
1101
- /** Format: double */
1523
+ /**
1524
+ * Format: double
1525
+ * @description Total fees amount.
1526
+ */
1102
1527
  total_fees?: number | null;
1103
- /** Format: double */
1528
+ /**
1529
+ * Format: double
1530
+ * @description Total shares bought.
1531
+ */
1104
1532
  total_shares_bought?: number | null;
1105
- /** Format: int64 */
1533
+ /**
1534
+ * Format: int64
1535
+ * @description First trade timestamp.
1536
+ */
1106
1537
  first_trade_at?: number | null;
1107
- /** Format: int64 */
1538
+ /**
1539
+ * Format: int64
1540
+ * @description Last trade timestamp.
1541
+ */
1108
1542
  last_trade_at?: number | null;
1109
1543
  };
1110
1544
  /** @description Subscription filters for the `market_resolved` event. All fields are optional. */
@@ -1199,11 +1633,17 @@ export interface components {
1199
1633
  };
1200
1634
  /** @description Market volume spike webhook payload */
1201
1635
  MarketVolumeSpikePayload: {
1636
+ /** @description Market condition ID. */
1202
1637
  condition_id: string;
1638
+ /** @description Market question. */
1203
1639
  question?: string | null;
1640
+ /** @description Market slug. */
1204
1641
  market_slug?: string | null;
1642
+ /** @description Event slug. */
1205
1643
  event_slug?: string | null;
1644
+ /** @description Image URL. */
1206
1645
  image_url?: string | null;
1646
+ /** @description Metric timeframe. */
1207
1647
  timeframe: string;
1208
1648
  /**
1209
1649
  * Format: double
@@ -1413,6 +1853,7 @@ export interface components {
1413
1853
  /**
1414
1854
  * @description CLOB V2 builder code (lower-cased `0x...` bytes32 hex). Absent on V1
1415
1855
  * trades; may be `0x0000…` for V2 trades placed without a builder code.
1856
+ * CLOB builder code.
1416
1857
  */
1417
1858
  builder_code?: string | null;
1418
1859
  /**
@@ -1515,7 +1956,7 @@ export interface components {
1515
1956
  * @description Polymarket webhook event types
1516
1957
  * @enum {string}
1517
1958
  */
1518
- PolymarketWebhookEvent: "trader_first_trade" | "trader_new_market" | "trader_whale_trade" | "trader_new_trade" | "trader_trade_event" | "trader_global_pnl" | "trader_market_pnl" | "trader_category_pnl" | "trader_position_resolved" | "trader_exit_markers" | "position_holder_metrics" | "condition_holder_metrics" | "event_holder_metrics" | "condition_metrics" | "event_metrics" | "tag_metrics" | "position_metrics" | "market_volume_milestone" | "event_volume_milestone" | "position_volume_milestone" | "probability_spike" | "market_volume_spike" | "event_volume_spike" | "position_volume_spike" | "close_to_bond" | "market_created" | "asset_price_tick" | "asset_price_window_update" | "price_spike" | "oracle_events" | "price_threshold" | "market_resolved" | "market_disputed";
1959
+ PolymarketWebhookEvent: "trader_first_trade" | "trader_new_market" | "trader_whale_trade" | "trader_new_trade" | "trader_trade_event" | "trader_global_pnl" | "trader_market_pnl" | "trader_category_pnl" | "trader_position_resolved" | "trader_exit_markers" | "position_holder_metrics" | "condition_holder_metrics" | "event_holder_metrics" | "condition_metrics" | "event_metrics" | "tag_metrics" | "position_metrics" | "position_liquidity" | "market_liquidity" | "event_liquidity" | "market_volume_milestone" | "event_volume_milestone" | "position_volume_milestone" | "probability_spike" | "market_volume_spike" | "event_volume_spike" | "position_volume_spike" | "close_to_bond" | "market_created" | "asset_price_tick" | "asset_price_window_update" | "price_spike" | "oracle_events" | "price_threshold" | "market_resolved" | "market_disputed";
1519
1960
  /**
1520
1961
  * @description Polymarket-specific webhook filters
1521
1962
  *
@@ -1550,27 +1991,41 @@ export interface components {
1550
1991
  * Implements Hash + Eq manually (f64 fields use bit representation)
1551
1992
  */
1552
1993
  PolymarketWebhookFilter: {
1553
- /** @description Filter by wallet addresses (for first_trade, normalized to lowercase). Max 500 entries. */
1994
+ /**
1995
+ * @description Filter by wallet addresses (for first_trade, normalized to lowercase). Max 500 entries.
1996
+ * Wallet addresses to match.
1997
+ */
1554
1998
  wallet_addresses?: string[];
1555
- /** @description Filter by trader addresses (for PnL webhooks, normalized to lowercase). Max 500 entries. */
1999
+ /**
2000
+ * @description Filter by trader addresses (for PnL webhooks, normalized to lowercase). Max 500 entries.
2001
+ * Trader wallet addresses to match.
2002
+ */
1556
2003
  traders?: string[];
1557
- /** @description Filter by market/condition IDs. Max 500 entries. */
2004
+ /**
2005
+ * @description Filter by market/condition IDs. Max 500 entries.
2006
+ * Market condition IDs to match.
2007
+ */
1558
2008
  condition_ids?: string[];
1559
2009
  /**
1560
2010
  * Format: double
1561
2011
  * @description Filter by minimum USD value (for trades)
1562
2012
  */
1563
2013
  min_usd_value?: number | null;
1564
- /** @description Filter by event slugs. Max 500 entries. */
2014
+ /**
2015
+ * @description Filter by event slugs. Max 500 entries.
2016
+ * Event slugs to match.
2017
+ */
1565
2018
  event_slugs?: string[];
1566
2019
  /**
1567
2020
  * @description Filter by tags or category names (case-insensitive). Matches a market's
1568
2021
  * tags or its category label. Max 500 entries.
2022
+ * Tags to match.
1569
2023
  */
1570
2024
  tags?: string[];
1571
2025
  /**
1572
2026
  * @description Filter by series slugs (case-insensitive). Matches a market's parent
1573
2027
  * series. Max 500 entries.
2028
+ * Series slugs to match.
1574
2029
  */
1575
2030
  series_slugs?: string[];
1576
2031
  /**
@@ -1603,6 +2058,18 @@ export interface components {
1603
2058
  * @description Maximum volume (USD) - for metrics webhooks
1604
2059
  */
1605
2060
  max_volume_usd?: number | null;
2061
+ /**
2062
+ * Format: double
2063
+ * @description Minimum order-book liquidity (USD) - for liquidity webhooks.
2064
+ * Fires when liquidity crosses up through this value.
2065
+ */
2066
+ min_liquidity_usd?: number | null;
2067
+ /**
2068
+ * Format: double
2069
+ * @description Maximum order-book liquidity (USD) - for liquidity webhooks.
2070
+ * Fires when liquidity crosses down through this value.
2071
+ */
2072
+ max_liquidity_usd?: number | null;
1606
2073
  /**
1607
2074
  * Format: double
1608
2075
  * @description Minimum buy volume (USD) - for PnL and metrics webhooks
@@ -1628,16 +2095,26 @@ export interface components {
1628
2095
  * @description Maximum net shares - for position PnL webhooks
1629
2096
  */
1630
2097
  max_net_shares?: number | null;
1631
- /** @description Filter by position IDs - for position PnL webhooks. Max 500 entries. */
2098
+ /**
2099
+ * @description Filter by position IDs - for position PnL webhooks. Max 500 entries.
2100
+ * Outcome token IDs to match.
2101
+ */
1632
2102
  position_ids?: string[];
1633
- /** @description Filter by outcomes (e.g., "Yes", "No") - for position PnL webhooks. Max 500 entries. */
2103
+ /**
2104
+ * @description Filter by outcomes (e.g., "Yes", "No") - for position PnL webhooks. Max 500 entries.
2105
+ * Outcome names to match.
2106
+ */
1634
2107
  outcomes?: string[];
1635
2108
  /**
1636
2109
  * @description Filter by position outcome index — for close_to_bond. Position 0 usually represents Yes/Up, 1 = No.
1637
2110
  * When non-empty, only trades whose outcome_index is in this list will match. Max 500 entries.
2111
+ * Outcome indices to match.
1638
2112
  */
1639
2113
  position_outcome_indices?: number[];
1640
- /** @description Filter by trade type (e.g. "OrderFilled", "Redemption", "Merge", "Split"). Empty = default behavior per handler. */
2114
+ /**
2115
+ * @description Filter by trade type (e.g. "OrderFilled", "Redemption", "Merge", "Split"). Empty = default behavior per handler.
2116
+ * Trade types to match.
2117
+ */
1641
2118
  trade_types?: string[];
1642
2119
  /**
1643
2120
  * Format: double
@@ -1669,9 +2146,15 @@ export interface components {
1669
2146
  * @description Minimum probability change percentage - for position metrics webhooks
1670
2147
  */
1671
2148
  min_probability_change_pct?: number | null;
1672
- /** @description Timeframes to track - for metrics webhooks (1m, 5m, 30m, 1h, 6h, 24h, 7d, 30d). */
2149
+ /**
2150
+ * @description Timeframes to track - for metrics webhooks (1m, 5m, 30m, 1h, 6h, 24h, 7d, 30d).
2151
+ * Metric timeframes to match.
2152
+ */
1673
2153
  timeframes?: components["schemas"]["WebhookTimeframe"][];
1674
- /** @description Milestone amounts to track - for volume milestone webhooks (e.g., 10000, 100000, 1000000). Max 500 entries. */
2154
+ /**
2155
+ * @description Milestone amounts to track - for volume milestone webhooks (e.g., 10000, 100000, 1000000). Max 500 entries.
2156
+ * Milestone amounts to match.
2157
+ */
1675
2158
  milestone_amounts?: number[];
1676
2159
  /**
1677
2160
  * Format: double
@@ -1690,6 +2173,7 @@ export interface components {
1690
2173
  /**
1691
2174
  * @description Filter by crypto asset symbol — for `asset_price_tick` and `asset_price_window_update` webhooks.
1692
2175
  * Valid values: "BTC", "ETH", "SOL", "XRP", "DOGE", "BNB", "HYPE". Empty = all assets.
2176
+ * Asset symbols to match.
1693
2177
  */
1694
2178
  asset_symbols?: components["schemas"]["WebhookAssetSymbol"][];
1695
2179
  spike_direction?: null | components["schemas"]["SpikeDirection"];
@@ -1713,6 +2197,7 @@ export interface components {
1713
2197
  * `QuestionInitialized`, `QuestionPaused`, `QuestionUnpaused`,
1714
2198
  * `QuestionFlagged`, `QuestionUnflagged`, `ConditionResolution`,
1715
2199
  * `NegRiskOutcomeReported`. Empty = all types.
2200
+ * Oracle event types to match.
1716
2201
  */
1717
2202
  oracle_event_types?: string[];
1718
2203
  /**
@@ -1728,6 +2213,7 @@ export interface components {
1728
2213
  fire_if_already_past?: boolean;
1729
2214
  };
1730
2215
  PositionHolderMetricsFilters: {
2216
+ /** @description Outcome token IDs to match. */
1731
2217
  position_ids?: string[];
1732
2218
  /**
1733
2219
  * @description Fire-and-delete: when `true`, delete the subscription after its first
@@ -1736,22 +2222,95 @@ export interface components {
1736
2222
  one_shot?: boolean | null;
1737
2223
  };
1738
2224
  PositionHolderMetricsPayload: {
1739
- /** Format: int32 */
2225
+ /**
2226
+ * Format: int32
2227
+ * @description Unix timestamp in seconds.
2228
+ */
1740
2229
  ts: number;
1741
- /** Format: int64 */
2230
+ /**
2231
+ * Format: int64
2232
+ * @description Block number.
2233
+ */
1742
2234
  block: number;
2235
+ /** @description Outcome token ID. */
1743
2236
  position_id: string;
1744
- /** Format: int32 */
2237
+ /**
2238
+ * Format: int32
2239
+ * @description Number of holders.
2240
+ */
1745
2241
  holder_count: number;
1746
- /** Format: double */
2242
+ /**
2243
+ * Format: double
2244
+ * @description Total shares held.
2245
+ */
1747
2246
  total_balance: number;
1748
- /** Format: double */
2247
+ /**
2248
+ * Format: double
2249
+ * @description Total holder cost basis in USD.
2250
+ */
1749
2251
  total_cost_basis: number;
1750
- /** Format: int32 */
2252
+ /**
2253
+ * Format: int32
2254
+ * @description Number of market-level holders.
2255
+ */
1751
2256
  condition_holder_count?: number | null;
1752
- /** Format: int32 */
2257
+ /**
2258
+ * Format: int32
2259
+ * @description Number of event-level holders.
2260
+ */
1753
2261
  event_holder_count?: number | null;
1754
2262
  };
2263
+ /**
2264
+ * @description Subscription filters for the `position_liquidity` event.
2265
+ *
2266
+ * At least one of `min_liquidity_usd`, `max_liquidity_usd`, or `one_shot` must be set.
2267
+ * Thresholds are edge-triggered: a callback fires when liquidity crosses the threshold,
2268
+ * then re-arms once it crosses back (unless `one_shot`).
2269
+ */
2270
+ PositionLiquidityFilters: {
2271
+ /**
2272
+ * @description Fire-and-delete: when `true`, delete the subscription after its first
2273
+ * successful delivery.
2274
+ */
2275
+ one_shot?: boolean | null;
2276
+ /**
2277
+ * Format: double
2278
+ * @description Fire when liquidity crosses up through this USD value.
2279
+ */
2280
+ min_liquidity_usd?: number | null;
2281
+ /**
2282
+ * Format: double
2283
+ * @description Fire when liquidity crosses down through this USD value.
2284
+ */
2285
+ max_liquidity_usd?: number | null;
2286
+ /** @description **Required.** Outcome token IDs to receive liquidity updates for. */
2287
+ position_ids: string[];
2288
+ };
2289
+ /** @description Position liquidity webhook payload. */
2290
+ PositionLiquidityPayload: {
2291
+ /** @description Outcome token (position) ID. */
2292
+ position_id: string;
2293
+ /**
2294
+ * Format: double
2295
+ * @description Order-book liquidity in USD at the time of firing.
2296
+ */
2297
+ liquidity_usd: number;
2298
+ /**
2299
+ * Format: double
2300
+ * @description The threshold (USD) that was crossed.
2301
+ */
2302
+ threshold_usd: number;
2303
+ /**
2304
+ * @description `"above"` when liquidity crossed up through `min_liquidity_usd`,
2305
+ * `"below"` when it crossed down through `max_liquidity_usd`.
2306
+ */
2307
+ direction: string;
2308
+ /**
2309
+ * Format: int64
2310
+ * @description Update timestamp (Unix millis).
2311
+ */
2312
+ liquidity_updated_at: number;
2313
+ };
1755
2314
  /** @description Subscription filters for the `position_metrics` event. All fields are optional. */
1756
2315
  PositionMetricsFilters: {
1757
2316
  /**
@@ -1772,15 +2331,30 @@ export interface components {
1772
2331
  * @description Only fire when position volume ≥ this value (USD).
1773
2332
  */
1774
2333
  min_volume_usd?: number | null;
1775
- /** Format: double */
2334
+ /**
2335
+ * Format: double
2336
+ * @description Maximum volume USD.
2337
+ */
1776
2338
  max_volume_usd?: number | null;
1777
- /** Format: double */
2339
+ /**
2340
+ * Format: double
2341
+ * @description Minimum buy USD.
2342
+ */
1778
2343
  min_buy_usd?: number | null;
1779
- /** Format: double */
2344
+ /**
2345
+ * Format: double
2346
+ * @description Minimum sell volume USD.
2347
+ */
1780
2348
  min_sell_volume_usd?: number | null;
1781
- /** Format: int64 */
2349
+ /**
2350
+ * Format: int64
2351
+ * @description Minimum transactions.
2352
+ */
1782
2353
  min_txns?: number | null;
1783
- /** Format: int64 */
2354
+ /**
2355
+ * Format: int64
2356
+ * @description Minimum unique traders.
2357
+ */
1784
2358
  min_unique_traders?: number | null;
1785
2359
  /**
1786
2360
  * Format: double
@@ -1792,7 +2366,10 @@ export interface components {
1792
2366
  * @description Only fire when probability change % ≥ this value.
1793
2367
  */
1794
2368
  min_probability_change_pct?: number | null;
1795
- /** Format: double */
2369
+ /**
2370
+ * Format: double
2371
+ * @description Minimum fees.
2372
+ */
1796
2373
  min_fees?: number | null;
1797
2374
  };
1798
2375
  /** @description Payload delivered when a position's volume or transaction metrics cross a configured threshold */
@@ -1878,47 +2455,110 @@ export interface components {
1878
2455
  * @description Builder-attributed fees in USD
1879
2456
  */
1880
2457
  builder_fees?: number | null;
1881
- /** Format: int64 */
2458
+ /**
2459
+ * Format: int64
2460
+ * @description Transaction count.
2461
+ */
1882
2462
  txns?: number | null;
1883
- /** Format: int64 */
2463
+ /**
2464
+ * Format: int64
2465
+ * @description Buy count.
2466
+ */
1884
2467
  buys?: number | null;
1885
- /** Format: int64 */
2468
+ /**
2469
+ * Format: int64
2470
+ * @description Sell count.
2471
+ */
1886
2472
  sells?: number | null;
1887
- /** Format: int64 */
2473
+ /**
2474
+ * Format: int64
2475
+ * @description Builder-attributed transaction count.
2476
+ */
1888
2477
  builder_txns?: number | null;
1889
- /** Format: int64 */
2478
+ /**
2479
+ * Format: int64
2480
+ * @description Builder-attributed buy count.
2481
+ */
1890
2482
  builder_buys?: number | null;
1891
- /** Format: int64 */
2483
+ /**
2484
+ * Format: int64
2485
+ * @description Builder-attributed sell count.
2486
+ */
1892
2487
  builder_sells?: number | null;
1893
- /** Format: int64 */
2488
+ /**
2489
+ * Format: int64
2490
+ * @description Unique traders.
2491
+ */
1894
2492
  unique_traders?: number | null;
1895
- /** Format: int64 */
2493
+ /**
2494
+ * Format: int64
2495
+ * @description Unique makers.
2496
+ */
1896
2497
  unique_makers?: number | null;
1897
- /** Format: int64 */
2498
+ /**
2499
+ * Format: int64
2500
+ * @description Unique takers.
2501
+ */
1898
2502
  unique_takers?: number | null;
1899
- /** Format: int64 */
2503
+ /**
2504
+ * Format: int64
2505
+ * @description Unique builder traders.
2506
+ */
1900
2507
  unique_builder_traders?: number | null;
1901
- /** Format: double */
2508
+ /**
2509
+ * Format: double
2510
+ * @description Opening price.
2511
+ */
1902
2512
  price_open?: number | null;
1903
- /** Format: double */
2513
+ /**
2514
+ * Format: double
2515
+ * @description Closing price.
2516
+ */
1904
2517
  price_close?: number | null;
1905
- /** Format: double */
2518
+ /**
2519
+ * Format: double
2520
+ * @description Highest price.
2521
+ */
1906
2522
  price_high?: number | null;
1907
- /** Format: double */
2523
+ /**
2524
+ * Format: double
2525
+ * @description Lowest price.
2526
+ */
1908
2527
  price_low?: number | null;
1909
- /** Format: double */
2528
+ /**
2529
+ * Format: double
2530
+ * @description Opening implied probability.
2531
+ */
1910
2532
  probability_open?: number | null;
1911
- /** Format: double */
2533
+ /**
2534
+ * Format: double
2535
+ * @description Closing implied probability.
2536
+ */
1912
2537
  probability_close?: number | null;
1913
- /** Format: double */
2538
+ /**
2539
+ * Format: double
2540
+ * @description Highest implied probability.
2541
+ */
1914
2542
  probability_high?: number | null;
1915
- /** Format: double */
2543
+ /**
2544
+ * Format: double
2545
+ * @description Lowest implied probability.
2546
+ */
1916
2547
  probability_low?: number | null;
1917
- /** Format: double */
2548
+ /**
2549
+ * Format: double
2550
+ * @description Average shares per trade.
2551
+ */
1918
2552
  avg_trade_shares?: number | null;
1919
- /** Format: double */
2553
+ /**
2554
+ * Format: double
2555
+ * @description Average shares per buy.
2556
+ */
1920
2557
  avg_buy_shares?: number | null;
1921
- /** Format: double */
2558
+ /**
2559
+ * Format: double
2560
+ * @description Average shares per sell.
2561
+ */
1922
2562
  avg_sell_shares?: number | null;
1923
2563
  };
1924
2564
  PositionResolvedPayload: {
@@ -2080,11 +2720,18 @@ export interface components {
2080
2720
  };
2081
2721
  /** @description Position volume milestone webhook payload */
2082
2722
  PositionVolumeMilestonePayload: {
2723
+ /** @description Market condition ID. */
2083
2724
  condition_id?: string | null;
2725
+ /** @description Outcome token ID. */
2084
2726
  position_id: string;
2727
+ /** @description Outcome name. */
2085
2728
  outcome?: string | null;
2086
- /** Format: int32 */
2729
+ /**
2730
+ * Format: int32
2731
+ * @description Outcome index.
2732
+ */
2087
2733
  outcome_index?: number | null;
2734
+ /** @description Metric timeframe. */
2088
2735
  timeframe: string;
2089
2736
  /**
2090
2737
  * Format: double
@@ -2155,15 +2802,26 @@ export interface components {
2155
2802
  };
2156
2803
  /** @description Position volume spike webhook payload */
2157
2804
  PositionVolumeSpikePayload: {
2805
+ /** @description Outcome token ID. */
2158
2806
  position_id: string;
2807
+ /** @description Market condition ID. */
2159
2808
  condition_id: string;
2809
+ /** @description Market question. */
2160
2810
  question?: string | null;
2811
+ /** @description Market slug. */
2161
2812
  market_slug?: string | null;
2813
+ /** @description Event slug. */
2162
2814
  event_slug?: string | null;
2815
+ /** @description Image URL. */
2163
2816
  image_url?: string | null;
2817
+ /** @description Outcome name. */
2164
2818
  outcome?: string | null;
2165
- /** Format: int32 */
2819
+ /**
2820
+ * Format: int32
2821
+ * @description Outcome index.
2822
+ */
2166
2823
  outcome_index?: number | null;
2824
+ /** @description Metric timeframe. */
2167
2825
  timeframe: string;
2168
2826
  /**
2169
2827
  * Format: double
@@ -2251,14 +2909,24 @@ export interface components {
2251
2909
  };
2252
2910
  /** @description Position price spike webhook payload */
2253
2911
  PriceSpikePayload: {
2912
+ /** @description Outcome token ID. */
2254
2913
  position_id: string;
2914
+ /** @description Market condition ID. */
2255
2915
  condition_id?: string | null;
2916
+ /** @description Market question. */
2256
2917
  question?: string | null;
2918
+ /** @description Market slug. */
2257
2919
  market_slug?: string | null;
2920
+ /** @description Event slug. */
2258
2921
  event_slug?: string | null;
2922
+ /** @description Image URL. */
2259
2923
  image_url?: string | null;
2924
+ /** @description Outcome name. */
2260
2925
  outcome?: string | null;
2261
- /** Format: int32 */
2926
+ /**
2927
+ * Format: int32
2928
+ * @description Outcome index.
2929
+ */
2262
2930
  outcome_index?: number | null;
2263
2931
  /**
2264
2932
  * Format: double
@@ -2446,14 +3114,24 @@ export interface components {
2446
3114
  };
2447
3115
  /** @description Position probability spike webhook payload */
2448
3116
  ProbabilitySpikePayload: {
3117
+ /** @description Outcome token ID. */
2449
3118
  position_id: string;
3119
+ /** @description Market condition ID. */
2450
3120
  condition_id?: string | null;
3121
+ /** @description Market question. */
2451
3122
  question?: string | null;
3123
+ /** @description Market slug. */
2452
3124
  market_slug?: string | null;
3125
+ /** @description Event slug. */
2453
3126
  event_slug?: string | null;
3127
+ /** @description Image URL. */
2454
3128
  image_url?: string | null;
3129
+ /** @description Outcome name. */
2455
3130
  outcome?: string | null;
2456
- /** Format: int32 */
3131
+ /**
3132
+ * Format: int32
3133
+ * @description Outcome index.
3134
+ */
2457
3135
  outcome_index?: number | null;
2458
3136
  /**
2459
3137
  * Format: double
@@ -2778,13 +3456,25 @@ export interface components {
2778
3456
  * @description Only fire when aggregated tag volume >= this value (USD).
2779
3457
  */
2780
3458
  min_volume_usd?: number | null;
2781
- /** Format: double */
3459
+ /**
3460
+ * Format: double
3461
+ * @description Maximum volume USD.
3462
+ */
2782
3463
  max_volume_usd?: number | null;
2783
- /** Format: int64 */
3464
+ /**
3465
+ * Format: int64
3466
+ * @description Minimum transactions.
3467
+ */
2784
3468
  min_txns?: number | null;
2785
- /** Format: int64 */
3469
+ /**
3470
+ * Format: int64
3471
+ * @description Minimum unique traders.
3472
+ */
2786
3473
  min_unique_traders?: number | null;
2787
- /** Format: double */
3474
+ /**
3475
+ * Format: double
3476
+ * @description Minimum fees.
3477
+ */
2788
3478
  min_fees?: number | null;
2789
3479
  };
2790
3480
  /** @description Payload delivered when a tag's aggregated volume or transaction metrics cross a configured threshold */
@@ -3224,7 +3914,9 @@ export interface components {
3224
3914
  };
3225
3915
  /** @description Volume milestone webhook payload */
3226
3916
  VolumeMilestonePayload: {
3917
+ /** @description Market condition ID. */
3227
3918
  condition_id: string;
3919
+ /** @description Metric timeframe. */
3228
3920
  timeframe: string;
3229
3921
  /**
3230
3922
  * Format: double
@@ -3612,6 +4304,7 @@ export interface components {
3612
4304
  /**
3613
4305
  * @description CLOB V2 builder code (lower-cased `0x...` bytes32 hex). Absent on V1
3614
4306
  * trades; may be `0x0000…` for V2 trades placed without a builder code.
4307
+ * CLOB builder code.
3615
4308
  */
3616
4309
  builder_code?: string | null;
3617
4310
  /**
@@ -3622,19 +4315,30 @@ export interface components {
3622
4315
  };
3623
4316
  /** @description Server acknowledgement for an oracle events stream subscription */
3624
4317
  OracleEventsStreamSubscribeResponse: {
4318
+ /** @description Accepted market condition IDs. */
3625
4319
  condition_ids?: string[];
4320
+ /** @description Accepted market slugs. */
3626
4321
  market_slugs?: string[];
4322
+ /** @description Accepted event slugs. */
3627
4323
  event_slugs?: string[];
4324
+ /** @description Accepted oracle event types. */
3628
4325
  oracle_event_types?: string[];
3629
- /** @enum {string} */
4326
+ /**
4327
+ * @description Trade status filter.
4328
+ * @enum {string}
4329
+ */
3630
4330
  status?: "confirmed" | "pending" | "all";
4331
+ /** @description Whether to subscribe to all matching events. */
3631
4332
  subscribe_all?: boolean;
3632
4333
  /** @description Filter values that were rejected (invalid format or unknown type) */
3633
4334
  rejected?: string[];
3634
4335
  };
3635
4336
  /** @description Subscribe to the oracle events stream. No filters = subscribe to all events. */
3636
4337
  OracleEventsStreamSubscribeMessage: {
3637
- /** @enum {string} */
4338
+ /**
4339
+ * @description Subscription action.
4340
+ * @enum {string}
4341
+ */
3638
4342
  action: "subscribe" | "unsubscribe_all";
3639
4343
  /** @description 64-char hex condition IDs (with or without 0x prefix) */
3640
4344
  condition_ids?: string[];
@@ -3656,23 +4360,38 @@ export interface components {
3656
4360
  MarketsStreamUpdateEvent: {
3657
4361
  /** @enum {string} */
3658
4362
  type: "markets_stream_update";
3659
- /** @enum {string} */
4363
+ /**
4364
+ * @description WebSocket room ID.
4365
+ * @enum {string}
4366
+ */
3660
4367
  room_id: "polymarket_markets_stream";
3661
- /** @enum {string} */
4368
+ /**
4369
+ * @description Subscription mode.
4370
+ * @enum {string}
4371
+ */
3662
4372
  mode: "filter" | "ids";
3663
- /** @enum {integer} */
4373
+ /**
4374
+ * @description Flush interval in milliseconds.
4375
+ * @enum {integer}
4376
+ */
3664
4377
  interval_ms: 500 | 1000 | 3000 | 10000;
3665
4378
  /** @description Full market rows (same shape as `GET /polymarket/market`). Not a delta — each element is a complete row replacement. */
3666
4379
  data: Record<string, never>[];
3667
4380
  };
3668
4381
  /** @description Server acknowledgement for a markets_stream subscribe/unsubscribe. Envelope type: "markets_stream_subscribe_response". */
3669
4382
  MarketsStreamSubscribeResponse: {
3670
- /** @enum {string} */
4383
+ /**
4384
+ * @description Subscription mode.
4385
+ * @enum {string}
4386
+ */
3671
4387
  mode?: "filter" | "ids" | "";
4388
+ /** @description Flush interval in milliseconds. */
3672
4389
  interval_ms?: number;
3673
4390
  /** @description Accepted condition_ids (ids mode). */
3674
4391
  condition_ids?: string[];
4392
+ /** @description Accepted market slugs. */
3675
4393
  market_slugs?: string[];
4394
+ /** @description Accepted event slugs. */
3676
4395
  event_slugs?: string[];
3677
4396
  /** @description Ids that failed normalization or exceeded the per-sub cap. */
3678
4397
  rejected?: string[];
@@ -3683,21 +4402,39 @@ export interface components {
3683
4402
  MarketsStreamFilter: {
3684
4403
  /** @description Case-insensitive substring match on `title`. 3–100 chars. */
3685
4404
  search?: string;
4405
+ /** @description Categories to include. */
3686
4406
  categories?: string[];
4407
+ /** @description Categories to exclude. */
3687
4408
  exclude_categories?: string[];
4409
+ /** @description Accepted tag slugs. */
3688
4410
  tags?: string[];
4411
+ /** @description Tags to exclude. */
3689
4412
  exclude_tags?: string[];
4413
+ /** @description Minimum volume. */
3690
4414
  min_volume?: number;
4415
+ /** @description Maximum volume. */
3691
4416
  max_volume?: number;
4417
+ /** @description Minimum transaction count. */
3692
4418
  min_txns?: number;
4419
+ /** @description Maximum transaction count. */
3693
4420
  max_txns?: number;
4421
+ /** @description Minimum unique trader count. */
3694
4422
  min_unique_traders?: number;
4423
+ /** @description Maximum unique trader count. */
3695
4424
  max_unique_traders?: number;
4425
+ /** @description Minimum liquidity. */
3696
4426
  min_liquidity?: number;
4427
+ /** @description Maximum liquidity. */
3697
4428
  max_liquidity?: number;
3698
- /** Format: int64 */
4429
+ /**
4430
+ * Format: int64
4431
+ * @description Minimum holder count.
4432
+ */
3699
4433
  min_holders?: number;
3700
- /** Format: int64 */
4434
+ /**
4435
+ * Format: int64
4436
+ * @description Maximum holder count.
4437
+ */
3701
4438
  max_holders?: number;
3702
4439
  /**
3703
4440
  * Format: int64
@@ -3719,7 +4456,10 @@ export interface components {
3719
4456
  };
3720
4457
  /** @description Subscribe to the trades stream. No filters = subscribe to all trades. */
3721
4458
  TradesStreamSubscribeMessage: {
3722
- /** @enum {string} */
4459
+ /**
4460
+ * @description Subscription action.
4461
+ * @enum {string}
4462
+ */
3723
4463
  action: "subscribe" | "unsubscribe_all";
3724
4464
  /** @description 64-char hex condition IDs (with or without 0x prefix) */
3725
4465
  condition_ids?: string[];
@@ -3743,14 +4483,24 @@ export interface components {
3743
4483
  };
3744
4484
  /** @description Server acknowledgement for a trades stream subscription */
3745
4485
  TradesStreamSubscribeResponse: {
4486
+ /** @description Accepted market condition IDs. */
3746
4487
  condition_ids?: string[];
4488
+ /** @description Accepted market slugs. */
3747
4489
  market_slugs?: string[];
4490
+ /** @description Accepted event slugs. */
3748
4491
  event_slugs?: string[];
4492
+ /** @description Accepted outcome token IDs. */
3749
4493
  position_ids?: string[];
4494
+ /** @description Accepted trader wallets. */
3750
4495
  traders?: string[];
4496
+ /** @description Accepted trade types. */
3751
4497
  trade_types?: string[];
3752
- /** @enum {string} */
4498
+ /**
4499
+ * @description Trade status filter.
4500
+ * @enum {string}
4501
+ */
3753
4502
  status?: "confirmed" | "pending" | "all";
4503
+ /** @description Whether to subscribe to all matching events. */
3754
4504
  subscribe_all?: boolean;
3755
4505
  /** @description Filter values that were rejected (invalid format or unknown type) */
3756
4506
  rejected?: string[];
@@ -3763,9 +4513,14 @@ export interface components {
3763
4513
  * **Pending trades:** `block`, `confirmed_at`, `log_index`, `block_index` are absent. `received_at` (milliseconds) is included instead. For OrderFilled/OrdersMatched, `order_hash`, `taker`, `fee`, `fee_shares`, `fee_pct` are also absent.
3764
4514
  */
3765
4515
  TradeStreamEvent: {
3766
- /** @enum {string} */
4516
+ /**
4517
+ * @description Trade type.
4518
+ * @enum {string}
4519
+ */
3767
4520
  trade_type: "OrderFilled" | "OrdersMatched";
4521
+ /** @description Event ID. */
3768
4522
  id: string;
4523
+ /** @description Transaction hash. */
3769
4524
  hash: string;
3770
4525
  /** @description Absent for pending trades */
3771
4526
  block?: number;
@@ -3780,28 +4535,49 @@ export interface components {
3780
4535
  /** @description Absent for pending trades */
3781
4536
  order_hash?: string;
3782
4537
  trader: {
4538
+ /** @description Wallet address. */
3783
4539
  address?: string;
4540
+ /** @description Display name. */
3784
4541
  name?: string | null;
4542
+ /** @description Pseudonym. */
3785
4543
  pseudonym?: string | null;
4544
+ /** @description Profile image URL. */
3786
4545
  profile_image?: string | null;
4546
+ /** @description X username. */
3787
4547
  x_username?: string | null;
4548
+ /** @description Whether the profile is verified. */
3788
4549
  verified_badge?: boolean;
3789
4550
  };
3790
4551
  /** @description Absent for pending trades */
3791
4552
  taker?: string;
3792
- /** @enum {string} */
4553
+ /**
4554
+ * @description Trade side.
4555
+ * @enum {string}
4556
+ */
3793
4557
  side?: "Buy" | "Sell";
4558
+ /** @description Market condition ID. */
3794
4559
  condition_id?: string | null;
4560
+ /** @description Outcome token ID. */
3795
4561
  position_id?: string;
4562
+ /** @description Outcome name. */
3796
4563
  outcome?: string | null;
4564
+ /** @description Outcome index. */
3797
4565
  outcome_index?: number | null;
4566
+ /** @description Market question. */
3798
4567
  question?: string | null;
4568
+ /** @description Image URL. */
3799
4569
  image_url?: string | null;
4570
+ /** @description Market slug. */
3800
4571
  slug?: string | null;
4572
+ /** @description Event slug. */
3801
4573
  event_slug?: string | null;
4574
+ /** @description Trade amount in USD. */
3802
4575
  usd_amount?: number;
4576
+ /** @description Trade size in shares. */
3803
4577
  shares_amount?: number;
4578
+ /** @description Outcome price. */
3804
4579
  price?: number;
4580
+ /** @description Implied probability. */
3805
4581
  probability?: number | null;
3806
4582
  /** @description Absent for pending trades */
3807
4583
  fee?: number;
@@ -3809,31 +4585,49 @@ export interface components {
3809
4585
  fee_shares?: number;
3810
4586
  /** @description Absent for pending trades */
3811
4587
  fee_pct?: number;
4588
+ /** @description Exchange identifier. */
3812
4589
  exchange: number;
3813
4590
  /** @description CLOB V2 builder code (lower-cased `0x...` bytes32 hex). Absent on V1 trades; may be `0x0000…` for V2 trades placed without a builder code. */
3814
4591
  builder_code?: string;
3815
4592
  /** @description Builder fee in USDC. Absent when no builder code is attached. */
3816
4593
  builder_fee?: number;
3817
4594
  } | {
3818
- /** @enum {string} */
4595
+ /**
4596
+ * @description Trade type.
4597
+ * @enum {string}
4598
+ */
3819
4599
  trade_type: "MakerRebate" | "Reward" | "Yield";
4600
+ /** @description Event ID. */
3820
4601
  id: string;
4602
+ /** @description Transaction hash. */
3821
4603
  hash: string;
4604
+ /** @description Block number. */
3822
4605
  block?: number;
4606
+ /** @description Confirmation timestamp. */
3823
4607
  confirmed_at?: number;
4608
+ /** @description Receive timestamp. */
3824
4609
  received_at?: number;
4610
+ /** @description Log index. */
3825
4611
  log_index?: number;
4612
+ /** @description Block index. */
3826
4613
  block_index?: number;
3827
4614
  trader: {
4615
+ /** @description Wallet address. */
3828
4616
  address?: string;
4617
+ /** @description Display name. */
3829
4618
  name?: string | null;
4619
+ /** @description Pseudonym. */
3830
4620
  pseudonym?: string | null;
4621
+ /** @description Profile image URL. */
3831
4622
  profile_image?: string | null;
4623
+ /** @description X username. */
3832
4624
  x_username?: string | null;
4625
+ /** @description Whether the profile is verified. */
3833
4626
  verified_badge?: boolean;
3834
4627
  };
3835
4628
  /** @description Payout distributor address */
3836
4629
  taker?: string;
4630
+ /** @description Trade amount in USD. */
3837
4631
  usd_amount?: number;
3838
4632
  /** @description Always 0 for payout credits */
3839
4633
  shares_amount?: number;
@@ -3848,195 +4642,370 @@ export interface components {
3848
4642
  /** @description Unknown/non-exchange credit source */
3849
4643
  exchange: number;
3850
4644
  } | {
3851
- /** @enum {string} */
4645
+ /**
4646
+ * @description Trade type.
4647
+ * @enum {string}
4648
+ */
3852
4649
  trade_type: "Redemption";
4650
+ /** @description Event ID. */
3853
4651
  id: string;
4652
+ /** @description Transaction hash. */
3854
4653
  hash: string;
4654
+ /** @description Block number. */
3855
4655
  block?: number;
4656
+ /** @description Confirmation timestamp. */
3856
4657
  confirmed_at?: number;
4658
+ /** @description Receive timestamp. */
3857
4659
  received_at?: number;
4660
+ /** @description Log index. */
3858
4661
  log_index?: number;
4662
+ /** @description Block index. */
3859
4663
  block_index?: number;
3860
4664
  trader: {
4665
+ /** @description Wallet address. */
3861
4666
  address?: string;
4667
+ /** @description Display name. */
3862
4668
  name?: string | null;
4669
+ /** @description Pseudonym. */
3863
4670
  pseudonym?: string | null;
4671
+ /** @description Profile image URL. */
3864
4672
  profile_image?: string | null;
4673
+ /** @description X username. */
3865
4674
  x_username?: string | null;
4675
+ /** @description Whether the profile is verified. */
3866
4676
  verified_badge?: boolean;
3867
4677
  };
4678
+ /** @description Market condition ID. */
3868
4679
  condition_id?: string | null;
4680
+ /** @description Outcome name. */
3869
4681
  outcome?: string | null;
4682
+ /** @description Outcome index. */
3870
4683
  outcome_index?: number | null;
4684
+ /** @description Market question. */
3871
4685
  question?: string | null;
4686
+ /** @description Image URL. */
3872
4687
  image_url?: string | null;
4688
+ /** @description Market slug. */
3873
4689
  slug?: string | null;
4690
+ /** @description Event slug. */
3874
4691
  event_slug?: string | null;
4692
+ /** @description Trade amount in USD. */
3875
4693
  usd_amount?: number;
4694
+ /** @description Winning outcome index. */
3876
4695
  winning_outcome_index?: number | null;
4696
+ /** @description Position details. */
3877
4697
  position_details?: {
4698
+ /** @description Outcome token ID. */
3878
4699
  position_id?: string;
4700
+ /** @description Outcome index. */
3879
4701
  outcome_index?: number;
4702
+ /** @description Amount as a decimal string. */
3880
4703
  amount?: string;
3881
4704
  }[];
4705
+ /** @description Exchange identifier. */
3882
4706
  exchange: number;
3883
4707
  } | {
3884
- /** @enum {string} */
4708
+ /**
4709
+ * @description Trade type.
4710
+ * @enum {string}
4711
+ */
3885
4712
  trade_type: "Merge";
4713
+ /** @description Event ID. */
3886
4714
  id: string;
4715
+ /** @description Transaction hash. */
3887
4716
  hash: string;
4717
+ /** @description Block number. */
3888
4718
  block?: number;
4719
+ /** @description Confirmation timestamp. */
3889
4720
  confirmed_at?: number;
4721
+ /** @description Receive timestamp. */
3890
4722
  received_at?: number;
4723
+ /** @description Log index. */
3891
4724
  log_index?: number;
4725
+ /** @description Block index. */
3892
4726
  block_index?: number;
3893
4727
  trader: {
4728
+ /** @description Wallet address. */
3894
4729
  address?: string;
4730
+ /** @description Display name. */
3895
4731
  name?: string | null;
4732
+ /** @description Pseudonym. */
3896
4733
  pseudonym?: string | null;
4734
+ /** @description Profile image URL. */
3897
4735
  profile_image?: string | null;
4736
+ /** @description X username. */
3898
4737
  x_username?: string | null;
4738
+ /** @description Whether the profile is verified. */
3899
4739
  verified_badge?: boolean;
3900
4740
  };
4741
+ /** @description Market condition ID. */
3901
4742
  condition_id?: string | null;
4743
+ /** @description Market question. */
3902
4744
  question?: string | null;
4745
+ /** @description Image URL. */
3903
4746
  image_url?: string | null;
4747
+ /** @description Market slug. */
3904
4748
  slug?: string | null;
4749
+ /** @description Event slug. */
3905
4750
  event_slug?: string | null;
4751
+ /** @description Trade amount in USD. */
3906
4752
  usd_amount?: number;
4753
+ /** @description Position details. */
3907
4754
  position_details?: {
4755
+ /** @description Outcome token ID. */
3908
4756
  position_id?: string;
4757
+ /** @description Outcome index. */
3909
4758
  outcome_index?: number;
4759
+ /** @description Amount as a decimal string. */
3910
4760
  amount?: string;
3911
4761
  }[];
4762
+ /** @description Exchange identifier. */
3912
4763
  exchange: number;
3913
4764
  } | {
3914
- /** @enum {string} */
4765
+ /**
4766
+ * @description Trade type.
4767
+ * @enum {string}
4768
+ */
3915
4769
  trade_type: "Split";
4770
+ /** @description Event ID. */
3916
4771
  id: string;
4772
+ /** @description Transaction hash. */
3917
4773
  hash: string;
4774
+ /** @description Block number. */
3918
4775
  block?: number;
4776
+ /** @description Confirmation timestamp. */
3919
4777
  confirmed_at?: number;
4778
+ /** @description Receive timestamp. */
3920
4779
  received_at?: number;
4780
+ /** @description Log index. */
3921
4781
  log_index?: number;
4782
+ /** @description Block index. */
3922
4783
  block_index?: number;
3923
4784
  trader: {
4785
+ /** @description Wallet address. */
3924
4786
  address?: string;
4787
+ /** @description Display name. */
3925
4788
  name?: string | null;
4789
+ /** @description Pseudonym. */
3926
4790
  pseudonym?: string | null;
4791
+ /** @description Profile image URL. */
3927
4792
  profile_image?: string | null;
4793
+ /** @description X username. */
3928
4794
  x_username?: string | null;
4795
+ /** @description Whether the profile is verified. */
3929
4796
  verified_badge?: boolean;
3930
4797
  };
4798
+ /** @description Market condition ID. */
3931
4799
  condition_id?: string | null;
4800
+ /** @description Market question. */
3932
4801
  question?: string | null;
4802
+ /** @description Image URL. */
3933
4803
  image_url?: string | null;
4804
+ /** @description Market slug. */
3934
4805
  slug?: string | null;
4806
+ /** @description Event slug. */
3935
4807
  event_slug?: string | null;
4808
+ /** @description Trade amount in USD. */
3936
4809
  usd_amount?: number;
4810
+ /** @description Position details. */
3937
4811
  position_details?: {
4812
+ /** @description Outcome token ID. */
3938
4813
  position_id?: string;
4814
+ /** @description Outcome index. */
3939
4815
  outcome_index?: number;
4816
+ /** @description Amount as a decimal string. */
3940
4817
  amount?: string;
3941
4818
  }[];
4819
+ /** @description Exchange identifier. */
3942
4820
  exchange: number;
3943
4821
  } | {
3944
- /** @enum {string} */
4822
+ /**
4823
+ * @description Trade type.
4824
+ * @enum {string}
4825
+ */
3945
4826
  trade_type: "PositionsConverted";
4827
+ /** @description Event ID. */
3946
4828
  id: string;
4829
+ /** @description Transaction hash. */
3947
4830
  hash: string;
4831
+ /** @description Block number. */
3948
4832
  block?: number;
4833
+ /** @description Confirmation timestamp. */
3949
4834
  confirmed_at?: number;
4835
+ /** @description Receive timestamp. */
3950
4836
  received_at?: number;
4837
+ /** @description Log index. */
3951
4838
  log_index?: number;
4839
+ /** @description Block index. */
3952
4840
  block_index?: number;
3953
4841
  trader: {
4842
+ /** @description Wallet address. */
3954
4843
  address?: string;
4844
+ /** @description Display name. */
3955
4845
  name?: string | null;
4846
+ /** @description Pseudonym. */
3956
4847
  pseudonym?: string | null;
4848
+ /** @description Profile image URL. */
3957
4849
  profile_image?: string | null;
4850
+ /** @description X username. */
3958
4851
  x_username?: string | null;
4852
+ /** @description Whether the profile is verified. */
3959
4853
  verified_badge?: boolean;
3960
4854
  };
4855
+ /** @description Market id. */
3961
4856
  market_id?: string;
4857
+ /** @description Index set. */
3962
4858
  index_set?: string;
4859
+ /** @description Trade size in shares. */
3963
4860
  shares_amount?: number;
4861
+ /** @description Fee. */
3964
4862
  fee?: number;
4863
+ /** @description Fee percent. */
3965
4864
  fee_pct?: number;
3966
4865
  /** @description Per-position conversion amounts */
3967
4866
  position_details?: {
4867
+ /** @description Outcome token ID. */
3968
4868
  position_id?: string;
4869
+ /** @description Outcome index. */
3969
4870
  outcome_index?: number;
4871
+ /** @description Amount as a decimal string. */
3970
4872
  amount?: string;
3971
4873
  }[];
4874
+ /** @description Exchange identifier. */
3972
4875
  exchange: number;
3973
4876
  } | {
3974
- /** @enum {string} */
4877
+ /**
4878
+ * @description Trade type.
4879
+ * @enum {string}
4880
+ */
3975
4881
  trade_type: "Cancelled";
4882
+ /** @description Event ID. */
3976
4883
  id: string;
4884
+ /** @description Transaction hash. */
3977
4885
  hash: string;
4886
+ /** @description Block number. */
3978
4887
  block?: number;
4888
+ /** @description Confirmation timestamp. */
3979
4889
  confirmed_at?: number;
4890
+ /** @description Receive timestamp. */
3980
4891
  received_at?: number;
4892
+ /** @description Log index. */
3981
4893
  log_index?: number;
4894
+ /** @description Block index. */
3982
4895
  block_index?: number;
4896
+ /** @description Order hash. */
3983
4897
  order_hash?: string;
4898
+ /** @description Market question. */
3984
4899
  question?: string | null;
4900
+ /** @description Image URL. */
3985
4901
  image_url?: string | null;
4902
+ /** @description Market slug. */
3986
4903
  slug?: string | null;
4904
+ /** @description Event slug. */
3987
4905
  event_slug?: string | null;
4906
+ /** @description Exchange identifier. */
3988
4907
  exchange: number;
3989
4908
  } | {
3990
- /** @enum {string} */
4909
+ /**
4910
+ * @description Oracle lifecycle event type.
4911
+ * @enum {string}
4912
+ */
3991
4913
  trade_type: "Initialization" | "Proposal" | "Dispute" | "Settled" | "Resolution" | "ConditionResolution" | "Reset" | "Flag" | "Unflag" | "Pause" | "Unpause" | "ManualResolution" | "NegRiskOutcomeReported";
4914
+ /** @description Event ID. */
3992
4915
  id: string;
4916
+ /** @description Transaction hash. */
3993
4917
  hash: string;
4918
+ /** @description Block number. */
3994
4919
  block?: number;
4920
+ /** @description Confirmation timestamp. */
3995
4921
  confirmed_at?: number;
4922
+ /** @description Receive timestamp. */
3996
4923
  received_at?: number;
4924
+ /** @description Log index. */
3997
4925
  log_index?: number;
4926
+ /** @description Block index. */
3998
4927
  block_index?: number;
4928
+ /** @description Oracle contract. */
3999
4929
  oracle_contract: string;
4930
+ /** @description Market condition ID. */
4000
4931
  condition_id: string;
4932
+ /** @description Market question. */
4001
4933
  question?: string | null;
4934
+ /** @description Image URL. */
4002
4935
  image_url?: string | null;
4936
+ /** @description Market slug. */
4003
4937
  slug?: string | null;
4938
+ /** @description Event slug. */
4004
4939
  event_slug?: string | null;
4940
+ /** @description Assertion id. */
4005
4941
  assertion_id?: string | null;
4942
+ /** @description Proposer. */
4006
4943
  proposer?: string | null;
4944
+ /** @description Disputer. */
4007
4945
  disputer?: string | null;
4946
+ /** @description Proposed outcome. */
4008
4947
  proposed_outcome?: string | null;
4948
+ /** @description Settled price. */
4009
4949
  settled_price?: number | null;
4950
+ /** @description Disputed. */
4010
4951
  disputed?: boolean | null;
4952
+ /** @description Settlement resolution. */
4011
4953
  settlement_resolution?: boolean | null;
4954
+ /** @description Bond. */
4012
4955
  bond?: string | null;
4956
+ /** @description Expiration time. */
4013
4957
  expiration_time?: number | null;
4958
+ /** @description Creator. */
4014
4959
  creator?: string | null;
4960
+ /** @description Reward token. */
4015
4961
  reward_token?: string | null;
4962
+ /** @description Reward details. */
4016
4963
  reward?: string | null;
4964
+ /** @description Proposal bond. */
4017
4965
  proposal_bond?: string | null;
4018
4966
  } | {
4019
- /** @enum {string} */
4967
+ /**
4968
+ * @description Trade type.
4969
+ * @enum {string}
4970
+ */
4020
4971
  trade_type: "RegisterToken";
4972
+ /** @description Event ID. */
4021
4973
  id: string;
4974
+ /** @description Transaction hash. */
4022
4975
  hash: string;
4976
+ /** @description Block number. */
4023
4977
  block?: number;
4978
+ /** @description Confirmation timestamp. */
4024
4979
  confirmed_at?: number;
4980
+ /** @description Receive timestamp. */
4025
4981
  received_at?: number;
4982
+ /** @description Log index. */
4026
4983
  log_index?: number;
4984
+ /** @description Block index. */
4027
4985
  block_index?: number;
4986
+ /** @description Market condition ID. */
4028
4987
  condition_id: string;
4988
+ /** @description Token0. */
4029
4989
  token0?: string;
4990
+ /** @description Token1. */
4030
4991
  token1?: string;
4992
+ /** @description Market question. */
4031
4993
  question?: string | null;
4994
+ /** @description Image URL. */
4032
4995
  image_url?: string | null;
4996
+ /** @description Market slug. */
4033
4997
  slug?: string | null;
4998
+ /** @description Event slug. */
4034
4999
  event_slug?: string | null;
5000
+ /** @description Exchange identifier. */
4035
5001
  exchange: number;
4036
5002
  };
4037
5003
  /** @description Subscribe to the asset prices stream. Empty asset_symbols = all assets. */
4038
5004
  AssetPricesSubscribeMessage: {
4039
- /** @enum {string} */
5005
+ /**
5006
+ * @description Subscription action.
5007
+ * @enum {string}
5008
+ */
4040
5009
  action: "subscribe" | "unsubscribe_all";
4041
5010
  /** @description Uppercase asset symbols (BTC, ETH, SOL, XRP, DOGE, BNB, HYPE). Empty = subscribe to all. */
4042
5011
  asset_symbols?: string[];
@@ -4097,7 +5066,10 @@ export interface components {
4097
5066
  };
4098
5067
  /** @description Subscribe to the asset window updates stream. At least one of asset_symbols or timeframes must be non-empty. */
4099
5068
  AssetWindowUpdatesSubscribeMessage: {
4100
- /** @enum {string} */
5069
+ /**
5070
+ * @description Subscription action.
5071
+ * @enum {string}
5072
+ */
4101
5073
  action: "subscribe" | "unsubscribe_all";
4102
5074
  /** @description Uppercase asset symbols (BTC, ETH, SOL, XRP, DOGE, BNB, HYPE) */
4103
5075
  asset_symbols?: string[];
@@ -4106,7 +5078,9 @@ export interface components {
4106
5078
  };
4107
5079
  /** @description Server acknowledgement for an asset window updates subscription */
4108
5080
  AssetWindowUpdatesSubscribeResponse: {
5081
+ /** @description Accepted asset symbols. */
4109
5082
  asset_symbols?: string[];
5083
+ /** @description Accepted metric timeframes. */
4110
5084
  timeframes?: string[];
4111
5085
  /** @description Set if the subscription was rejected (e.g. no filters provided) */
4112
5086
  error?: string | null;
@@ -4115,15 +5089,21 @@ export interface components {
4115
5089
  AssetWindowUpdateEvent: components["schemas"]["AssetPriceWindowUpdateEvent"];
4116
5090
  /** @description Subscribe to the market metrics stream. condition_ids is required and must be non-empty. */
4117
5091
  MarketMetricsSubscribeMessage: {
4118
- /** @enum {string} */
5092
+ /**
5093
+ * @description Subscription action.
5094
+ * @enum {string}
5095
+ */
4119
5096
  action: "subscribe" | "unsubscribe_all";
4120
5097
  /** @description 64-char hex condition IDs (with or without 0x prefix) */
4121
5098
  condition_ids: string[];
5099
+ /** @description Accepted metric timeframes. */
4122
5100
  timeframes?: ("1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d" | "lifetime")[];
4123
5101
  };
4124
5102
  /** @description Server acknowledgement for a market metrics subscription */
4125
5103
  MarketMetricsSubscribeResponse: {
5104
+ /** @description Accepted market condition IDs. */
4126
5105
  condition_ids?: string[];
5106
+ /** @description Accepted metric timeframes. */
4127
5107
  timeframes?: string[];
4128
5108
  /** @description Condition IDs that were rejected (invalid format) */
4129
5109
  rejected?: string[];
@@ -4134,7 +5114,10 @@ export interface components {
4134
5114
  MarketMetricsEvent: {
4135
5115
  /** @description 64-char hex condition ID */
4136
5116
  condition_id: string;
4137
- /** @enum {string} */
5117
+ /**
5118
+ * @description Metric timeframe.
5119
+ * @enum {string}
5120
+ */
4138
5121
  timeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d" | "lifetime";
4139
5122
  /**
4140
5123
  * Format: int64
@@ -4163,34 +5146,58 @@ export interface components {
4163
5146
  * @description Builder-attributed transactions
4164
5147
  */
4165
5148
  builder_txns: number;
4166
- /** Format: int64 */
5149
+ /**
5150
+ * Format: int64
5151
+ * @description Unique trader count.
5152
+ */
4167
5153
  unique_traders: number;
4168
- /** Format: int64 */
5154
+ /**
5155
+ * Format: int64
5156
+ * @description Unique maker count.
5157
+ */
4169
5158
  unique_makers: number;
4170
- /** Format: int64 */
5159
+ /**
5160
+ * Format: int64
5161
+ * @description Unique taker count.
5162
+ */
4171
5163
  unique_takers: number;
4172
- /** Format: int64 */
5164
+ /**
5165
+ * Format: int64
5166
+ * @description Unique builder-attributed trader count.
5167
+ */
4173
5168
  unique_builder_traders: number;
4174
5169
  };
4175
5170
  /** @description Subscribe to the event metrics stream. event_slugs is required and must be non-empty. */
4176
5171
  EventMetricsSubscribeMessage: {
4177
- /** @enum {string} */
5172
+ /**
5173
+ * @description Subscription action.
5174
+ * @enum {string}
5175
+ */
4178
5176
  action: "subscribe" | "unsubscribe_all";
4179
5177
  /** @description Event slugs (lowercase) */
4180
5178
  event_slugs: string[];
5179
+ /** @description Accepted metric timeframes. */
4181
5180
  timeframes?: ("1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d" | "lifetime")[];
4182
5181
  };
4183
5182
  /** @description Server acknowledgement for an event metrics subscription */
4184
5183
  EventMetricsSubscribeResponse: {
5184
+ /** @description Accepted event slugs. */
4185
5185
  event_slugs?: string[];
5186
+ /** @description Accepted metric timeframes. */
4186
5187
  timeframes?: string[];
5188
+ /** @description Rejected filter values. */
4187
5189
  rejected?: string[];
5190
+ /** @description Subscription error message. */
4188
5191
  error?: string | null;
4189
5192
  };
4190
5193
  /** @description Server-pushed event: aggregated metrics update for one timeframe of an event. Envelope type: "event_metrics_update". One event is emitted per timeframe window on each update. */
4191
5194
  EventMetricsEvent: {
5195
+ /** @description Event slug. */
4192
5196
  event_slug: string;
4193
- /** @enum {string} */
5197
+ /**
5198
+ * @description Metric timeframe.
5199
+ * @enum {string}
5200
+ */
4194
5201
  timeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d" | "lifetime";
4195
5202
  /**
4196
5203
  * Format: int64
@@ -4205,40 +5212,72 @@ export interface components {
4205
5212
  builder_usd_volume: string;
4206
5213
  /** @description Builder-attributed shares/contracts volume in this timeframe window (decimal string) */
4207
5214
  builder_shares_volume: string;
5215
+ /** @description Total fees. */
4208
5216
  fees: number;
5217
+ /** @description Builder-attributed fees. */
4209
5218
  builder_fees: number;
4210
- /** Format: int64 */
5219
+ /**
5220
+ * Format: int64
5221
+ * @description Transaction count.
5222
+ */
4211
5223
  txns: number;
4212
- /** Format: int64 */
5224
+ /**
5225
+ * Format: int64
5226
+ * @description Builder-attributed transaction count.
5227
+ */
4213
5228
  builder_txns: number;
4214
- /** Format: int64 */
5229
+ /**
5230
+ * Format: int64
5231
+ * @description Unique trader count.
5232
+ */
4215
5233
  unique_traders: number;
4216
- /** Format: int64 */
5234
+ /**
5235
+ * Format: int64
5236
+ * @description Unique maker count.
5237
+ */
4217
5238
  unique_makers: number;
4218
- /** Format: int64 */
5239
+ /**
5240
+ * Format: int64
5241
+ * @description Unique taker count.
5242
+ */
4219
5243
  unique_takers: number;
4220
- /** Format: int64 */
5244
+ /**
5245
+ * Format: int64
5246
+ * @description Unique builder-attributed trader count.
5247
+ */
4221
5248
  unique_builder_traders: number;
4222
5249
  };
4223
5250
  /** @description Subscribe to the tag metrics stream. tags is required and must be non-empty. */
4224
5251
  TagMetricsSubscribeMessage: {
4225
- /** @enum {string} */
5252
+ /**
5253
+ * @description Subscription action.
5254
+ * @enum {string}
5255
+ */
4226
5256
  action: "subscribe" | "unsubscribe_all";
4227
5257
  /** @description Tag labels or slugs, matched case-insensitively */
4228
5258
  tags: string[];
5259
+ /** @description Accepted metric timeframes. */
4229
5260
  timeframes?: ("1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d" | "lifetime")[];
4230
5261
  };
4231
5262
  /** @description Server acknowledgement for a tag metrics subscription */
4232
5263
  TagMetricsSubscribeResponse: {
5264
+ /** @description Accepted tag slugs. */
4233
5265
  tags?: string[];
5266
+ /** @description Accepted metric timeframes. */
4234
5267
  timeframes?: string[];
5268
+ /** @description Rejected filter values. */
4235
5269
  rejected?: string[];
5270
+ /** @description Subscription error message. */
4236
5271
  error?: string | null;
4237
5272
  };
4238
5273
  /** @description Server-pushed event: aggregated metrics update for one timeframe of a tag. Envelope type: "tag_metrics_update". One event is emitted per timeframe window on each update. */
4239
5274
  TagMetricsEvent: {
5275
+ /** @description Tag slug. */
4240
5276
  tag: string;
4241
- /** @enum {string} */
5277
+ /**
5278
+ * @description Metric timeframe.
5279
+ * @enum {string}
5280
+ */
4242
5281
  timeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d" | "lifetime";
4243
5282
  /**
4244
5283
  * Format: int64
@@ -4253,34 +5292,62 @@ export interface components {
4253
5292
  builder_usd_volume: string;
4254
5293
  /** @description Builder-attributed shares/contracts volume in this timeframe window (decimal string) */
4255
5294
  builder_shares_volume: string;
5295
+ /** @description Total fees. */
4256
5296
  fees: number;
5297
+ /** @description Builder-attributed fees. */
4257
5298
  builder_fees: number;
4258
- /** Format: int64 */
5299
+ /**
5300
+ * Format: int64
5301
+ * @description Transaction count.
5302
+ */
4259
5303
  txns: number;
4260
- /** Format: int64 */
5304
+ /**
5305
+ * Format: int64
5306
+ * @description Builder-attributed transaction count.
5307
+ */
4261
5308
  builder_txns: number;
4262
- /** Format: int64 */
5309
+ /**
5310
+ * Format: int64
5311
+ * @description Unique trader count.
5312
+ */
4263
5313
  unique_traders: number;
4264
- /** Format: int64 */
5314
+ /**
5315
+ * Format: int64
5316
+ * @description Unique maker count.
5317
+ */
4265
5318
  unique_makers: number;
4266
- /** Format: int64 */
5319
+ /**
5320
+ * Format: int64
5321
+ * @description Unique taker count.
5322
+ */
4267
5323
  unique_takers: number;
4268
- /** Format: int64 */
5324
+ /**
5325
+ * Format: int64
5326
+ * @description Unique builder-attributed trader count.
5327
+ */
4269
5328
  unique_builder_traders: number;
4270
5329
  };
4271
5330
  /** @description Subscribe to the position metrics stream. position_ids is required and must be non-empty. */
4272
5331
  PositionMetricsSubscribeMessage: {
4273
- /** @enum {string} */
5332
+ /**
5333
+ * @description Subscription action.
5334
+ * @enum {string}
5335
+ */
4274
5336
  action: "subscribe" | "unsubscribe_all";
4275
5337
  /** @description ERC-1155 outcome token IDs (decimal or hex strings) */
4276
5338
  position_ids: string[];
5339
+ /** @description Accepted metric timeframes. */
4277
5340
  timeframes?: ("1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d" | "lifetime")[];
4278
5341
  };
4279
5342
  /** @description Server acknowledgement for a position metrics subscription */
4280
5343
  PositionMetricsSubscribeResponse: {
5344
+ /** @description Accepted outcome token IDs. */
4281
5345
  position_ids?: string[];
5346
+ /** @description Accepted metric timeframes. */
4282
5347
  timeframes?: string[];
5348
+ /** @description Rejected filter values. */
4283
5349
  rejected?: string[];
5350
+ /** @description Subscription error message. */
4284
5351
  error?: string | null;
4285
5352
  };
4286
5353
  /** @description Server-pushed event: metrics update for one timeframe of an outcome token. Envelope type: "position_metrics_update". One event is emitted per timeframe window on each update. */
@@ -4291,8 +5358,12 @@ export interface components {
4291
5358
  position_id: string;
4292
5359
  /** @description Outcome name (e.g. "Yes") */
4293
5360
  outcome?: string | null;
5361
+ /** @description Outcome index. */
4294
5362
  outcome_index?: number | null;
4295
- /** @enum {string} */
5363
+ /**
5364
+ * @description Metric timeframe.
5365
+ * @enum {string}
5366
+ */
4296
5367
  timeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d" | "lifetime";
4297
5368
  /**
4298
5369
  * Format: int64
@@ -4323,27 +5394,59 @@ export interface components {
4323
5394
  builder_shares_buy_volume: string;
4324
5395
  /** @description Builder-attributed sell shares/contracts volume (decimal string) */
4325
5396
  builder_shares_sell_volume: string;
5397
+ /** @description Total fees. */
4326
5398
  fees: number;
5399
+ /** @description Builder-attributed fees. */
4327
5400
  builder_fees: number;
4328
- /** Format: int64 */
5401
+ /**
5402
+ * Format: int64
5403
+ * @description Transaction count.
5404
+ */
4329
5405
  txns: number;
4330
- /** Format: int64 */
5406
+ /**
5407
+ * Format: int64
5408
+ * @description Buy count.
5409
+ */
4331
5410
  buys: number;
4332
- /** Format: int64 */
5411
+ /**
5412
+ * Format: int64
5413
+ * @description Sell count.
5414
+ */
4333
5415
  sells: number;
4334
- /** Format: int64 */
5416
+ /**
5417
+ * Format: int64
5418
+ * @description Builder-attributed transaction count.
5419
+ */
4335
5420
  builder_txns: number;
4336
- /** Format: int64 */
5421
+ /**
5422
+ * Format: int64
5423
+ * @description Builder-attributed buy count.
5424
+ */
4337
5425
  builder_buys: number;
4338
- /** Format: int64 */
5426
+ /**
5427
+ * Format: int64
5428
+ * @description Builder-attributed sell count.
5429
+ */
4339
5430
  builder_sells: number;
4340
- /** Format: int64 */
5431
+ /**
5432
+ * Format: int64
5433
+ * @description Unique trader count.
5434
+ */
4341
5435
  unique_traders: number;
4342
- /** Format: int64 */
5436
+ /**
5437
+ * Format: int64
5438
+ * @description Unique maker count.
5439
+ */
4343
5440
  unique_makers: number;
4344
- /** Format: int64 */
5441
+ /**
5442
+ * Format: int64
5443
+ * @description Unique taker count.
5444
+ */
4345
5445
  unique_takers: number;
4346
- /** Format: int64 */
5446
+ /**
5447
+ * Format: int64
5448
+ * @description Unique builder-attributed trader count.
5449
+ */
4347
5450
  unique_builder_traders: number;
4348
5451
  /** @description OHLC open price (0–1) */
4349
5452
  price_open: number;
@@ -4361,13 +5464,85 @@ export interface components {
4361
5464
  probability_high: number;
4362
5465
  /** @description Lowest implied probability in window (0–1) */
4363
5466
  probability_low: number;
5467
+ /** @description Average shares per trade. */
4364
5468
  avg_trade_shares: number;
5469
+ /** @description Average shares per buy. */
4365
5470
  avg_buy_shares: number;
5471
+ /** @description Average shares per sell. */
4366
5472
  avg_sell_shares: number;
4367
5473
  };
5474
+ /** @description Subscribe to the position liquidity stream. position_ids is optional — omit for firehose. */
5475
+ PositionLiquiditySubscribeMessage: {
5476
+ /**
5477
+ * @description Subscription action.
5478
+ * @enum {string}
5479
+ */
5480
+ action: "subscribe" | "unsubscribe_all";
5481
+ /** @description ERC-1155 outcome token IDs (decimal or hex). Empty/omitted = all positions. */
5482
+ position_ids?: string[];
5483
+ };
5484
+ /** @description Server-pushed event: latest USD liquidity for an outcome token. Envelope type: "position_liquidity_update". */
5485
+ PositionLiquidityEvent: {
5486
+ /** @description ERC-1155 token ID (decimal string) */
5487
+ position_id: string;
5488
+ /** @description Order-book liquidity in USD */
5489
+ liquidity_usd: number;
5490
+ /**
5491
+ * Format: int64
5492
+ * @description Update timestamp (Unix millis)
5493
+ */
5494
+ liquidity_updated_at: number;
5495
+ };
5496
+ /** @description Subscribe to the market liquidity stream. condition_ids is optional — omit for firehose. */
5497
+ MarketLiquiditySubscribeMessage: {
5498
+ /**
5499
+ * @description Subscription action.
5500
+ * @enum {string}
5501
+ */
5502
+ action: "subscribe" | "unsubscribe_all";
5503
+ /** @description 64-char hex market IDs. Empty/omitted = all markets. */
5504
+ condition_ids?: string[];
5505
+ };
5506
+ /** @description Server-pushed event: latest total USD liquidity for a market. Envelope type: "market_liquidity_update". */
5507
+ MarketLiquidityEvent: {
5508
+ /** @description 64-char hex condition ID */
5509
+ condition_id: string;
5510
+ /** @description Total order-book liquidity in USD */
5511
+ liquidity_usd: number;
5512
+ /**
5513
+ * Format: int64
5514
+ * @description Update timestamp (Unix millis)
5515
+ */
5516
+ liquidity_updated_at: number;
5517
+ };
5518
+ /** @description Subscribe to the event liquidity stream. event_slugs is optional — omit for firehose. */
5519
+ EventLiquiditySubscribeMessage: {
5520
+ /**
5521
+ * @description Subscription action.
5522
+ * @enum {string}
5523
+ */
5524
+ action: "subscribe" | "unsubscribe_all";
5525
+ /** @description Event slugs. Empty/omitted = all events. */
5526
+ event_slugs?: string[];
5527
+ };
5528
+ /** @description Server-pushed event: latest total USD liquidity for an event. Envelope type: "event_liquidity_update". */
5529
+ EventLiquidityEvent: {
5530
+ /** @description Event slug */
5531
+ event_slug: string;
5532
+ /** @description Total order-book liquidity in USD */
5533
+ liquidity_usd: number;
5534
+ /**
5535
+ * Format: int64
5536
+ * @description Update timestamp (Unix millis)
5537
+ */
5538
+ liquidity_updated_at: number;
5539
+ };
4368
5540
  /** @description Subscribe to the trader PnL stream. `traders` is required and must be non-empty. `update_types` and `timeframes` are optional narrowing filters — omit or leave empty to receive all update types / timeframes. */
4369
5541
  TraderPnlSubscribeMessage: {
4370
- /** @enum {string} */
5542
+ /**
5543
+ * @description Subscription action.
5544
+ * @enum {string}
5545
+ */
4371
5546
  action: "subscribe" | "unsubscribe_all";
4372
5547
  /** @description EVM wallet addresses */
4373
5548
  traders: string[];
@@ -4380,6 +5555,7 @@ export interface components {
4380
5555
  };
4381
5556
  /** @description Server acknowledgement for a trader PnL subscription. Echoes the accepted (normalized) filter sets so clients can confirm the active subscription. */
4382
5557
  TraderPnlSubscribeResponse: {
5558
+ /** @description Accepted trader wallets. */
4383
5559
  traders?: string[];
4384
5560
  /** @description Accepted update types. Empty = all. */
4385
5561
  update_types?: ("global" | "market" | "category")[];
@@ -4394,58 +5570,120 @@ export interface components {
4394
5570
  TraderGlobalPnlRow: {
4395
5571
  /** @description Trader EVM wallet address */
4396
5572
  trader: string;
5573
+ /** @description Dirty update kinds included in this event. */
4397
5574
  dirty_kinds?: ("trade" | "price" | "window" | "market_resolved")[];
4398
5575
  /** @description "1d", "7d", "30d", or "lifetime" */
4399
5576
  timeframe?: string | null;
4400
5577
  /** @description Realized PnL for the timeframe */
4401
5578
  realized_pnl_usd: number;
4402
- /** Format: int64 */
5579
+ /**
5580
+ * Format: int64
5581
+ * @description Events traded.
5582
+ */
4403
5583
  events_traded?: number;
4404
- /** Format: int64 */
5584
+ /**
5585
+ * Format: int64
5586
+ * @description Markets traded.
5587
+ */
4405
5588
  markets_traded?: number;
4406
- /** Format: int64 */
5589
+ /**
5590
+ * Format: int64
5591
+ * @description Total buy count.
5592
+ */
4407
5593
  total_buys?: number;
4408
- /** Format: int64 */
5594
+ /**
5595
+ * Format: int64
5596
+ * @description Total sell count.
5597
+ */
4409
5598
  total_sells?: number;
4410
- /** Format: int64 */
5599
+ /**
5600
+ * Format: int64
5601
+ * @description Total redemption count.
5602
+ */
4411
5603
  total_redemptions?: number;
4412
- /** Format: int64 */
5604
+ /**
5605
+ * Format: int64
5606
+ * @description Total merge count.
5607
+ */
4413
5608
  total_merges?: number;
4414
- /** Format: int64 */
5609
+ /**
5610
+ * Format: int64
5611
+ * @description Total split count.
5612
+ */
4415
5613
  total_splits?: number;
5614
+ /** @description Total volume in USD. */
4416
5615
  total_volume_usd?: number;
5616
+ /** @description Buy volume in USD. */
4417
5617
  buy_volume_usd?: number;
5618
+ /** @description Sell volume in USD. */
4418
5619
  sell_volume_usd?: number;
5620
+ /** @description Redemption volume in USD. */
4419
5621
  redemption_volume_usd?: number;
5622
+ /** @description Merge volume in USD. */
4420
5623
  merge_volume_usd?: number;
5624
+ /** @description Split volume in USD. */
4421
5625
  split_volume_usd?: number;
4422
- /** Format: int64 */
5626
+ /**
5627
+ * Format: int64
5628
+ * @description Maker rebate count.
5629
+ */
4423
5630
  maker_rebate_count?: number;
5631
+ /** @description Maker rebates in USD. */
4424
5632
  maker_rebate_usd?: number;
4425
- /** Format: int64 */
5633
+ /**
5634
+ * Format: int64
5635
+ * @description Reward count.
5636
+ */
4426
5637
  reward_count?: number;
5638
+ /** @description Rewards in USD. */
4427
5639
  reward_usd?: number;
4428
- /** Format: int64 */
5640
+ /**
5641
+ * Format: int64
5642
+ * @description Yield count.
5643
+ */
4429
5644
  yield_count?: number;
5645
+ /** @description Yield in USD. */
4430
5646
  yield_usd?: number;
4431
- /** Format: int64 */
5647
+ /**
5648
+ * Format: int64
5649
+ * @description Total credit count.
5650
+ */
4432
5651
  total_credit_count?: number;
5652
+ /** @description Total credits in USD. */
4433
5653
  total_credit_usd?: number;
4434
- /** Format: int64 */
5654
+ /**
5655
+ * Format: int64
5656
+ * @description Markets won.
5657
+ */
4435
5658
  markets_won?: number;
4436
- /** Format: int64 */
5659
+ /**
5660
+ * Format: int64
5661
+ * @description Markets lost.
5662
+ */
4437
5663
  markets_lost?: number;
5664
+ /** @description Market win rate percent. */
4438
5665
  market_win_rate_pct?: number;
5666
+ /** @description Total wins in USD. */
4439
5667
  total_wins_usd?: number;
5668
+ /** @description Total losses in USD. */
4440
5669
  total_losses_usd?: number;
5670
+ /** @description Average win in USD. */
4441
5671
  avg_win_usd?: number | null;
5672
+ /** @description Average loss in USD. */
4442
5673
  avg_loss_usd?: number | null;
5674
+ /** @description Profit factor. */
4443
5675
  profit_factor?: number | null;
5676
+ /** @description Average hold time in seconds. */
4444
5677
  avg_hold_time_seconds?: number;
5678
+ /** @description Total fees. */
4445
5679
  total_fees?: number;
5680
+ /** @description Best trade PnL in USD. */
4446
5681
  best_trade_pnl_usd?: number | null;
5682
+ /** @description Best trade condition ID. */
4447
5683
  best_trade_condition_id?: string | null;
5684
+ /** @description Worst trade PnL in USD. */
4448
5685
  worst_trade_pnl_usd?: number | null;
5686
+ /** @description Worst trade condition ID. */
4449
5687
  worst_trade_condition_id?: string | null;
4450
5688
  /**
4451
5689
  * Format: int64
@@ -4460,34 +5698,65 @@ export interface components {
4460
5698
  };
4461
5699
  /** @description One per-market PnL row inside a `trader_market_pnl_batch` envelope's `data` array. */
4462
5700
  TraderMarketPnlRow: {
5701
+ /** @description Trader wallet address. */
4463
5702
  trader: string;
5703
+ /** @description Dirty update kinds included in this event. */
4464
5704
  dirty_kinds?: ("trade" | "price" | "window" | "market_resolved")[];
4465
5705
  /** @description "1d", "7d", "30d", or "lifetime" */
4466
5706
  timeframe?: string | null;
4467
5707
  /** @description 64-char hex condition ID */
4468
5708
  condition_id: string;
5709
+ /** @description Realized PnL in USD. */
4469
5710
  realized_pnl_usd?: number;
5711
+ /** @description Current shares balance. */
4470
5712
  current_shares_balance?: number;
5713
+ /** @description Category label. */
4471
5714
  category?: string | null;
5715
+ /** @description Event slug. */
4472
5716
  event_slug?: string | null;
4473
- /** Format: int64 */
5717
+ /**
5718
+ * Format: int64
5719
+ * @description Outcomes traded.
5720
+ */
4474
5721
  outcomes_traded?: number;
4475
- /** Format: int64 */
5722
+ /**
5723
+ * Format: int64
5724
+ * @description Total buy count.
5725
+ */
4476
5726
  total_buys?: number;
4477
- /** Format: int64 */
5727
+ /**
5728
+ * Format: int64
5729
+ * @description Total sell count.
5730
+ */
4478
5731
  total_sells?: number;
4479
- /** Format: int64 */
5732
+ /**
5733
+ * Format: int64
5734
+ * @description Total redemption count.
5735
+ */
4480
5736
  total_redemptions?: number;
4481
- /** Format: int64 */
5737
+ /**
5738
+ * Format: int64
5739
+ * @description Total merge count.
5740
+ */
4482
5741
  total_merges?: number;
4483
- /** Format: int64 */
5742
+ /**
5743
+ * Format: int64
5744
+ * @description Total split count.
5745
+ */
4484
5746
  total_splits?: number;
5747
+ /** @description Buy volume in USD. */
4485
5748
  buy_usd?: number;
5749
+ /** @description Sell volume in USD. */
4486
5750
  sell_usd?: number;
5751
+ /** @description Redemption volume in USD. */
4487
5752
  redemption_usd?: number;
5753
+ /** @description Merge volume in USD. */
4488
5754
  merge_usd?: number;
5755
+ /** @description Split volume in USD. */
4489
5756
  split_volume_usd?: number;
5757
+ /** @description Total fees. */
4490
5758
  total_fees?: number;
5759
+ /** @description Total shares bought. */
4491
5760
  total_shares_bought?: number;
4492
5761
  /**
4493
5762
  * Format: int64
@@ -4502,50 +5771,103 @@ export interface components {
4502
5771
  };
4503
5772
  /** @description One per-category PnL row inside a `trader_category_pnl_batch` envelope's `data` array. */
4504
5773
  TraderCategoryPnlRow: {
5774
+ /** @description Trader wallet address. */
4505
5775
  trader: string;
5776
+ /** @description Dirty update kinds included in this event. */
4506
5777
  dirty_kinds?: ("trade" | "price" | "window" | "market_resolved")[];
4507
5778
  /** @description "1d", "7d", "30d", or "lifetime" */
4508
5779
  timeframe?: string | null;
5780
+ /** @description Category label. */
4509
5781
  category: string;
5782
+ /** @description Realized PnL in USD. */
4510
5783
  realized_pnl_usd?: number;
4511
- /** Format: int64 */
5784
+ /**
5785
+ * Format: int64
5786
+ * @description Markets in this category.
5787
+ */
4512
5788
  markets_in_category?: number;
4513
- /** Format: int64 */
5789
+ /**
5790
+ * Format: int64
5791
+ * @description Markets traded.
5792
+ */
4514
5793
  markets_traded?: number;
4515
- /** Format: int64 */
5794
+ /**
5795
+ * Format: int64
5796
+ * @description Outcomes traded.
5797
+ */
4516
5798
  outcomes_traded?: number;
4517
- /** Format: int64 */
5799
+ /**
5800
+ * Format: int64
5801
+ * @description Total buy count.
5802
+ */
4518
5803
  total_buys?: number;
4519
- /** Format: int64 */
5804
+ /**
5805
+ * Format: int64
5806
+ * @description Total sell count.
5807
+ */
4520
5808
  total_sells?: number;
4521
- /** Format: int64 */
5809
+ /**
5810
+ * Format: int64
5811
+ * @description Total redemption count.
5812
+ */
4522
5813
  total_redemptions?: number;
4523
- /** Format: int64 */
5814
+ /**
5815
+ * Format: int64
5816
+ * @description Total merge count.
5817
+ */
4524
5818
  total_merges?: number;
4525
- /** Format: int64 */
5819
+ /**
5820
+ * Format: int64
5821
+ * @description Total split count.
5822
+ */
4526
5823
  total_splits?: number;
5824
+ /** @description Total volume in USD. */
4527
5825
  total_volume_usd?: number;
5826
+ /** @description Buy volume in USD. */
4528
5827
  buy_usd?: number;
5828
+ /** @description Sell volume in USD. */
4529
5829
  sell_usd?: number;
5830
+ /** @description Redemption volume in USD. */
4530
5831
  redemption_usd?: number;
5832
+ /** @description Merge volume in USD. */
4531
5833
  merge_usd?: number;
5834
+ /** @description Split volume in USD. */
4532
5835
  split_volume_usd?: number;
5836
+ /** @description Total fees. */
4533
5837
  total_fees?: number;
5838
+ /** @description Total shares bought. */
4534
5839
  total_shares_bought?: number;
4535
- /** Format: int64 */
5840
+ /**
5841
+ * Format: int64
5842
+ * @description Markets won.
5843
+ */
4536
5844
  markets_won?: number;
4537
- /** Format: int64 */
5845
+ /**
5846
+ * Format: int64
5847
+ * @description Markets lost.
5848
+ */
4538
5849
  markets_lost?: number;
5850
+ /** @description Market win rate percent. */
4539
5851
  market_win_rate_pct?: number;
5852
+ /** @description Average hold time in seconds. */
4540
5853
  avg_hold_time_seconds?: number;
5854
+ /** @description Best trade PnL in USD. */
4541
5855
  best_trade_pnl_usd?: number | null;
5856
+ /** @description Best trade condition ID. */
4542
5857
  best_trade_condition_id?: string | null;
5858
+ /** @description Worst trade PnL in USD. */
4543
5859
  worst_trade_pnl_usd?: number | null;
5860
+ /** @description Worst trade condition ID. */
4544
5861
  worst_trade_condition_id?: string | null;
5862
+ /** @description Total wins in USD. */
4545
5863
  total_wins_usd?: number;
5864
+ /** @description Total losses in USD. */
4546
5865
  total_losses_usd?: number;
5866
+ /** @description Average win in USD. */
4547
5867
  avg_win_usd?: number | null;
5868
+ /** @description Average loss in USD. */
4548
5869
  avg_loss_usd?: number | null;
5870
+ /** @description Profit factor. */
4549
5871
  profit_factor?: number | null;
4550
5872
  /**
4551
5873
  * Format: int64
@@ -4560,10 +5882,16 @@ export interface components {
4560
5882
  };
4561
5883
  /** @description Row carried by `trader_global_tick_batch` (price-only trader aggregate). */
4562
5884
  TraderGlobalTickRow: {
5885
+ /** @description Trader wallet address. */
4563
5886
  trader: string;
5887
+ /** @description Realized PnL in USD. */
4564
5888
  realized_pnl_usd?: number;
5889
+ /** @description Open positions value. */
4565
5890
  open_positions_value?: number;
4566
- /** Format: int64 */
5891
+ /**
5892
+ * Format: int64
5893
+ * @description Last block number.
5894
+ */
4567
5895
  last_block?: number;
4568
5896
  /**
4569
5897
  * Format: int64
@@ -4574,10 +5902,16 @@ export interface components {
4574
5902
  };
4575
5903
  /** @description Row carried by `trader_market_tick_batch` (price-only per-market). */
4576
5904
  TraderMarketTickRow: {
5905
+ /** @description Trader wallet address. */
4577
5906
  trader: string;
5907
+ /** @description Market condition ID. */
4578
5908
  condition_id: string;
5909
+ /** @description Realized PnL in USD. */
4579
5910
  realized_pnl_usd?: number;
4580
- /** Format: int64 */
5911
+ /**
5912
+ * Format: int64
5913
+ * @description Last block number.
5914
+ */
4581
5915
  last_block?: number;
4582
5916
  /**
4583
5917
  * Format: int64
@@ -4588,10 +5922,16 @@ export interface components {
4588
5922
  };
4589
5923
  /** @description Row carried by `trader_category_tick_batch` (price-only per-category). */
4590
5924
  TraderCategoryTickRow: {
5925
+ /** @description Trader wallet address. */
4591
5926
  trader: string;
5927
+ /** @description Category label. */
4592
5928
  category: string;
5929
+ /** @description Realized PnL in USD. */
4593
5930
  realized_pnl_usd?: number;
4594
- /** Format: int64 */
5931
+ /**
5932
+ * Format: int64
5933
+ * @description Last block number.
5934
+ */
4595
5935
  last_block?: number;
4596
5936
  /**
4597
5937
  * Format: int64
@@ -4602,17 +5942,33 @@ export interface components {
4602
5942
  };
4603
5943
  /** @description Row carried by `trader_global_resolution_batch` (trader-aggregate resolution). */
4604
5944
  TraderGlobalResolutionRow: {
5945
+ /** @description Trader wallet address. */
4605
5946
  trader: string;
5947
+ /** @description Realized PnL in USD. */
4606
5948
  realized_pnl_usd?: number;
4607
- /** Format: int64 */
5949
+ /**
5950
+ * Format: int64
5951
+ * @description Markets won.
5952
+ */
4608
5953
  markets_won?: number;
4609
- /** Format: int64 */
5954
+ /**
5955
+ * Format: int64
5956
+ * @description Markets lost.
5957
+ */
4610
5958
  markets_lost?: number;
4611
- /** Format: int64 */
5959
+ /**
5960
+ * Format: int64
5961
+ * @description Markets resolved.
5962
+ */
4612
5963
  markets_resolved?: number;
5964
+ /** @description Total wins usd lifetime. */
4613
5965
  total_wins_usd_lifetime?: number;
5966
+ /** @description Total losses usd lifetime. */
4614
5967
  total_losses_usd_lifetime?: number;
4615
- /** Format: int64 */
5968
+ /**
5969
+ * Format: int64
5970
+ * @description Last block number.
5971
+ */
4616
5972
  last_block?: number;
4617
5973
  /**
4618
5974
  * Format: int64
@@ -4623,12 +5979,20 @@ export interface components {
4623
5979
  };
4624
5980
  /** @description Row carried by `trader_market_resolution_batch` (per-market resolution). */
4625
5981
  TraderMarketResolutionRow: {
5982
+ /** @description Trader wallet address. */
4626
5983
  trader: string;
5984
+ /** @description Market condition ID. */
4627
5985
  condition_id: string;
5986
+ /** @description Whether the market is resolved. */
4628
5987
  resolved?: boolean;
5988
+ /** @description Whether the position won. */
4629
5989
  won?: boolean | null;
5990
+ /** @description Realized PnL in USD. */
4630
5991
  realized_pnl_usd?: number;
4631
- /** Format: int64 */
5992
+ /**
5993
+ * Format: int64
5994
+ * @description Last block number.
5995
+ */
4632
5996
  last_block?: number;
4633
5997
  /**
4634
5998
  * Format: int64
@@ -4639,16 +6003,30 @@ export interface components {
4639
6003
  };
4640
6004
  /** @description Row carried by `trader_category_resolution_batch` (per-category resolution). */
4641
6005
  TraderCategoryResolutionRow: {
6006
+ /** @description Trader wallet address. */
4642
6007
  trader: string;
6008
+ /** @description Category label. */
4643
6009
  category: string;
6010
+ /** @description Realized PnL in USD. */
4644
6011
  realized_pnl_usd?: number;
4645
- /** Format: int64 */
6012
+ /**
6013
+ * Format: int64
6014
+ * @description Markets won.
6015
+ */
4646
6016
  markets_won?: number;
4647
- /** Format: int64 */
6017
+ /**
6018
+ * Format: int64
6019
+ * @description Markets lost.
6020
+ */
4648
6021
  markets_lost?: number;
6022
+ /** @description Total wins usd lifetime. */
4649
6023
  total_wins_usd_lifetime?: number;
6024
+ /** @description Total losses usd lifetime. */
4650
6025
  total_losses_usd_lifetime?: number;
4651
- /** Format: int64 */
6026
+ /**
6027
+ * Format: int64
6028
+ * @description Last block number.
6029
+ */
4652
6030
  last_block?: number;
4653
6031
  /**
4654
6032
  * Format: int64
@@ -4755,7 +6133,10 @@ export interface components {
4755
6133
  };
4756
6134
  /** @description Subscribe to the trader positions stream. `traders` is required and must be non-empty. `dirty_kinds` is an optional narrowing filter — empty/omitted or `["all"]` = receive every kind of update. */
4757
6135
  TraderPositionsSubscribeMessage: {
4758
- /** @enum {string} */
6136
+ /**
6137
+ * @description Subscription action.
6138
+ * @enum {string}
6139
+ */
4759
6140
  action: "subscribe" | "unsubscribe_all";
4760
6141
  /** @description EVM wallet addresses */
4761
6142
  traders: string[];
@@ -4764,49 +6145,80 @@ export interface components {
4764
6145
  };
4765
6146
  /** @description Server acknowledgement for a trader positions subscription. */
4766
6147
  TraderPositionsSubscribeResponse: {
6148
+ /** @description Accepted trader wallets. */
4767
6149
  traders?: string[];
4768
6150
  /** @description Echoed accepted dirty_kinds filter. Empty = all. */
4769
6151
  dirty_kinds?: ("trade" | "price" | "position_resolved")[];
6152
+ /** @description Rejected filter values. */
4770
6153
  rejected?: string[];
6154
+ /** @description Subscription error message. */
4771
6155
  error?: string | null;
4772
6156
  };
4773
6157
  /** @description One position-update row inside a `trader_position_batch` envelope's `data` array. */
4774
6158
  TraderPositionRow: {
4775
6159
  /** @description ERC-1155 token ID (decimal string) */
4776
6160
  position_id?: string | null;
6161
+ /** @description Market condition ID. */
4777
6162
  condition_id?: string | null;
6163
+ /** @description Market slug. */
4778
6164
  market_slug?: string | null;
6165
+ /** @description Event slug. */
4779
6166
  event_slug?: string | null;
4780
6167
  title?: string | null;
6168
+ /** @description Market question. */
4781
6169
  question?: string | null;
6170
+ /** @description Image URL. */
4782
6171
  image_url?: string | null;
4783
6172
  /** @description Outcome name (e.g. "Yes") */
4784
6173
  outcome?: string | null;
6174
+ /** @description Outcome index. */
4785
6175
  outcome_index?: number | null;
6176
+ /** @description Whether the position is open. */
4786
6177
  open?: boolean | null;
4787
6178
  /** @description Resolution outcome — present once the market resolved */
4788
6179
  won?: boolean | null;
4789
- /** Format: int64 */
6180
+ /**
6181
+ * Format: int64
6182
+ * @description Total buy count.
6183
+ */
4790
6184
  total_buys?: number | null;
4791
- /** Format: int64 */
6185
+ /**
6186
+ * Format: int64
6187
+ * @description Total sell count.
6188
+ */
4792
6189
  total_sells?: number | null;
4793
- /** Format: int64 */
6190
+ /**
6191
+ * Format: int64
6192
+ * @description Conversion count.
6193
+ */
4794
6194
  converted_count?: number | null;
6195
+ /** @description Converted shares gained. */
4795
6196
  converted_shares_gained?: number | null;
6197
+ /** @description Converted shares lost. */
4796
6198
  converted_shares_lost?: number | null;
6199
+ /** @description Total shares bought. */
4797
6200
  total_shares_bought?: number | null;
6201
+ /** @description Total shares sold. */
4798
6202
  total_shares_sold?: number | null;
6203
+ /** @description Total buys in USD. */
4799
6204
  total_buy_usd?: number | null;
6205
+ /** @description Total sells in USD. */
4800
6206
  total_sell_usd?: number | null;
6207
+ /** @description Redemption volume in USD. */
4801
6208
  redemption_usd?: number | null;
6209
+ /** @description Merge volume in USD. */
4802
6210
  merge_usd?: number | null;
4803
6211
  /** @description 0–1 */
4804
6212
  avg_entry_price?: number | null;
6213
+ /** @description Average exit price. */
4805
6214
  avg_exit_price?: number | null;
4806
6215
  /** @description Volume-weighted across buys + sells */
4807
6216
  avg_price?: number | null;
6217
+ /** @description Realized PnL in USD. */
4808
6218
  realized_pnl_usd?: number | null;
6219
+ /** @description Realized PnL percent. */
4809
6220
  realized_pnl_pct?: number | null;
6221
+ /** @description Total fees. */
4810
6222
  total_fees?: number | null;
4811
6223
  /**
4812
6224
  * Format: int64
@@ -4820,9 +6232,11 @@ export interface components {
4820
6232
  last_trade_at?: number | null;
4821
6233
  /** @description Latest on-chain mark for the outcome token */
4822
6234
  current_price?: number | null;
6235
+ /** @description Current shares balance. */
4823
6236
  current_shares_balance?: number | null;
4824
6237
  /** @description current_price × current_shares_balance */
4825
6238
  current_value?: number | null;
6239
+ /** @description Last traded price. */
4826
6240
  last_traded_price?: number | null;
4827
6241
  /**
4828
6242
  * Format: int64
@@ -4842,7 +6256,10 @@ export interface components {
4842
6256
  TraderPositionBatchEvent: {
4843
6257
  /** @enum {string} */
4844
6258
  type: "trader_position_batch";
4845
- /** @enum {string} */
6259
+ /**
6260
+ * @description WebSocket room ID.
6261
+ * @enum {string}
6262
+ */
4846
6263
  room_id: "polymarket_trader_positions";
4847
6264
  /**
4848
6265
  * Format: int64
@@ -4853,66 +6270,100 @@ export interface components {
4853
6270
  };
4854
6271
  /** @description One price-tick row inside a `trader_position_price_batch` envelope's `data` array. */
4855
6272
  TraderPositionPriceRow: {
6273
+ /** @description Trader wallet address. */
4856
6274
  trader?: string | null;
4857
6275
  /** @description ERC-1155 token ID (decimal string) */
4858
6276
  position_id?: string | null;
6277
+ /** @description Market condition ID. */
4859
6278
  condition_id?: string | null;
4860
6279
  /** @description Latest on-chain mark for the outcome token */
4861
6280
  current_price?: number | null;
6281
+ /** @description Current position value. */
4862
6282
  current_value?: number | null;
6283
+ /** @description Realized PnL in USD. */
4863
6284
  realized_pnl_usd?: number | null;
6285
+ /** @description Realized PnL percent. */
4864
6286
  realized_pnl_pct?: number | null;
4865
- /** Format: int64 */
6287
+ /**
6288
+ * Format: int64
6289
+ * @description Last block number.
6290
+ */
4866
6291
  last_block?: number | null;
4867
6292
  /**
4868
6293
  * Format: int64
4869
6294
  * @description Unix milliseconds
4870
6295
  */
4871
6296
  last_trade_at?: number | null;
6297
+ /** @description Dirty update kinds included in this event. */
4872
6298
  dirty_kinds?: "price"[];
4873
6299
  };
4874
6300
  /** @description Server-pushed per-block batch of position price ticks (mark-to-market refreshes). Envelope type: `trader_position_price_batch`. */
4875
6301
  TraderPositionPriceBatchEvent: {
4876
6302
  /** @enum {string} */
4877
6303
  type: "trader_position_price_batch";
4878
- /** @enum {string} */
6304
+ /**
6305
+ * @description WebSocket room ID.
6306
+ * @enum {string}
6307
+ */
4879
6308
  room_id: "polymarket_trader_positions";
4880
- /** Format: int64 */
6309
+ /**
6310
+ * Format: int64
6311
+ * @description Block number.
6312
+ */
4881
6313
  block: number;
4882
6314
  data: components["schemas"]["TraderPositionPriceRow"][];
4883
6315
  };
4884
6316
  /** @description One resolution row inside a `trader_position_resolution_batch` envelope's `data` array. */
4885
6317
  TraderPositionResolutionRow: {
6318
+ /** @description Trader wallet address. */
4886
6319
  trader?: string | null;
4887
6320
  /** @description ERC-1155 token ID (decimal string) */
4888
6321
  position_id?: string | null;
6322
+ /** @description Market condition ID. */
4889
6323
  condition_id?: string | null;
6324
+ /** @description Whether the market is resolved. */
4890
6325
  resolved?: boolean | null;
6326
+ /** @description Whether the position won. */
4891
6327
  won?: boolean | null;
6328
+ /** @description Realized PnL in USD. */
4892
6329
  realized_pnl_usd?: number | null;
6330
+ /** @description Realized PnL percent. */
4893
6331
  realized_pnl_pct?: number | null;
4894
- /** Format: int64 */
6332
+ /**
6333
+ * Format: int64
6334
+ * @description Last block number.
6335
+ */
4895
6336
  last_block?: number | null;
4896
6337
  /**
4897
6338
  * Format: int64
4898
6339
  * @description Unix milliseconds
4899
6340
  */
4900
6341
  last_trade_at?: number | null;
6342
+ /** @description Dirty update kinds included in this event. */
4901
6343
  dirty_kinds?: "position_resolved"[];
4902
6344
  };
4903
6345
  /** @description Server-pushed per-block batch of position resolutions. Envelope type: `trader_position_resolution_batch`. */
4904
6346
  TraderPositionResolutionBatchEvent: {
4905
6347
  /** @enum {string} */
4906
6348
  type: "trader_position_resolution_batch";
4907
- /** @enum {string} */
6349
+ /**
6350
+ * @description WebSocket room ID.
6351
+ * @enum {string}
6352
+ */
4908
6353
  room_id: "polymarket_trader_positions";
4909
- /** Format: int64 */
6354
+ /**
6355
+ * Format: int64
6356
+ * @description Block number.
6357
+ */
4910
6358
  block: number;
4911
6359
  data: components["schemas"]["TraderPositionResolutionRow"][];
4912
6360
  };
4913
6361
  /** @description Subscribe to the trader exit markers stream. `traders` is required and must be non-empty. `reasons` is an optional narrowing filter — empty/omitted or `["all"]` = receive every exit reason. */
4914
6362
  TraderExitMarkersSubscribeMessage: {
4915
- /** @enum {string} */
6363
+ /**
6364
+ * @description Subscription action.
6365
+ * @enum {string}
6366
+ */
4916
6367
  action: "subscribe" | "unsubscribe_all";
4917
6368
  /** @description EVM wallet addresses */
4918
6369
  traders: string[];
@@ -4921,10 +6372,13 @@ export interface components {
4921
6372
  };
4922
6373
  /** @description Server acknowledgement for a trader exit markers subscription. */
4923
6374
  TraderExitMarkersSubscribeResponse: {
6375
+ /** @description Accepted trader wallets. */
4924
6376
  traders?: string[];
4925
6377
  /** @description Echoed accepted reasons filter. Empty = all. */
4926
6378
  reasons?: ("resolved_win" | "resolved_loss" | "sold_win" | "sold_loss")[];
6379
+ /** @description Rejected filter values. */
4927
6380
  rejected?: string[];
6381
+ /** @description Subscription error message. */
4928
6382
  error?: string | null;
4929
6383
  };
4930
6384
  /** @description One exit row inside a `trader_exit_marker_batch` envelope's `data` array. */
@@ -4933,20 +6387,26 @@ export interface components {
4933
6387
  trader?: string;
4934
6388
  /** @description ERC-1155 token ID (decimal string) */
4935
6389
  position_id?: string;
6390
+ /** @description Market condition ID. */
4936
6391
  condition_id?: string;
6392
+ /** @description Event slug. */
4937
6393
  event_slug?: string;
6394
+ /** @description Market slug. */
4938
6395
  market_slug?: string;
4939
6396
  title?: string;
4940
6397
  /** @description Full market question text */
4941
6398
  question?: string;
6399
+ /** @description Image URL. */
4942
6400
  image_url?: string;
4943
6401
  /** @description Outcome name (e.g. "Yes") */
4944
6402
  outcome?: string;
6403
+ /** @description Outcome index. */
4945
6404
  outcome_index?: number | null;
4946
6405
  /** @description Realized PnL at exit, USD */
4947
6406
  pnl_usd?: number;
4948
6407
  /** @description Realized PnL at exit, percent */
4949
6408
  pnl_pct?: number;
6409
+ /** @description Cost basis in USD. */
4950
6410
  cost_basis_usd?: number;
4951
6411
  /**
4952
6412
  * @description Why the position closed: `resolved_*` held to market resolution (win/loss by verdict); `sold_*` closed before resolution (win/loss by realized PnL sign).
@@ -4968,7 +6428,10 @@ export interface components {
4968
6428
  TraderExitMarkerBatchEvent: {
4969
6429
  /** @enum {string} */
4970
6430
  type: "trader_exit_marker_batch";
4971
- /** @enum {string} */
6431
+ /**
6432
+ * @description WebSocket room ID.
6433
+ * @enum {string}
6434
+ */
4972
6435
  room_id: "polymarket_trader_pnl_exits";
4973
6436
  /**
4974
6437
  * Format: int64
@@ -4979,7 +6442,10 @@ export interface components {
4979
6442
  };
4980
6443
  /** @description Subscribe to holder metrics for explicit positions, conditions, or events. At least one identifier array must be non-empty. Omitted arrays receive no updates for that metric family. Up to 500 total identifiers are accepted. */
4981
6444
  HolderMetricsSubscribeMessage: {
4982
- /** @enum {string} */
6445
+ /**
6446
+ * @description Subscription action.
6447
+ * @enum {string}
6448
+ */
4983
6449
  action: "subscribe" | "unsubscribe_all";
4984
6450
  /** @description Position token IDs to receive position holder metrics for. */
4985
6451
  position_ids?: string[];
@@ -4989,54 +6455,85 @@ export interface components {
4989
6455
  event_slugs?: string[];
4990
6456
  };
4991
6457
  PositionHolderMetricsRow: {
6458
+ /** @description Unix timestamp in seconds. */
4992
6459
  ts?: number;
6460
+ /** @description Block number. */
4993
6461
  block?: number;
6462
+ /** @description Outcome token ID. */
4994
6463
  position_id?: string;
6464
+ /** @description Number of holders. */
4995
6465
  holder_count?: number;
6466
+ /** @description Total shares held. */
4996
6467
  total_balance?: number;
6468
+ /** @description Total holder cost basis in USD. */
4997
6469
  total_cost_basis?: number;
6470
+ /** @description Number of market-level holders. */
4998
6471
  condition_holder_count?: number | null;
6472
+ /** @description Number of event-level holders. */
4999
6473
  event_holder_count?: number | null;
5000
6474
  };
5001
6475
  ConditionHolderMetricsRow: {
6476
+ /** @description Unix timestamp in seconds. */
5002
6477
  ts?: number;
6478
+ /** @description Block number. */
5003
6479
  block?: number;
6480
+ /** @description Market condition ID. */
5004
6481
  condition_id?: string;
6482
+ /** @description Number of holders. */
5005
6483
  holder_count?: number;
5006
6484
  };
5007
6485
  EventHolderMetricsRow: {
6486
+ /** @description Unix timestamp in seconds. */
5008
6487
  ts?: number;
6488
+ /** @description Block number. */
5009
6489
  block?: number;
6490
+ /** @description Event slug. */
5010
6491
  event_slug?: string;
6492
+ /** @description Number of holders. */
5011
6493
  holder_count?: number;
5012
6494
  };
5013
6495
  HolderMetricsPositionBatchEvent: {
5014
6496
  /** @enum {string} */
5015
6497
  type: "holder_metrics_position_batch";
5016
- /** @enum {string} */
6498
+ /**
6499
+ * @description WebSocket room ID.
6500
+ * @enum {string}
6501
+ */
5017
6502
  room_id: "polymarket_holder_metrics";
6503
+ /** @description Block number. */
5018
6504
  block: number;
5019
6505
  data: components["schemas"]["PositionHolderMetricsRow"][];
5020
6506
  };
5021
6507
  HolderMetricsConditionBatchEvent: {
5022
6508
  /** @enum {string} */
5023
6509
  type: "holder_metrics_condition_batch";
5024
- /** @enum {string} */
6510
+ /**
6511
+ * @description WebSocket room ID.
6512
+ * @enum {string}
6513
+ */
5025
6514
  room_id: "polymarket_holder_metrics";
6515
+ /** @description Block number. */
5026
6516
  block: number;
5027
6517
  data: components["schemas"]["ConditionHolderMetricsRow"][];
5028
6518
  };
5029
6519
  HolderMetricsEventBatchEvent: {
5030
6520
  /** @enum {string} */
5031
6521
  type: "holder_metrics_event_batch";
5032
- /** @enum {string} */
6522
+ /**
6523
+ * @description WebSocket room ID.
6524
+ * @enum {string}
6525
+ */
5033
6526
  room_id: "polymarket_holder_metrics";
6527
+ /** @description Block number. */
5034
6528
  block: number;
5035
6529
  data: components["schemas"]["EventHolderMetricsRow"][];
5036
6530
  };
5037
6531
  /** @description Subscribe to the accounts stream. `wallets` is required. Share balance updates (`accounts_update`) are always delivered. Set `include_usdce`, `include_pusd`, or `include_matic` to also receive those balance streams. */
5038
6532
  AccountsSubscribeMessage: {
5039
- /** @enum {string} */
6533
+ /**
6534
+ * @description Subscription action.
6535
+ * @enum {string}
6536
+ */
5040
6537
  action: "subscribe" | "unsubscribe_all";
5041
6538
  /** @description EVM wallet addresses */
5042
6539
  wallets: string[];
@@ -5049,12 +6546,17 @@ export interface components {
5049
6546
  };
5050
6547
  /** @description Server acknowledgement for an accounts subscription */
5051
6548
  AccountsSubscribeResponse: {
6549
+ /** @description Accepted wallet addresses. */
5052
6550
  wallets?: string[];
5053
6551
  /** @description Addresses rejected (invalid format) */
5054
6552
  rejected?: string[];
6553
+ /** @description Whether to include USDC.e balances. */
5055
6554
  include_usdce?: boolean;
6555
+ /** @description Whether to include pUSD balances. */
5056
6556
  include_pusd?: boolean;
6557
+ /** @description Whether to include MATIC balances. */
5057
6558
  include_matic?: boolean;
6559
+ /** @description Subscription error message. */
5058
6560
  error?: string | null;
5059
6561
  };
5060
6562
  /** @description Server-pushed event: ERC-1155 outcome token balance change for a wallet. Envelope type: "accounts_update". */
@@ -5065,7 +6567,10 @@ export interface components {
5065
6567
  position_id: string;
5066
6568
  /** @description Current token balance (decimal string) */
5067
6569
  balance: string;
5068
- /** Format: int64 */
6570
+ /**
6571
+ * Format: int64
6572
+ * @description Block number.
6573
+ */
5069
6574
  block_number: number;
5070
6575
  /**
5071
6576
  * Format: int64
@@ -5085,7 +6590,10 @@ export interface components {
5085
6590
  token_address?: string;
5086
6591
  /** @description Current USDCe balance (decimal string) — omitted when not available */
5087
6592
  balance?: string;
5088
- /** Format: uint64 */
6593
+ /**
6594
+ * Format: uint64
6595
+ * @description Block number.
6596
+ */
5089
6597
  block_number: number;
5090
6598
  /**
5091
6599
  * Format: int64
@@ -5101,7 +6609,10 @@ export interface components {
5101
6609
  token_address?: string;
5102
6610
  /** @description Current pUSD balance (decimal string) — omitted when not available */
5103
6611
  balance?: string;
5104
- /** Format: uint64 */
6612
+ /**
6613
+ * Format: uint64
6614
+ * @description Block number.
6615
+ */
5105
6616
  block_number: number;
5106
6617
  /**
5107
6618
  * Format: int64
@@ -5117,7 +6628,10 @@ export interface components {
5117
6628
  token_address?: string;
5118
6629
  /** @description Current MATIC balance (decimal string) — omitted when not available */
5119
6630
  balance?: string;
5120
- /** Format: uint64 */
6631
+ /**
6632
+ * Format: uint64
6633
+ * @description Block number.
6634
+ */
5121
6635
  block_number: number;
5122
6636
  /**
5123
6637
  * Format: int64
@@ -5127,7 +6641,10 @@ export interface components {
5127
6641
  };
5128
6642
  /** @description Subscribe to the order book stream. At least one filter is required. Maximum 500 combined condition_ids + position_ids per client. No `type` field is needed — the server routes by room_id. */
5129
6643
  OrderBookSubscribeMessage: {
5130
- /** @enum {string} */
6644
+ /**
6645
+ * @description Subscription action.
6646
+ * @enum {string}
6647
+ */
5131
6648
  action: "subscribe" | "unsubscribe_all";
5132
6649
  /** @description Condition IDs (markets). All positions within each market are delivered. */
5133
6650
  condition_ids?: string[];
@@ -5181,7 +6698,10 @@ export interface components {
5181
6698
  };
5182
6699
  /** @description Subscribe to CLOB reward changes. Either provide specific condition_ids or set subscribe_all to true. */
5183
6700
  ClobRewardsSubscribeMessage: {
5184
- /** @enum {string} */
6701
+ /**
6702
+ * @description Subscription action.
6703
+ * @enum {string}
6704
+ */
5185
6705
  action: "subscribe" | "unsubscribe_all";
5186
6706
  /** @description Condition IDs to watch for reward changes. */
5187
6707
  condition_ids?: string[];
@@ -5208,14 +6728,22 @@ export interface components {
5208
6728
  condition_id?: string;
5209
6729
  /** @description Full reward state (null for 'removed' events) */
5210
6730
  reward?: {
6731
+ /** @description Market condition ID. */
5211
6732
  condition_id?: string;
5212
6733
  rewards_config?: {
6734
+ /** @description Event ID. */
5213
6735
  id?: number;
5214
6736
  /** @description Reward token address (e.g. USDC) */
5215
6737
  asset_address?: string;
5216
- /** Format: date */
6738
+ /**
6739
+ * Format: date
6740
+ * @description Reward start date.
6741
+ */
5217
6742
  start_date?: string;
5218
- /** Format: date */
6743
+ /**
6744
+ * Format: date
6745
+ * @description Reward end date.
6746
+ */
5219
6747
  end_date?: string;
5220
6748
  /** @description Daily reward rate in USDC */
5221
6749
  rate_per_day?: number;
@@ -5266,16 +6794,25 @@ export interface components {
5266
6794
  EventsStreamFilter: {
5267
6795
  /** @description Case-insensitive substring match on `title`. 3–100 chars. */
5268
6796
  search?: string;
6797
+ /** @description Categories to include. */
5269
6798
  categories?: string[];
6799
+ /** @description Categories to exclude. */
5270
6800
  exclude_categories?: string[];
5271
6801
  /** @description Match by tag slug OR label (case-insensitive). */
5272
6802
  tags?: string[];
6803
+ /** @description Tags to exclude. */
5273
6804
  exclude_tags?: string[];
6805
+ /** @description Minimum volume. */
5274
6806
  min_volume?: number;
6807
+ /** @description Maximum volume. */
5275
6808
  max_volume?: number;
6809
+ /** @description Minimum transaction count. */
5276
6810
  min_txns?: number;
6811
+ /** @description Maximum transaction count. */
5277
6812
  max_txns?: number;
6813
+ /** @description Minimum unique trader count. */
5278
6814
  min_unique_traders?: number;
6815
+ /** @description Maximum unique trader count. */
5279
6816
  max_unique_traders?: number;
5280
6817
  /**
5281
6818
  * @description Timeframe that `volume`/`txns`/`unique_traders` thresholds are evaluated against. Default `24h`.
@@ -5285,8 +6822,12 @@ export interface components {
5285
6822
  };
5286
6823
  /** @description Server acknowledgement for an events_stream subscribe/unsubscribe. Envelope type: "events_stream_subscribe_response". */
5287
6824
  EventsStreamSubscribeResponse: {
5288
- /** @enum {string} */
6825
+ /**
6826
+ * @description Subscription mode.
6827
+ * @enum {string}
6828
+ */
5289
6829
  mode?: "filter" | "ids" | "";
6830
+ /** @description Flush interval in milliseconds. */
5290
6831
  interval_ms?: number;
5291
6832
  /** @description Accepted ids (ids mode only). Empty in filter mode. */
5292
6833
  event_slugs?: string[];
@@ -5299,11 +6840,20 @@ export interface components {
5299
6840
  EventsStreamUpdateEvent: {
5300
6841
  /** @enum {string} */
5301
6842
  type: "events_stream_update";
5302
- /** @enum {string} */
6843
+ /**
6844
+ * @description WebSocket room ID.
6845
+ * @enum {string}
6846
+ */
5303
6847
  room_id: "polymarket_events_stream";
5304
- /** @enum {string} */
6848
+ /**
6849
+ * @description Subscription mode.
6850
+ * @enum {string}
6851
+ */
5305
6852
  mode: "filter" | "ids";
5306
- /** @enum {integer} */
6853
+ /**
6854
+ * @description Flush interval in milliseconds.
6855
+ * @enum {integer}
6856
+ */
5307
6857
  interval_ms: 500 | 1000 | 3000 | 10000;
5308
6858
  /** @description Full `PolymarketEvent` rows (same shape as `GET /polymarket/events`). Not a delta — each array element is a complete row replacement. */
5309
6859
  data: Record<string, never>[];
@@ -5339,9 +6889,14 @@ export interface components {
5339
6889
  * @description A buy/sell trade was matched on the exchange.
5340
6890
  */
5341
6891
  TradeOrderFilledEvent: {
5342
- /** @enum {string} */
6892
+ /**
6893
+ * @description Trade type.
6894
+ * @enum {string}
6895
+ */
5343
6896
  trade_type: "OrderFilled" | "OrdersMatched";
6897
+ /** @description Event ID. */
5344
6898
  id: string;
6899
+ /** @description Transaction hash. */
5345
6900
  hash: string;
5346
6901
  /** @description Absent for pending trades */
5347
6902
  block?: number;
@@ -5356,28 +6911,49 @@ export interface components {
5356
6911
  /** @description Absent for pending trades */
5357
6912
  order_hash?: string;
5358
6913
  trader: {
6914
+ /** @description Wallet address. */
5359
6915
  address?: string;
6916
+ /** @description Display name. */
5360
6917
  name?: string | null;
6918
+ /** @description Pseudonym. */
5361
6919
  pseudonym?: string | null;
6920
+ /** @description Profile image URL. */
5362
6921
  profile_image?: string | null;
6922
+ /** @description X username. */
5363
6923
  x_username?: string | null;
6924
+ /** @description Whether the profile is verified. */
5364
6925
  verified_badge?: boolean;
5365
6926
  };
5366
6927
  /** @description Absent for pending trades */
5367
6928
  taker?: string;
5368
- /** @enum {string} */
6929
+ /**
6930
+ * @description Trade side.
6931
+ * @enum {string}
6932
+ */
5369
6933
  side?: "Buy" | "Sell";
6934
+ /** @description Market condition ID. */
5370
6935
  condition_id?: string | null;
6936
+ /** @description Outcome token ID. */
5371
6937
  position_id?: string;
6938
+ /** @description Outcome name. */
5372
6939
  outcome?: string | null;
6940
+ /** @description Outcome index. */
5373
6941
  outcome_index?: number | null;
6942
+ /** @description Market question. */
5374
6943
  question?: string | null;
6944
+ /** @description Image URL. */
5375
6945
  image_url?: string | null;
6946
+ /** @description Market slug. */
5376
6947
  slug?: string | null;
6948
+ /** @description Event slug. */
5377
6949
  event_slug?: string | null;
6950
+ /** @description Trade amount in USD. */
5378
6951
  usd_amount?: number;
6952
+ /** @description Trade size in shares. */
5379
6953
  shares_amount?: number;
6954
+ /** @description Outcome price. */
5380
6955
  price?: number;
6956
+ /** @description Implied probability. */
5381
6957
  probability?: number | null;
5382
6958
  /** @description Absent for pending trades */
5383
6959
  fee?: number;
@@ -5385,6 +6961,7 @@ export interface components {
5385
6961
  fee_shares?: number;
5386
6962
  /** @description Absent for pending trades */
5387
6963
  fee_pct?: number;
6964
+ /** @description Exchange identifier. */
5388
6965
  exchange: number;
5389
6966
  /** @description CLOB V2 builder code (lower-cased `0x...` bytes32 hex). Absent on V1 trades; may be `0x0000…` for V2 trades placed without a builder code. */
5390
6967
  builder_code?: string;
@@ -5396,25 +6973,42 @@ export interface components {
5396
6973
  * @description pUSD credit paid directly to the trader wallet.
5397
6974
  */
5398
6975
  TradeRedemptionEvent: {
5399
- /** @enum {string} */
6976
+ /**
6977
+ * @description Trade type.
6978
+ * @enum {string}
6979
+ */
5400
6980
  trade_type: "MakerRebate" | "Reward" | "Yield";
6981
+ /** @description Event ID. */
5401
6982
  id: string;
6983
+ /** @description Transaction hash. */
5402
6984
  hash: string;
6985
+ /** @description Block number. */
5403
6986
  block?: number;
6987
+ /** @description Confirmation timestamp. */
5404
6988
  confirmed_at?: number;
6989
+ /** @description Receive timestamp. */
5405
6990
  received_at?: number;
6991
+ /** @description Log index. */
5406
6992
  log_index?: number;
6993
+ /** @description Block index. */
5407
6994
  block_index?: number;
5408
6995
  trader: {
6996
+ /** @description Wallet address. */
5409
6997
  address?: string;
6998
+ /** @description Display name. */
5410
6999
  name?: string | null;
7000
+ /** @description Pseudonym. */
5411
7001
  pseudonym?: string | null;
7002
+ /** @description Profile image URL. */
5412
7003
  profile_image?: string | null;
7004
+ /** @description X username. */
5413
7005
  x_username?: string | null;
7006
+ /** @description Whether the profile is verified. */
5414
7007
  verified_badge?: boolean;
5415
7008
  };
5416
7009
  /** @description Payout distributor address */
5417
7010
  taker?: string;
7011
+ /** @description Trade amount in USD. */
5418
7012
  usd_amount?: number;
5419
7013
  /** @description Always 0 for payout credits */
5420
7014
  shares_amount?: number;
@@ -5434,37 +7028,67 @@ export interface components {
5434
7028
  * @description Positions redeemed after market resolution.
5435
7029
  */
5436
7030
  TradeMergeEvent: {
5437
- /** @enum {string} */
7031
+ /**
7032
+ * @description Trade type.
7033
+ * @enum {string}
7034
+ */
5438
7035
  trade_type: "Redemption";
7036
+ /** @description Event ID. */
5439
7037
  id: string;
7038
+ /** @description Transaction hash. */
5440
7039
  hash: string;
7040
+ /** @description Block number. */
5441
7041
  block?: number;
7042
+ /** @description Confirmation timestamp. */
5442
7043
  confirmed_at?: number;
7044
+ /** @description Receive timestamp. */
5443
7045
  received_at?: number;
7046
+ /** @description Log index. */
5444
7047
  log_index?: number;
7048
+ /** @description Block index. */
5445
7049
  block_index?: number;
5446
7050
  trader: {
7051
+ /** @description Wallet address. */
5447
7052
  address?: string;
7053
+ /** @description Display name. */
5448
7054
  name?: string | null;
7055
+ /** @description Pseudonym. */
5449
7056
  pseudonym?: string | null;
7057
+ /** @description Profile image URL. */
5450
7058
  profile_image?: string | null;
7059
+ /** @description X username. */
5451
7060
  x_username?: string | null;
7061
+ /** @description Whether the profile is verified. */
5452
7062
  verified_badge?: boolean;
5453
7063
  };
7064
+ /** @description Market condition ID. */
5454
7065
  condition_id?: string | null;
7066
+ /** @description Outcome name. */
5455
7067
  outcome?: string | null;
7068
+ /** @description Outcome index. */
5456
7069
  outcome_index?: number | null;
7070
+ /** @description Market question. */
5457
7071
  question?: string | null;
7072
+ /** @description Image URL. */
5458
7073
  image_url?: string | null;
7074
+ /** @description Market slug. */
5459
7075
  slug?: string | null;
7076
+ /** @description Event slug. */
5460
7077
  event_slug?: string | null;
7078
+ /** @description Trade amount in USD. */
5461
7079
  usd_amount?: number;
7080
+ /** @description Winning outcome index. */
5462
7081
  winning_outcome_index?: number | null;
7082
+ /** @description Position details. */
5463
7083
  position_details?: {
7084
+ /** @description Outcome token ID. */
5464
7085
  position_id?: string;
7086
+ /** @description Outcome index. */
5465
7087
  outcome_index?: number;
7088
+ /** @description Amount as a decimal string. */
5466
7089
  amount?: string;
5467
7090
  }[];
7091
+ /** @description Exchange identifier. */
5468
7092
  exchange: number;
5469
7093
  };
5470
7094
  /**
@@ -5472,34 +7096,61 @@ export interface components {
5472
7096
  * @description Outcome tokens burned to receive collateral.
5473
7097
  */
5474
7098
  TradeSplitEvent: {
5475
- /** @enum {string} */
7099
+ /**
7100
+ * @description Trade type.
7101
+ * @enum {string}
7102
+ */
5476
7103
  trade_type: "Merge";
7104
+ /** @description Event ID. */
5477
7105
  id: string;
7106
+ /** @description Transaction hash. */
5478
7107
  hash: string;
7108
+ /** @description Block number. */
5479
7109
  block?: number;
7110
+ /** @description Confirmation timestamp. */
5480
7111
  confirmed_at?: number;
7112
+ /** @description Receive timestamp. */
5481
7113
  received_at?: number;
7114
+ /** @description Log index. */
5482
7115
  log_index?: number;
7116
+ /** @description Block index. */
5483
7117
  block_index?: number;
5484
7118
  trader: {
7119
+ /** @description Wallet address. */
5485
7120
  address?: string;
7121
+ /** @description Display name. */
5486
7122
  name?: string | null;
7123
+ /** @description Pseudonym. */
5487
7124
  pseudonym?: string | null;
7125
+ /** @description Profile image URL. */
5488
7126
  profile_image?: string | null;
7127
+ /** @description X username. */
5489
7128
  x_username?: string | null;
7129
+ /** @description Whether the profile is verified. */
5490
7130
  verified_badge?: boolean;
5491
7131
  };
7132
+ /** @description Market condition ID. */
5492
7133
  condition_id?: string | null;
7134
+ /** @description Market question. */
5493
7135
  question?: string | null;
7136
+ /** @description Image URL. */
5494
7137
  image_url?: string | null;
7138
+ /** @description Market slug. */
5495
7139
  slug?: string | null;
7140
+ /** @description Event slug. */
5496
7141
  event_slug?: string | null;
7142
+ /** @description Trade amount in USD. */
5497
7143
  usd_amount?: number;
7144
+ /** @description Position details. */
5498
7145
  position_details?: {
7146
+ /** @description Outcome token ID. */
5499
7147
  position_id?: string;
7148
+ /** @description Outcome index. */
5500
7149
  outcome_index?: number;
7150
+ /** @description Amount as a decimal string. */
5501
7151
  amount?: string;
5502
7152
  }[];
7153
+ /** @description Exchange identifier. */
5503
7154
  exchange: number;
5504
7155
  };
5505
7156
  /**
@@ -5507,34 +7158,61 @@ export interface components {
5507
7158
  * @description Collateral deposited to receive outcome tokens.
5508
7159
  */
5509
7160
  TradePositionsConvertedEvent: {
5510
- /** @enum {string} */
7161
+ /**
7162
+ * @description Trade type.
7163
+ * @enum {string}
7164
+ */
5511
7165
  trade_type: "Split";
7166
+ /** @description Event ID. */
5512
7167
  id: string;
7168
+ /** @description Transaction hash. */
5513
7169
  hash: string;
7170
+ /** @description Block number. */
5514
7171
  block?: number;
7172
+ /** @description Confirmation timestamp. */
5515
7173
  confirmed_at?: number;
7174
+ /** @description Receive timestamp. */
5516
7175
  received_at?: number;
7176
+ /** @description Log index. */
5517
7177
  log_index?: number;
7178
+ /** @description Block index. */
5518
7179
  block_index?: number;
5519
7180
  trader: {
7181
+ /** @description Wallet address. */
5520
7182
  address?: string;
7183
+ /** @description Display name. */
5521
7184
  name?: string | null;
7185
+ /** @description Pseudonym. */
5522
7186
  pseudonym?: string | null;
7187
+ /** @description Profile image URL. */
5523
7188
  profile_image?: string | null;
7189
+ /** @description X username. */
5524
7190
  x_username?: string | null;
7191
+ /** @description Whether the profile is verified. */
5525
7192
  verified_badge?: boolean;
5526
7193
  };
7194
+ /** @description Market condition ID. */
5527
7195
  condition_id?: string | null;
7196
+ /** @description Market question. */
5528
7197
  question?: string | null;
7198
+ /** @description Image URL. */
5529
7199
  image_url?: string | null;
7200
+ /** @description Market slug. */
5530
7201
  slug?: string | null;
7202
+ /** @description Event slug. */
5531
7203
  event_slug?: string | null;
7204
+ /** @description Trade amount in USD. */
5532
7205
  usd_amount?: number;
7206
+ /** @description Position details. */
5533
7207
  position_details?: {
7208
+ /** @description Outcome token ID. */
5534
7209
  position_id?: string;
7210
+ /** @description Outcome index. */
5535
7211
  outcome_index?: number;
7212
+ /** @description Amount as a decimal string. */
5536
7213
  amount?: string;
5537
7214
  }[];
7215
+ /** @description Exchange identifier. */
5538
7216
  exchange: number;
5539
7217
  };
5540
7218
  /**
@@ -5542,34 +7220,59 @@ export interface components {
5542
7220
  * @description NegRisk NO tokens converted to YES tokens + collateral.
5543
7221
  */
5544
7222
  TradeCancelledEvent: {
5545
- /** @enum {string} */
7223
+ /**
7224
+ * @description Trade type.
7225
+ * @enum {string}
7226
+ */
5546
7227
  trade_type: "PositionsConverted";
7228
+ /** @description Event ID. */
5547
7229
  id: string;
7230
+ /** @description Transaction hash. */
5548
7231
  hash: string;
7232
+ /** @description Block number. */
5549
7233
  block?: number;
7234
+ /** @description Confirmation timestamp. */
5550
7235
  confirmed_at?: number;
7236
+ /** @description Receive timestamp. */
5551
7237
  received_at?: number;
7238
+ /** @description Log index. */
5552
7239
  log_index?: number;
7240
+ /** @description Block index. */
5553
7241
  block_index?: number;
5554
7242
  trader: {
7243
+ /** @description Wallet address. */
5555
7244
  address?: string;
7245
+ /** @description Display name. */
5556
7246
  name?: string | null;
7247
+ /** @description Pseudonym. */
5557
7248
  pseudonym?: string | null;
7249
+ /** @description Profile image URL. */
5558
7250
  profile_image?: string | null;
7251
+ /** @description X username. */
5559
7252
  x_username?: string | null;
7253
+ /** @description Whether the profile is verified. */
5560
7254
  verified_badge?: boolean;
5561
7255
  };
7256
+ /** @description Market id. */
5562
7257
  market_id?: string;
7258
+ /** @description Index set. */
5563
7259
  index_set?: string;
7260
+ /** @description Trade size in shares. */
5564
7261
  shares_amount?: number;
7262
+ /** @description Fee. */
5565
7263
  fee?: number;
7264
+ /** @description Fee percent. */
5566
7265
  fee_pct?: number;
5567
7266
  /** @description Per-position conversion amounts */
5568
7267
  position_details?: {
7268
+ /** @description Outcome token ID. */
5569
7269
  position_id?: string;
7270
+ /** @description Outcome index. */
5570
7271
  outcome_index?: number;
7272
+ /** @description Amount as a decimal string. */
5571
7273
  amount?: string;
5572
7274
  }[];
7275
+ /** @description Exchange identifier. */
5573
7276
  exchange: number;
5574
7277
  };
5575
7278
  /**
@@ -5577,20 +7280,36 @@ export interface components {
5577
7280
  * @description Order cancelled on-chain.
5578
7281
  */
5579
7282
  TradeOracleLifecycleEvent: {
5580
- /** @enum {string} */
7283
+ /**
7284
+ * @description Trade type.
7285
+ * @enum {string}
7286
+ */
5581
7287
  trade_type: "Cancelled";
7288
+ /** @description Event ID. */
5582
7289
  id: string;
7290
+ /** @description Transaction hash. */
5583
7291
  hash: string;
7292
+ /** @description Block number. */
5584
7293
  block?: number;
7294
+ /** @description Confirmation timestamp. */
5585
7295
  confirmed_at?: number;
7296
+ /** @description Receive timestamp. */
5586
7297
  received_at?: number;
7298
+ /** @description Log index. */
5587
7299
  log_index?: number;
7300
+ /** @description Block index. */
5588
7301
  block_index?: number;
7302
+ /** @description Order hash. */
5589
7303
  order_hash?: string;
7304
+ /** @description Market question. */
5590
7305
  question?: string | null;
7306
+ /** @description Image URL. */
5591
7307
  image_url?: string | null;
7308
+ /** @description Market slug. */
5592
7309
  slug?: string | null;
7310
+ /** @description Event slug. */
5593
7311
  event_slug?: string | null;
7312
+ /** @description Exchange identifier. */
5594
7313
  exchange: number;
5595
7314
  };
5596
7315
  /**
@@ -5598,33 +7317,62 @@ export interface components {
5598
7317
  * @description Market lifecycle events: Initialization, Proposal, Dispute, Settled, Resolution, ConditionResolution, Reset, Flag, Unflag, Pause, Unpause, ManualResolution, NegRiskOutcomeReported.
5599
7318
  */
5600
7319
  TradeRegisterTokenEvent: {
5601
- /** @enum {string} */
7320
+ /**
7321
+ * @description Oracle lifecycle event type.
7322
+ * @enum {string}
7323
+ */
5602
7324
  trade_type: "Initialization" | "Proposal" | "Dispute" | "Settled" | "Resolution" | "ConditionResolution" | "Reset" | "Flag" | "Unflag" | "Pause" | "Unpause" | "ManualResolution" | "NegRiskOutcomeReported";
7325
+ /** @description Event ID. */
5603
7326
  id: string;
7327
+ /** @description Transaction hash. */
5604
7328
  hash: string;
7329
+ /** @description Block number. */
5605
7330
  block?: number;
7331
+ /** @description Confirmation timestamp. */
5606
7332
  confirmed_at?: number;
7333
+ /** @description Receive timestamp. */
5607
7334
  received_at?: number;
7335
+ /** @description Log index. */
5608
7336
  log_index?: number;
7337
+ /** @description Block index. */
5609
7338
  block_index?: number;
7339
+ /** @description Oracle contract. */
5610
7340
  oracle_contract: string;
7341
+ /** @description Market condition ID. */
5611
7342
  condition_id: string;
7343
+ /** @description Market question. */
5612
7344
  question?: string | null;
7345
+ /** @description Image URL. */
5613
7346
  image_url?: string | null;
7347
+ /** @description Market slug. */
5614
7348
  slug?: string | null;
7349
+ /** @description Event slug. */
5615
7350
  event_slug?: string | null;
7351
+ /** @description Assertion id. */
5616
7352
  assertion_id?: string | null;
7353
+ /** @description Proposer. */
5617
7354
  proposer?: string | null;
7355
+ /** @description Disputer. */
5618
7356
  disputer?: string | null;
7357
+ /** @description Proposed outcome. */
5619
7358
  proposed_outcome?: string | null;
7359
+ /** @description Settled price. */
5620
7360
  settled_price?: number | null;
7361
+ /** @description Disputed. */
5621
7362
  disputed?: boolean | null;
7363
+ /** @description Settlement resolution. */
5622
7364
  settlement_resolution?: boolean | null;
7365
+ /** @description Bond. */
5623
7366
  bond?: string | null;
7367
+ /** @description Expiration time. */
5624
7368
  expiration_time?: number | null;
7369
+ /** @description Creator. */
5625
7370
  creator?: string | null;
7371
+ /** @description Reward token. */
5626
7372
  reward_token?: string | null;
7373
+ /** @description Reward details. */
5627
7374
  reward?: string | null;
7375
+ /** @description Proposal bond. */
5628
7376
  proposal_bond?: string | null;
5629
7377
  };
5630
7378
  };