@structbuild/sdk 0.6.2 → 0.6.3

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 */
1104
+ /**
1105
+ * Format: double
1106
+ * @description Redemption volume in USD.
1107
+ */
861
1108
  redemption_volume_usd?: number | null;
862
- /** Format: double */
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
@@ -3618,6 +4310,7 @@ export interface components {
3618
4310
  /**
3619
4311
  * @description CLOB V2 builder code (lower-cased `0x...` bytes32 hex). Absent on V1
3620
4312
  * trades; may be `0x0000…` for V2 trades placed without a builder code.
4313
+ * CLOB builder code.
3621
4314
  */
3622
4315
  builder_code?: string | null;
3623
4316
  /**
@@ -4160,7 +4853,7 @@ export interface components {
4160
4853
  * @description All alert event types supported by both HTTP webhooks and the alerts WebSocket.
4161
4854
  * @enum {string}
4162
4855
  */
4163
- WsAlertEventType: "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_pnl_exits" | "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" | "price_spike" | "market_volume_spike" | "event_volume_spike" | "position_volume_spike" | "close_to_bond" | "price_threshold" | "market_resolved" | "market_disputed" | "market_created" | "oracle_events" | "asset_price_tick" | "asset_price_window_update";
4856
+ WsAlertEventType: "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_pnl_exits" | "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" | "price_spike" | "market_volume_spike" | "event_volume_spike" | "position_volume_spike" | "close_to_bond" | "price_threshold" | "market_resolved" | "market_disputed" | "market_created" | "oracle_events" | "asset_price_tick" | "asset_price_window_update";
4164
4857
  /** @description Server acknowledgement for a successful alert subscription. */
4165
4858
  WsAlertSubscribedResponse: {
4166
4859
  /** @enum {string} */
@@ -5330,6 +6023,159 @@ export interface components {
5330
6023
  timestamp: number;
5331
6024
  data: components["schemas"]["PositionMetricsPayload"];
5332
6025
  };
6026
+ WsAlertPositionLiquiditySubscribeMessage: ({
6027
+ /** @enum {string} */
6028
+ op: "subscribe";
6029
+ /** @enum {string} */
6030
+ event: "position_liquidity";
6031
+ } & components["schemas"]["PositionLiquidityFilters"] & {
6032
+ /**
6033
+ * @description discriminator enum property added by openapi-typescript
6034
+ * @enum {string}
6035
+ */
6036
+ event: "position_liquidity";
6037
+ }) | unknown;
6038
+ WsAlertPositionLiquidityUnsubscribeMessage: ({
6039
+ /** @enum {string} */
6040
+ op: "unsubscribe";
6041
+ /** @enum {string} */
6042
+ event: "position_liquidity";
6043
+ } & components["schemas"]["PositionLiquidityFilters"] & {
6044
+ /**
6045
+ * @description discriminator enum property added by openapi-typescript
6046
+ * @enum {string}
6047
+ */
6048
+ event: "position_liquidity";
6049
+ }) | unknown;
6050
+ /**
6051
+ * @description Pushed `position_liquidity` alert. The `data` payload matches the corresponding HTTP webhook payload schema.
6052
+ * @example {
6053
+ * "event": "position_liquidity",
6054
+ * "timestamp": 1743500000000,
6055
+ * "data": {
6056
+ * "position_id": "71321045679252212594626385532706912750332728571942532289631379312455583992563",
6057
+ * "liquidity_usd": 48000,
6058
+ * "threshold_usd": 50000,
6059
+ * "direction": "below",
6060
+ * "liquidity_updated_at": 1700000000000
6061
+ * }
6062
+ * }
6063
+ */
6064
+ WsAlertPositionLiquidityEvent: {
6065
+ /**
6066
+ * @description discriminator enum property added by openapi-typescript
6067
+ * @enum {string}
6068
+ */
6069
+ event: "position_liquidity";
6070
+ /**
6071
+ * Format: int64
6072
+ * @description Unix timestamp in milliseconds
6073
+ */
6074
+ timestamp: number;
6075
+ data: components["schemas"]["PositionLiquidityPayload"];
6076
+ };
6077
+ WsAlertMarketLiquiditySubscribeMessage: ({
6078
+ /** @enum {string} */
6079
+ op: "subscribe";
6080
+ /** @enum {string} */
6081
+ event: "market_liquidity";
6082
+ } & components["schemas"]["MarketLiquidityFilters"] & {
6083
+ /**
6084
+ * @description discriminator enum property added by openapi-typescript
6085
+ * @enum {string}
6086
+ */
6087
+ event: "market_liquidity";
6088
+ }) | unknown;
6089
+ WsAlertMarketLiquidityUnsubscribeMessage: ({
6090
+ /** @enum {string} */
6091
+ op: "unsubscribe";
6092
+ /** @enum {string} */
6093
+ event: "market_liquidity";
6094
+ } & components["schemas"]["MarketLiquidityFilters"] & {
6095
+ /**
6096
+ * @description discriminator enum property added by openapi-typescript
6097
+ * @enum {string}
6098
+ */
6099
+ event: "market_liquidity";
6100
+ }) | unknown;
6101
+ /**
6102
+ * @description Pushed `market_liquidity` alert. The `data` payload matches the corresponding HTTP webhook payload schema.
6103
+ * @example {
6104
+ * "event": "market_liquidity",
6105
+ * "timestamp": 1743500000000,
6106
+ * "data": {
6107
+ * "condition_id": "0x0000000000000000000000000000000000000000000000000000000000000000",
6108
+ * "liquidity_usd": 125000,
6109
+ * "threshold_usd": 100000,
6110
+ * "direction": "above",
6111
+ * "liquidity_updated_at": 1700000000000
6112
+ * }
6113
+ * }
6114
+ */
6115
+ WsAlertMarketLiquidityEvent: {
6116
+ /**
6117
+ * @description discriminator enum property added by openapi-typescript
6118
+ * @enum {string}
6119
+ */
6120
+ event: "market_liquidity";
6121
+ /**
6122
+ * Format: int64
6123
+ * @description Unix timestamp in milliseconds
6124
+ */
6125
+ timestamp: number;
6126
+ data: components["schemas"]["MarketLiquidityPayload"];
6127
+ };
6128
+ WsAlertEventLiquiditySubscribeMessage: ({
6129
+ /** @enum {string} */
6130
+ op: "subscribe";
6131
+ /** @enum {string} */
6132
+ event: "event_liquidity";
6133
+ } & components["schemas"]["EventLiquidityFilters"] & {
6134
+ /**
6135
+ * @description discriminator enum property added by openapi-typescript
6136
+ * @enum {string}
6137
+ */
6138
+ event: "event_liquidity";
6139
+ }) | unknown;
6140
+ WsAlertEventLiquidityUnsubscribeMessage: ({
6141
+ /** @enum {string} */
6142
+ op: "unsubscribe";
6143
+ /** @enum {string} */
6144
+ event: "event_liquidity";
6145
+ } & components["schemas"]["EventLiquidityFilters"] & {
6146
+ /**
6147
+ * @description discriminator enum property added by openapi-typescript
6148
+ * @enum {string}
6149
+ */
6150
+ event: "event_liquidity";
6151
+ }) | unknown;
6152
+ /**
6153
+ * @description Pushed `event_liquidity` alert. The `data` payload matches the corresponding HTTP webhook payload schema.
6154
+ * @example {
6155
+ * "event": "event_liquidity",
6156
+ * "timestamp": 1743500000000,
6157
+ * "data": {
6158
+ * "event_slug": "us-presidential-election-2024",
6159
+ * "liquidity_usd": 2500000,
6160
+ * "threshold_usd": 1000000,
6161
+ * "direction": "above",
6162
+ * "liquidity_updated_at": 1700000000000
6163
+ * }
6164
+ * }
6165
+ */
6166
+ WsAlertEventLiquidityEvent: {
6167
+ /**
6168
+ * @description discriminator enum property added by openapi-typescript
6169
+ * @enum {string}
6170
+ */
6171
+ event: "event_liquidity";
6172
+ /**
6173
+ * Format: int64
6174
+ * @description Unix timestamp in milliseconds
6175
+ */
6176
+ timestamp: number;
6177
+ data: components["schemas"]["EventLiquidityPayload"];
6178
+ };
5333
6179
  WsAlertMarketVolumeMilestoneSubscribeMessage: {
5334
6180
  /** @enum {string} */
5335
6181
  op: "subscribe";
@@ -6269,11 +7115,11 @@ export interface components {
6269
7115
  data: components["schemas"]["AssetPriceWindowUpdatePayload"];
6270
7116
  };
6271
7117
  /** @description Typed subscribe request for the alerts WebSocket. The request shape depends on `event`; filters follow the schema associated with that event type. */
6272
- WsAlertSubscribeMessage: components["schemas"]["WsAlertTraderFirstTradeSubscribeMessage"] | components["schemas"]["WsAlertTraderNewMarketSubscribeMessage"] | components["schemas"]["WsAlertTraderWhaleTradeSubscribeMessage"] | components["schemas"]["WsAlertTraderNewTradeSubscribeMessage"] | components["schemas"]["WsAlertTraderTradeEventSubscribeMessage"] | components["schemas"]["WsAlertTraderGlobalPnlSubscribeMessage"] | components["schemas"]["WsAlertTraderMarketPnlSubscribeMessage"] | components["schemas"]["WsAlertTraderCategoryPnlSubscribeMessage"] | components["schemas"]["WsAlertTraderPositionResolvedSubscribeMessage"] | components["schemas"]["WsAlertTraderPnlExitsSubscribeMessage"] | components["schemas"]["WsAlertPositionHolderMetricsSubscribeMessage"] | components["schemas"]["WsAlertConditionHolderMetricsSubscribeMessage"] | components["schemas"]["WsAlertEventHolderMetricsSubscribeMessage"] | components["schemas"]["WsAlertConditionMetricsSubscribeMessage"] | components["schemas"]["WsAlertEventMetricsSubscribeMessage"] | components["schemas"]["WsAlertTagMetricsSubscribeMessage"] | components["schemas"]["WsAlertPositionMetricsSubscribeMessage"] | components["schemas"]["WsAlertMarketVolumeMilestoneSubscribeMessage"] | components["schemas"]["WsAlertEventVolumeMilestoneSubscribeMessage"] | components["schemas"]["WsAlertPositionVolumeMilestoneSubscribeMessage"] | components["schemas"]["WsAlertProbabilitySpikeSubscribeMessage"] | components["schemas"]["WsAlertPriceSpikeSubscribeMessage"] | components["schemas"]["WsAlertMarketVolumeSpikeSubscribeMessage"] | components["schemas"]["WsAlertEventVolumeSpikeSubscribeMessage"] | components["schemas"]["WsAlertPositionVolumeSpikeSubscribeMessage"] | components["schemas"]["WsAlertCloseToBondSubscribeMessage"] | components["schemas"]["WsAlertPriceThresholdSubscribeMessage"] | components["schemas"]["WsAlertMarketResolvedSubscribeMessage"] | components["schemas"]["WsAlertMarketDisputedSubscribeMessage"] | components["schemas"]["WsAlertMarketCreatedSubscribeMessage"] | components["schemas"]["WsAlertOracleEventsSubscribeMessage"] | components["schemas"]["WsAlertAssetPriceTickSubscribeMessage"] | components["schemas"]["WsAlertAssetPriceWindowUpdateSubscribeMessage"];
7118
+ WsAlertSubscribeMessage: components["schemas"]["WsAlertTraderFirstTradeSubscribeMessage"] | components["schemas"]["WsAlertTraderNewMarketSubscribeMessage"] | components["schemas"]["WsAlertTraderWhaleTradeSubscribeMessage"] | components["schemas"]["WsAlertTraderNewTradeSubscribeMessage"] | components["schemas"]["WsAlertTraderTradeEventSubscribeMessage"] | components["schemas"]["WsAlertTraderGlobalPnlSubscribeMessage"] | components["schemas"]["WsAlertTraderMarketPnlSubscribeMessage"] | components["schemas"]["WsAlertTraderCategoryPnlSubscribeMessage"] | components["schemas"]["WsAlertTraderPositionResolvedSubscribeMessage"] | components["schemas"]["WsAlertTraderPnlExitsSubscribeMessage"] | components["schemas"]["WsAlertPositionHolderMetricsSubscribeMessage"] | components["schemas"]["WsAlertConditionHolderMetricsSubscribeMessage"] | components["schemas"]["WsAlertEventHolderMetricsSubscribeMessage"] | components["schemas"]["WsAlertConditionMetricsSubscribeMessage"] | components["schemas"]["WsAlertEventMetricsSubscribeMessage"] | components["schemas"]["WsAlertTagMetricsSubscribeMessage"] | components["schemas"]["WsAlertPositionMetricsSubscribeMessage"] | components["schemas"]["WsAlertPositionLiquiditySubscribeMessage"] | components["schemas"]["WsAlertMarketLiquiditySubscribeMessage"] | components["schemas"]["WsAlertEventLiquiditySubscribeMessage"] | components["schemas"]["WsAlertMarketVolumeMilestoneSubscribeMessage"] | components["schemas"]["WsAlertEventVolumeMilestoneSubscribeMessage"] | components["schemas"]["WsAlertPositionVolumeMilestoneSubscribeMessage"] | components["schemas"]["WsAlertProbabilitySpikeSubscribeMessage"] | components["schemas"]["WsAlertPriceSpikeSubscribeMessage"] | components["schemas"]["WsAlertMarketVolumeSpikeSubscribeMessage"] | components["schemas"]["WsAlertEventVolumeSpikeSubscribeMessage"] | components["schemas"]["WsAlertPositionVolumeSpikeSubscribeMessage"] | components["schemas"]["WsAlertCloseToBondSubscribeMessage"] | components["schemas"]["WsAlertPriceThresholdSubscribeMessage"] | components["schemas"]["WsAlertMarketResolvedSubscribeMessage"] | components["schemas"]["WsAlertMarketDisputedSubscribeMessage"] | components["schemas"]["WsAlertMarketCreatedSubscribeMessage"] | components["schemas"]["WsAlertOracleEventsSubscribeMessage"] | components["schemas"]["WsAlertAssetPriceTickSubscribeMessage"] | components["schemas"]["WsAlertAssetPriceWindowUpdateSubscribeMessage"];
6273
7119
  /** @description Typed unsubscribe request for the alerts WebSocket. The request shape depends on `event` and must match the original subscription filters. */
6274
- WsAlertUnsubscribeMessage: components["schemas"]["WsAlertTraderFirstTradeUnsubscribeMessage"] | components["schemas"]["WsAlertTraderNewMarketUnsubscribeMessage"] | components["schemas"]["WsAlertTraderWhaleTradeUnsubscribeMessage"] | components["schemas"]["WsAlertTraderNewTradeUnsubscribeMessage"] | components["schemas"]["WsAlertTraderTradeEventUnsubscribeMessage"] | components["schemas"]["WsAlertTraderGlobalPnlUnsubscribeMessage"] | components["schemas"]["WsAlertTraderMarketPnlUnsubscribeMessage"] | components["schemas"]["WsAlertTraderCategoryPnlUnsubscribeMessage"] | components["schemas"]["WsAlertTraderPositionResolvedUnsubscribeMessage"] | components["schemas"]["WsAlertTraderPnlExitsUnsubscribeMessage"] | components["schemas"]["WsAlertPositionHolderMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertConditionHolderMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertEventHolderMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertConditionMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertEventMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertTagMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertPositionMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertMarketVolumeMilestoneUnsubscribeMessage"] | components["schemas"]["WsAlertEventVolumeMilestoneUnsubscribeMessage"] | components["schemas"]["WsAlertPositionVolumeMilestoneUnsubscribeMessage"] | components["schemas"]["WsAlertProbabilitySpikeUnsubscribeMessage"] | components["schemas"]["WsAlertPriceSpikeUnsubscribeMessage"] | components["schemas"]["WsAlertMarketVolumeSpikeUnsubscribeMessage"] | components["schemas"]["WsAlertEventVolumeSpikeUnsubscribeMessage"] | components["schemas"]["WsAlertPositionVolumeSpikeUnsubscribeMessage"] | components["schemas"]["WsAlertCloseToBondUnsubscribeMessage"] | components["schemas"]["WsAlertPriceThresholdUnsubscribeMessage"] | components["schemas"]["WsAlertMarketResolvedUnsubscribeMessage"] | components["schemas"]["WsAlertMarketDisputedUnsubscribeMessage"] | components["schemas"]["WsAlertMarketCreatedUnsubscribeMessage"] | components["schemas"]["WsAlertOracleEventsUnsubscribeMessage"] | components["schemas"]["WsAlertAssetPriceTickUnsubscribeMessage"] | components["schemas"]["WsAlertAssetPriceWindowUpdateUnsubscribeMessage"];
7120
+ WsAlertUnsubscribeMessage: components["schemas"]["WsAlertTraderFirstTradeUnsubscribeMessage"] | components["schemas"]["WsAlertTraderNewMarketUnsubscribeMessage"] | components["schemas"]["WsAlertTraderWhaleTradeUnsubscribeMessage"] | components["schemas"]["WsAlertTraderNewTradeUnsubscribeMessage"] | components["schemas"]["WsAlertTraderTradeEventUnsubscribeMessage"] | components["schemas"]["WsAlertTraderGlobalPnlUnsubscribeMessage"] | components["schemas"]["WsAlertTraderMarketPnlUnsubscribeMessage"] | components["schemas"]["WsAlertTraderCategoryPnlUnsubscribeMessage"] | components["schemas"]["WsAlertTraderPositionResolvedUnsubscribeMessage"] | components["schemas"]["WsAlertTraderPnlExitsUnsubscribeMessage"] | components["schemas"]["WsAlertPositionHolderMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertConditionHolderMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertEventHolderMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertConditionMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertEventMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertTagMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertPositionMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertPositionLiquidityUnsubscribeMessage"] | components["schemas"]["WsAlertMarketLiquidityUnsubscribeMessage"] | components["schemas"]["WsAlertEventLiquidityUnsubscribeMessage"] | components["schemas"]["WsAlertMarketVolumeMilestoneUnsubscribeMessage"] | components["schemas"]["WsAlertEventVolumeMilestoneUnsubscribeMessage"] | components["schemas"]["WsAlertPositionVolumeMilestoneUnsubscribeMessage"] | components["schemas"]["WsAlertProbabilitySpikeUnsubscribeMessage"] | components["schemas"]["WsAlertPriceSpikeUnsubscribeMessage"] | components["schemas"]["WsAlertMarketVolumeSpikeUnsubscribeMessage"] | components["schemas"]["WsAlertEventVolumeSpikeUnsubscribeMessage"] | components["schemas"]["WsAlertPositionVolumeSpikeUnsubscribeMessage"] | components["schemas"]["WsAlertCloseToBondUnsubscribeMessage"] | components["schemas"]["WsAlertPriceThresholdUnsubscribeMessage"] | components["schemas"]["WsAlertMarketResolvedUnsubscribeMessage"] | components["schemas"]["WsAlertMarketDisputedUnsubscribeMessage"] | components["schemas"]["WsAlertMarketCreatedUnsubscribeMessage"] | components["schemas"]["WsAlertOracleEventsUnsubscribeMessage"] | components["schemas"]["WsAlertAssetPriceTickUnsubscribeMessage"] | components["schemas"]["WsAlertAssetPriceWindowUpdateUnsubscribeMessage"];
6275
7121
  /** @description Typed pushed-event envelope for the alerts WebSocket. The `data` payload depends on `event` and matches the corresponding HTTP webhook payload schema. */
6276
- WsAlertEventPayload: components["schemas"]["WsAlertTraderFirstTradeEvent"] | components["schemas"]["WsAlertTraderNewMarketEvent"] | components["schemas"]["WsAlertTraderWhaleTradeEvent"] | components["schemas"]["WsAlertTraderNewTradeEvent"] | components["schemas"]["WsAlertTraderTradeEventEvent"] | components["schemas"]["WsAlertTraderGlobalPnlEvent"] | components["schemas"]["WsAlertTraderMarketPnlEvent"] | components["schemas"]["WsAlertTraderCategoryPnlEvent"] | components["schemas"]["WsAlertTraderPositionResolvedEvent"] | components["schemas"]["WsAlertTraderPnlExitsEvent"] | components["schemas"]["WsAlertPositionHolderMetricsEvent"] | components["schemas"]["WsAlertConditionHolderMetricsEvent"] | components["schemas"]["WsAlertEventHolderMetricsEvent"] | components["schemas"]["WsAlertConditionMetricsEvent"] | components["schemas"]["WsAlertEventMetricsEvent"] | components["schemas"]["WsAlertTagMetricsEvent"] | components["schemas"]["WsAlertPositionMetricsEvent"] | components["schemas"]["WsAlertMarketVolumeMilestoneEvent"] | components["schemas"]["WsAlertEventVolumeMilestoneEvent"] | components["schemas"]["WsAlertPositionVolumeMilestoneEvent"] | components["schemas"]["WsAlertProbabilitySpikeEvent"] | components["schemas"]["WsAlertPriceSpikeEvent"] | components["schemas"]["WsAlertMarketVolumeSpikeEvent"] | components["schemas"]["WsAlertEventVolumeSpikeEvent"] | components["schemas"]["WsAlertPositionVolumeSpikeEvent"] | components["schemas"]["WsAlertCloseToBondEvent"] | components["schemas"]["WsAlertPriceThresholdEvent"] | components["schemas"]["WsAlertMarketResolvedEvent"] | components["schemas"]["WsAlertMarketDisputedEvent"] | components["schemas"]["WsAlertMarketCreatedEvent"] | components["schemas"]["WsAlertOracleEventsEvent"] | components["schemas"]["WsAlertAssetPriceTickEvent"] | components["schemas"]["WsAlertAssetPriceWindowUpdateEvent"];
7122
+ WsAlertEventPayload: components["schemas"]["WsAlertTraderFirstTradeEvent"] | components["schemas"]["WsAlertTraderNewMarketEvent"] | components["schemas"]["WsAlertTraderWhaleTradeEvent"] | components["schemas"]["WsAlertTraderNewTradeEvent"] | components["schemas"]["WsAlertTraderTradeEventEvent"] | components["schemas"]["WsAlertTraderGlobalPnlEvent"] | components["schemas"]["WsAlertTraderMarketPnlEvent"] | components["schemas"]["WsAlertTraderCategoryPnlEvent"] | components["schemas"]["WsAlertTraderPositionResolvedEvent"] | components["schemas"]["WsAlertTraderPnlExitsEvent"] | components["schemas"]["WsAlertPositionHolderMetricsEvent"] | components["schemas"]["WsAlertConditionHolderMetricsEvent"] | components["schemas"]["WsAlertEventHolderMetricsEvent"] | components["schemas"]["WsAlertConditionMetricsEvent"] | components["schemas"]["WsAlertEventMetricsEvent"] | components["schemas"]["WsAlertTagMetricsEvent"] | components["schemas"]["WsAlertPositionMetricsEvent"] | components["schemas"]["WsAlertPositionLiquidityEvent"] | components["schemas"]["WsAlertMarketLiquidityEvent"] | components["schemas"]["WsAlertEventLiquidityEvent"] | components["schemas"]["WsAlertMarketVolumeMilestoneEvent"] | components["schemas"]["WsAlertEventVolumeMilestoneEvent"] | components["schemas"]["WsAlertPositionVolumeMilestoneEvent"] | components["schemas"]["WsAlertProbabilitySpikeEvent"] | components["schemas"]["WsAlertPriceSpikeEvent"] | components["schemas"]["WsAlertMarketVolumeSpikeEvent"] | components["schemas"]["WsAlertEventVolumeSpikeEvent"] | components["schemas"]["WsAlertPositionVolumeSpikeEvent"] | components["schemas"]["WsAlertCloseToBondEvent"] | components["schemas"]["WsAlertPriceThresholdEvent"] | components["schemas"]["WsAlertMarketResolvedEvent"] | components["schemas"]["WsAlertMarketDisputedEvent"] | components["schemas"]["WsAlertMarketCreatedEvent"] | components["schemas"]["WsAlertOracleEventsEvent"] | components["schemas"]["WsAlertAssetPriceTickEvent"] | components["schemas"]["WsAlertAssetPriceWindowUpdateEvent"];
6277
7123
  };
6278
7124
  responses: never;
6279
7125
  parameters: never;
@@ -6301,6 +7147,9 @@ export interface WsAlertSubscribeMap {
6301
7147
  event_metrics: components["schemas"]["WsAlertEventMetricsSubscribeMessage"];
6302
7148
  tag_metrics: components["schemas"]["WsAlertTagMetricsSubscribeMessage"];
6303
7149
  position_metrics: components["schemas"]["WsAlertPositionMetricsSubscribeMessage"];
7150
+ position_liquidity: components["schemas"]["WsAlertPositionLiquiditySubscribeMessage"];
7151
+ market_liquidity: components["schemas"]["WsAlertMarketLiquiditySubscribeMessage"];
7152
+ event_liquidity: components["schemas"]["WsAlertEventLiquiditySubscribeMessage"];
6304
7153
  market_volume_milestone: components["schemas"]["WsAlertMarketVolumeMilestoneSubscribeMessage"];
6305
7154
  event_volume_milestone: components["schemas"]["WsAlertEventVolumeMilestoneSubscribeMessage"];
6306
7155
  position_volume_milestone: components["schemas"]["WsAlertPositionVolumeMilestoneSubscribeMessage"];
@@ -6336,6 +7185,9 @@ export interface WsAlertEventDataMap {
6336
7185
  event_metrics: components["schemas"]["EventMetricsPayload"];
6337
7186
  tag_metrics: components["schemas"]["TagMetricsPayload"];
6338
7187
  position_metrics: components["schemas"]["PositionMetricsPayload"];
7188
+ position_liquidity: components["schemas"]["PositionLiquidityPayload"];
7189
+ market_liquidity: components["schemas"]["MarketLiquidityPayload"];
7190
+ event_liquidity: components["schemas"]["EventLiquidityPayload"];
6339
7191
  market_volume_milestone: components["schemas"]["VolumeMilestonePayload"];
6340
7192
  event_volume_milestone: components["schemas"]["EventVolumeMilestonePayload"];
6341
7193
  position_volume_milestone: components["schemas"]["PositionVolumeMilestonePayload"];