@structbuild/sdk 0.3.3 → 0.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/polymarket.d.ts +135 -0
- package/dist/generated/webhooks.d.ts +12 -12
- package/dist/generated/ws-alerts.d.ts +23 -23
- package/dist/generated/ws.d.ts +248 -87
- package/dist/index.cjs +4 -1
- package/dist/index.cjs.map +3 -3
- package/dist/index.js +4 -1
- package/dist/index.js.map +3 -3
- package/dist/namespaces/trader.d.ts +2 -1
- package/dist/types/index.d.ts +39 -1
- package/dist/types/ws.d.ts +14 -2
- package/package.json +1 -1
|
@@ -703,6 +703,26 @@ export interface paths {
|
|
|
703
703
|
patch?: never;
|
|
704
704
|
trace?: never;
|
|
705
705
|
};
|
|
706
|
+
"/polymarket/trader/leaderboard": {
|
|
707
|
+
parameters: {
|
|
708
|
+
query?: never;
|
|
709
|
+
header?: never;
|
|
710
|
+
path?: never;
|
|
711
|
+
cookie?: never;
|
|
712
|
+
};
|
|
713
|
+
/**
|
|
714
|
+
* Get trader leaderboard
|
|
715
|
+
* @description Global trader leaderboard ranked by PnL or volume over the selected timeframe. Each entry carries the trader's identity, ranking score (`pnl`), and the full set of Struct trading metrics (volumes split by side, markets_won / markets_lost, win rate, average PnL per market and per trade, average hold time, best trade, fees, and first / last trade timestamps). Enrichment fields are `null` when we don't yet have a row for that address in the selected timeframe.
|
|
716
|
+
*/
|
|
717
|
+
get: operations["get_polymarket_leaderboard"];
|
|
718
|
+
put?: never;
|
|
719
|
+
post?: never;
|
|
720
|
+
delete?: never;
|
|
721
|
+
options?: never;
|
|
722
|
+
head?: never;
|
|
723
|
+
patch?: never;
|
|
724
|
+
trace?: never;
|
|
725
|
+
};
|
|
706
726
|
"/polymarket/trader/pnl/{address}": {
|
|
707
727
|
parameters: {
|
|
708
728
|
query?: never;
|
|
@@ -1380,6 +1400,76 @@ export interface components {
|
|
|
1380
1400
|
/** Format: int64 */
|
|
1381
1401
|
last_trade_at?: number | null;
|
|
1382
1402
|
};
|
|
1403
|
+
/**
|
|
1404
|
+
* @description Market category filter for the trader leaderboard.
|
|
1405
|
+
* Mirrors `common::gamma::categories::Category` plus `overall` (= all).
|
|
1406
|
+
* @enum {string}
|
|
1407
|
+
*/
|
|
1408
|
+
LeaderboardCategory: "overall" | "politics" | "sports" | "crypto" | "finance" | "culture" | "mentions" | "weather" | "economics" | "tech";
|
|
1409
|
+
/**
|
|
1410
|
+
* @description Flat response row. `trader` is the canonical `TraderInfo` used across all
|
|
1411
|
+
* our other endpoints; all enrichment fields sit at the top level. Fields
|
|
1412
|
+
* other than `trader`, `rank`, `pnl`, and `timeframe` are sourced from our
|
|
1413
|
+
* `prediction_trader_pnl_*_v2` tables and are `null` when we don't yet have
|
|
1414
|
+
* a row for that address in the selected timeframe.
|
|
1415
|
+
*/
|
|
1416
|
+
LeaderboardEntry: {
|
|
1417
|
+
/** Format: int64 */
|
|
1418
|
+
rank?: number | null;
|
|
1419
|
+
trader: components["schemas"]["TraderInfo"];
|
|
1420
|
+
/** Format: double */
|
|
1421
|
+
pnl?: number | null;
|
|
1422
|
+
/** Format: int64 */
|
|
1423
|
+
events_traded?: number | null;
|
|
1424
|
+
/** Format: int64 */
|
|
1425
|
+
markets_traded?: number | null;
|
|
1426
|
+
/** Format: int64 */
|
|
1427
|
+
markets_won?: number | null;
|
|
1428
|
+
/** Format: int64 */
|
|
1429
|
+
markets_lost?: number | null;
|
|
1430
|
+
/** Format: double */
|
|
1431
|
+
market_win_rate_pct?: number | null;
|
|
1432
|
+
/** Format: double */
|
|
1433
|
+
total_volume_usd?: number | null;
|
|
1434
|
+
/** Format: double */
|
|
1435
|
+
buy_volume_usd?: number | null;
|
|
1436
|
+
/** Format: double */
|
|
1437
|
+
sell_volume_usd?: number | null;
|
|
1438
|
+
/** Format: double */
|
|
1439
|
+
redemption_volume_usd?: number | null;
|
|
1440
|
+
/** Format: double */
|
|
1441
|
+
merge_volume_usd?: number | null;
|
|
1442
|
+
/** Format: int64 */
|
|
1443
|
+
total_buys?: number | null;
|
|
1444
|
+
/** Format: int64 */
|
|
1445
|
+
total_sells?: number | null;
|
|
1446
|
+
/** Format: int64 */
|
|
1447
|
+
total_redemptions?: number | null;
|
|
1448
|
+
/** Format: int64 */
|
|
1449
|
+
total_merges?: number | null;
|
|
1450
|
+
/** Format: int64 */
|
|
1451
|
+
total_trades?: number | null;
|
|
1452
|
+
/** Format: double */
|
|
1453
|
+
total_fees?: number | null;
|
|
1454
|
+
/** Format: double */
|
|
1455
|
+
avg_pnl_per_market?: number | null;
|
|
1456
|
+
/** Format: double */
|
|
1457
|
+
avg_pnl_per_trade?: number | null;
|
|
1458
|
+
/** Format: double */
|
|
1459
|
+
avg_hold_time_seconds?: number | null;
|
|
1460
|
+
/** Format: double */
|
|
1461
|
+
best_trade_pnl_usd?: number | null;
|
|
1462
|
+
best_trade_condition_id?: string | null;
|
|
1463
|
+
/** Format: int64 */
|
|
1464
|
+
first_trade_at?: number | null;
|
|
1465
|
+
/** Format: int64 */
|
|
1466
|
+
last_trade_at?: number | null;
|
|
1467
|
+
};
|
|
1468
|
+
/**
|
|
1469
|
+
* @description Sort key for the trader leaderboard (`GET /polymarket/trader/leaderboard`).
|
|
1470
|
+
* @enum {string}
|
|
1471
|
+
*/
|
|
1472
|
+
LeaderboardSortBy: "pnl" | "volume";
|
|
1383
1473
|
/** @description Response for market (condition_id) holders endpoint */
|
|
1384
1474
|
MarketHoldersResponse: {
|
|
1385
1475
|
/** @description Market condition ID */
|
|
@@ -4420,6 +4510,51 @@ export interface operations {
|
|
|
4420
4510
|
};
|
|
4421
4511
|
};
|
|
4422
4512
|
};
|
|
4513
|
+
get_polymarket_leaderboard: {
|
|
4514
|
+
parameters: {
|
|
4515
|
+
query?: {
|
|
4516
|
+
/** @description Aggregation window (default: lifetime) */
|
|
4517
|
+
timeframe?: components["schemas"]["PnlTimeframe"];
|
|
4518
|
+
/** @description Order by: pnl or volume (default: pnl). Case-insensitive. */
|
|
4519
|
+
sort_by?: components["schemas"]["LeaderboardSortBy"];
|
|
4520
|
+
/** @description Rows per page, 1..=50 (default: 20) */
|
|
4521
|
+
limit?: number;
|
|
4522
|
+
/** @description Offset for pagination (default: 0) */
|
|
4523
|
+
offset?: number;
|
|
4524
|
+
/** @description Market category filter. Case-insensitive. Default: overall. */
|
|
4525
|
+
category?: components["schemas"]["LeaderboardCategory"];
|
|
4526
|
+
};
|
|
4527
|
+
header?: never;
|
|
4528
|
+
path?: never;
|
|
4529
|
+
cookie?: never;
|
|
4530
|
+
};
|
|
4531
|
+
requestBody?: never;
|
|
4532
|
+
responses: {
|
|
4533
|
+
/** @description Leaderboard rows with full trader metrics. */
|
|
4534
|
+
200: {
|
|
4535
|
+
headers: {
|
|
4536
|
+
[name: string]: unknown;
|
|
4537
|
+
};
|
|
4538
|
+
content: {
|
|
4539
|
+
"application/json": components["schemas"]["LeaderboardEntry"][];
|
|
4540
|
+
};
|
|
4541
|
+
};
|
|
4542
|
+
/** @description Bad request — invalid timeframe, sort_by, or category */
|
|
4543
|
+
400: {
|
|
4544
|
+
headers: {
|
|
4545
|
+
[name: string]: unknown;
|
|
4546
|
+
};
|
|
4547
|
+
content?: never;
|
|
4548
|
+
};
|
|
4549
|
+
/** @description Leaderboard unavailable */
|
|
4550
|
+
500: {
|
|
4551
|
+
headers: {
|
|
4552
|
+
[name: string]: unknown;
|
|
4553
|
+
};
|
|
4554
|
+
content?: never;
|
|
4555
|
+
};
|
|
4556
|
+
};
|
|
4557
|
+
};
|
|
4423
4558
|
get_trader_pnl: {
|
|
4424
4559
|
parameters: {
|
|
4425
4560
|
query?: {
|
|
@@ -197,7 +197,7 @@ export interface webhooks {
|
|
|
197
197
|
patch?: never;
|
|
198
198
|
trace?: never;
|
|
199
199
|
};
|
|
200
|
-
"trade-event": {
|
|
200
|
+
"trader-trade-event": {
|
|
201
201
|
parameters: {
|
|
202
202
|
query?: never;
|
|
203
203
|
header?: never;
|
|
@@ -208,9 +208,9 @@ export interface webhooks {
|
|
|
208
208
|
put?: never;
|
|
209
209
|
/**
|
|
210
210
|
* Typed trade-event callback
|
|
211
|
-
* @description Fired on every live confirmed prediction-trade event. Payload uses the exact tagged `
|
|
211
|
+
* @description Fired on every live confirmed prediction-trade event. Payload uses the exact tagged `WebhookTraderTradeEventPayload` union for the trade types currently emitted by the webhook pipeline.
|
|
212
212
|
*/
|
|
213
|
-
post: operations["trade-event"];
|
|
213
|
+
post: operations["trader-trade-event"];
|
|
214
214
|
delete?: never;
|
|
215
215
|
options?: never;
|
|
216
216
|
head?: never;
|
|
@@ -1225,7 +1225,7 @@ export interface components {
|
|
|
1225
1225
|
* @description Polymarket webhook event types
|
|
1226
1226
|
* @enum {string}
|
|
1227
1227
|
*/
|
|
1228
|
-
PolymarketWebhookEvent: "trader_first_trade" | "trader_new_market" | "trader_whale_trade" | "trader_new_trade" | "
|
|
1228
|
+
PolymarketWebhookEvent: "trader_first_trade" | "trader_new_market" | "trader_whale_trade" | "trader_new_trade" | "trader_trade_event" | "trader_global_pnl" | "trader_market_pnl" | "trader_event_pnl" | "condition_metrics" | "event_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";
|
|
1229
1229
|
/**
|
|
1230
1230
|
* @description Polymarket-specific webhook filters
|
|
1231
1231
|
*
|
|
@@ -1245,7 +1245,7 @@ export interface components {
|
|
|
1245
1245
|
* - probability_spike: condition_ids, event_slugs, outcomes, min_probability_change_pct, spike_direction, window_secs, exclude_shortterm_markets
|
|
1246
1246
|
* - price_spike: condition_ids, event_slugs, outcomes, min_price_change_pct, spike_direction, window_secs, exclude_shortterm_markets
|
|
1247
1247
|
* - trader_new_trade: wallet_addresses, min_usd_value, min_probability, max_probability, condition_ids, event_slugs, trade_types, exclude_shortterm_markets
|
|
1248
|
-
* -
|
|
1248
|
+
* - trader_trade_event: wallet_addresses, min_usd_value, min_probability, max_probability, condition_ids, event_slugs, trade_types, exclude_shortterm_markets
|
|
1249
1249
|
* - trader_first_trade: wallet_addresses, min_usd_value, min_probability, max_probability, exclude_shortterm_markets
|
|
1250
1250
|
* - trader_new_market: wallet_addresses, condition_ids, event_slugs, min_usd_value, min_probability, max_probability, exclude_shortterm_markets
|
|
1251
1251
|
* - trader_whale_trade: min_usd_value (required), min_probability, max_probability, condition_ids, event_slugs, exclude_shortterm_markets
|
|
@@ -1648,7 +1648,7 @@ export interface components {
|
|
|
1648
1648
|
outcomes?: string[];
|
|
1649
1649
|
/** @description Filter by position outcome index — for close_to_bond. Position 0 = Yes/Up, 1 = No. Max 500 entries. */
|
|
1650
1650
|
position_outcome_indices?: number[];
|
|
1651
|
-
/** @description Filter by trade type — for `trader_new_trade` and `
|
|
1651
|
+
/** @description Filter by trade type — for `trader_new_trade` and `trader_trade_event`. Max 500 entries. */
|
|
1652
1652
|
trade_types?: string[];
|
|
1653
1653
|
/**
|
|
1654
1654
|
* Format: double
|
|
@@ -1920,8 +1920,8 @@ export interface components {
|
|
|
1920
1920
|
/** @description Delivery attempt number. 1 = first attempt; increments on each retry. */
|
|
1921
1921
|
attempt: number;
|
|
1922
1922
|
};
|
|
1923
|
-
/** @description Exact payload union for `
|
|
1924
|
-
|
|
1923
|
+
/** @description Exact payload union for `trader_trade_event` webhook deliveries. These callbacks are emitted from the live confirmed trade pipeline, so pending-only fields such as `received_at` are absent. */
|
|
1924
|
+
WebhookTraderTradeEventPayload: {
|
|
1925
1925
|
id: string;
|
|
1926
1926
|
hash: string;
|
|
1927
1927
|
/** Format: int64 */
|
|
@@ -2472,8 +2472,8 @@ export interface components {
|
|
|
2472
2472
|
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
2473
2473
|
exclude_shortterm_markets?: boolean;
|
|
2474
2474
|
};
|
|
2475
|
-
/** @description Subscription filters for the `
|
|
2476
|
-
|
|
2475
|
+
/** @description Subscription filters for the `trader_trade_event` event. All fields are optional. `event_slugs` and `exclude_shortterm_markets` require explicit `trade_types` that exclude `PositionsConverted`, because conversion events do not currently carry `event_slug` in the typed webhook payload. */
|
|
2476
|
+
TraderTradeEventFilters: {
|
|
2477
2477
|
/** @description Only fire for events associated with these wallet addresses. Empty = all traders. */
|
|
2478
2478
|
wallet_addresses?: string[];
|
|
2479
2479
|
/** @description Restrict to these markets. For `PositionsConverted`, this also matches the NegRisk `market_id`. */
|
|
@@ -3284,7 +3284,7 @@ export interface operations {
|
|
|
3284
3284
|
};
|
|
3285
3285
|
};
|
|
3286
3286
|
};
|
|
3287
|
-
"trade-event": {
|
|
3287
|
+
"trader-trade-event": {
|
|
3288
3288
|
parameters: {
|
|
3289
3289
|
query?: never;
|
|
3290
3290
|
header: {
|
|
@@ -3306,7 +3306,7 @@ export interface operations {
|
|
|
3306
3306
|
requestBody: {
|
|
3307
3307
|
content: {
|
|
3308
3308
|
"application/json": components["schemas"]["WebhookDeliveryEnvelope"] & {
|
|
3309
|
-
data?: components["schemas"]["
|
|
3309
|
+
data?: components["schemas"]["WebhookTraderTradeEventPayload"];
|
|
3310
3310
|
};
|
|
3311
3311
|
};
|
|
3312
3312
|
};
|
|
@@ -264,8 +264,8 @@ export interface components {
|
|
|
264
264
|
*/
|
|
265
265
|
trade_type: "OrderFilled" | "OrdersMatched";
|
|
266
266
|
};
|
|
267
|
-
/** @description Exact payload union for `
|
|
268
|
-
|
|
267
|
+
/** @description Exact payload union for `trader_trade_event` webhook deliveries. These callbacks are emitted from the live confirmed trade pipeline, so pending-only fields such as `received_at` are absent. */
|
|
268
|
+
WebhookTraderTradeEventPayload: {
|
|
269
269
|
id: string;
|
|
270
270
|
hash: string;
|
|
271
271
|
/** Format: int64 */
|
|
@@ -1424,8 +1424,8 @@ export interface components {
|
|
|
1424
1424
|
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
1425
1425
|
exclude_shortterm_markets?: boolean;
|
|
1426
1426
|
};
|
|
1427
|
-
/** @description Subscription filters for the `
|
|
1428
|
-
|
|
1427
|
+
/** @description Subscription filters for the `trader_trade_event` event. All fields are optional. `event_slugs` and `exclude_shortterm_markets` require explicit `trade_types` that exclude `PositionsConverted`, because conversion events do not currently carry `event_slug` in the typed webhook payload. */
|
|
1428
|
+
TraderTradeEventFilters: {
|
|
1429
1429
|
/** @description Only fire for events associated with these wallet addresses. Empty = all traders. */
|
|
1430
1430
|
wallet_addresses?: string[];
|
|
1431
1431
|
/** @description Restrict to these markets. For `PositionsConverted`, this also matches the NegRisk `market_id`. */
|
|
@@ -1745,7 +1745,7 @@ export interface components {
|
|
|
1745
1745
|
* @description All alert event types supported by both HTTP webhooks and the alerts WebSocket.
|
|
1746
1746
|
* @enum {string}
|
|
1747
1747
|
*/
|
|
1748
|
-
WsAlertEventType: "trader_first_trade" | "trader_new_market" | "trader_whale_trade" | "trader_new_trade" | "
|
|
1748
|
+
WsAlertEventType: "trader_first_trade" | "trader_new_market" | "trader_whale_trade" | "trader_new_trade" | "trader_trade_event" | "trader_global_pnl" | "trader_market_pnl" | "trader_event_pnl" | "condition_metrics" | "event_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" | "market_created" | "asset_price_tick" | "asset_price_window_update";
|
|
1749
1749
|
/** @description Server acknowledgement for a successful alert subscription. */
|
|
1750
1750
|
WsAlertSubscribedResponse: {
|
|
1751
1751
|
/** @enum {string} */
|
|
@@ -2031,34 +2031,34 @@ export interface components {
|
|
|
2031
2031
|
timestamp: number;
|
|
2032
2032
|
data: components["schemas"]["NewTradePayload"];
|
|
2033
2033
|
};
|
|
2034
|
-
|
|
2034
|
+
WsAlertTraderTradeEventSubscribeMessage: {
|
|
2035
2035
|
/** @enum {string} */
|
|
2036
2036
|
op: "subscribe";
|
|
2037
2037
|
/** @enum {string} */
|
|
2038
|
-
event: "
|
|
2039
|
-
} & components["schemas"]["
|
|
2038
|
+
event: "trader_trade_event";
|
|
2039
|
+
} & components["schemas"]["TraderTradeEventFilters"] & {
|
|
2040
2040
|
/**
|
|
2041
2041
|
* @description discriminator enum property added by openapi-typescript
|
|
2042
2042
|
* @enum {string}
|
|
2043
2043
|
*/
|
|
2044
|
-
event: "
|
|
2044
|
+
event: "trader_trade_event";
|
|
2045
2045
|
};
|
|
2046
|
-
|
|
2046
|
+
WsAlertTraderTradeEventUnsubscribeMessage: {
|
|
2047
2047
|
/** @enum {string} */
|
|
2048
2048
|
op: "unsubscribe";
|
|
2049
2049
|
/** @enum {string} */
|
|
2050
|
-
event: "
|
|
2051
|
-
} & components["schemas"]["
|
|
2050
|
+
event: "trader_trade_event";
|
|
2051
|
+
} & components["schemas"]["TraderTradeEventFilters"] & {
|
|
2052
2052
|
/**
|
|
2053
2053
|
* @description discriminator enum property added by openapi-typescript
|
|
2054
2054
|
* @enum {string}
|
|
2055
2055
|
*/
|
|
2056
|
-
event: "
|
|
2056
|
+
event: "trader_trade_event";
|
|
2057
2057
|
};
|
|
2058
2058
|
/**
|
|
2059
|
-
* @description Pushed `
|
|
2059
|
+
* @description Pushed `trader_trade_event` alert. The `data` payload matches the corresponding HTTP webhook payload schema.
|
|
2060
2060
|
* @example {
|
|
2061
|
-
* "event": "
|
|
2061
|
+
* "event": "trader_trade_event",
|
|
2062
2062
|
* "timestamp": 1743500000000,
|
|
2063
2063
|
* "data": {
|
|
2064
2064
|
* "trade_type": "OrderFilled",
|
|
@@ -2092,18 +2092,18 @@ export interface components {
|
|
|
2092
2092
|
* }
|
|
2093
2093
|
* }
|
|
2094
2094
|
*/
|
|
2095
|
-
|
|
2095
|
+
WsAlertTraderTradeEventEvent: {
|
|
2096
2096
|
/**
|
|
2097
2097
|
* @description discriminator enum property added by openapi-typescript
|
|
2098
2098
|
* @enum {string}
|
|
2099
2099
|
*/
|
|
2100
|
-
event: "
|
|
2100
|
+
event: "trader_trade_event";
|
|
2101
2101
|
/**
|
|
2102
2102
|
* Format: int64
|
|
2103
2103
|
* @description Unix timestamp in milliseconds
|
|
2104
2104
|
*/
|
|
2105
2105
|
timestamp: number;
|
|
2106
|
-
data: components["schemas"]["
|
|
2106
|
+
data: components["schemas"]["WebhookTraderTradeEventPayload"];
|
|
2107
2107
|
};
|
|
2108
2108
|
WsAlertTraderGlobalPnlSubscribeMessage: {
|
|
2109
2109
|
/** @enum {string} */
|
|
@@ -3158,11 +3158,11 @@ export interface components {
|
|
|
3158
3158
|
data: components["schemas"]["AssetPriceWindowUpdatePayload"];
|
|
3159
3159
|
};
|
|
3160
3160
|
/** @description Typed subscribe request for the alerts WebSocket. The request shape depends on `event` and reuses the matching webhook filter schema. */
|
|
3161
|
-
WsAlertSubscribeMessage: components["schemas"]["WsAlertTraderFirstTradeSubscribeMessage"] | components["schemas"]["WsAlertTraderNewMarketSubscribeMessage"] | components["schemas"]["WsAlertTraderWhaleTradeSubscribeMessage"] | components["schemas"]["WsAlertTraderNewTradeSubscribeMessage"] | components["schemas"]["
|
|
3161
|
+
WsAlertSubscribeMessage: components["schemas"]["WsAlertTraderFirstTradeSubscribeMessage"] | components["schemas"]["WsAlertTraderNewMarketSubscribeMessage"] | components["schemas"]["WsAlertTraderWhaleTradeSubscribeMessage"] | components["schemas"]["WsAlertTraderNewTradeSubscribeMessage"] | components["schemas"]["WsAlertTraderTradeEventSubscribeMessage"] | components["schemas"]["WsAlertTraderGlobalPnlSubscribeMessage"] | components["schemas"]["WsAlertTraderMarketPnlSubscribeMessage"] | components["schemas"]["WsAlertTraderEventPnlSubscribeMessage"] | components["schemas"]["WsAlertConditionMetricsSubscribeMessage"] | components["schemas"]["WsAlertEventMetricsSubscribeMessage"] | 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"]["WsAlertMarketCreatedSubscribeMessage"] | components["schemas"]["WsAlertAssetPriceTickSubscribeMessage"] | components["schemas"]["WsAlertAssetPriceWindowUpdateSubscribeMessage"];
|
|
3162
3162
|
/** @description Typed unsubscribe request for the alerts WebSocket. The request shape depends on `event` and must match the original subscription filters. */
|
|
3163
|
-
WsAlertUnsubscribeMessage: components["schemas"]["WsAlertTraderFirstTradeUnsubscribeMessage"] | components["schemas"]["WsAlertTraderNewMarketUnsubscribeMessage"] | components["schemas"]["WsAlertTraderWhaleTradeUnsubscribeMessage"] | components["schemas"]["WsAlertTraderNewTradeUnsubscribeMessage"] | components["schemas"]["
|
|
3163
|
+
WsAlertUnsubscribeMessage: components["schemas"]["WsAlertTraderFirstTradeUnsubscribeMessage"] | components["schemas"]["WsAlertTraderNewMarketUnsubscribeMessage"] | components["schemas"]["WsAlertTraderWhaleTradeUnsubscribeMessage"] | components["schemas"]["WsAlertTraderNewTradeUnsubscribeMessage"] | components["schemas"]["WsAlertTraderTradeEventUnsubscribeMessage"] | components["schemas"]["WsAlertTraderGlobalPnlUnsubscribeMessage"] | components["schemas"]["WsAlertTraderMarketPnlUnsubscribeMessage"] | components["schemas"]["WsAlertTraderEventPnlUnsubscribeMessage"] | components["schemas"]["WsAlertConditionMetricsUnsubscribeMessage"] | components["schemas"]["WsAlertEventMetricsUnsubscribeMessage"] | 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"]["WsAlertMarketCreatedUnsubscribeMessage"] | components["schemas"]["WsAlertAssetPriceTickUnsubscribeMessage"] | components["schemas"]["WsAlertAssetPriceWindowUpdateUnsubscribeMessage"];
|
|
3164
3164
|
/** @description Typed pushed-event envelope for the alerts WebSocket. The `data` payload depends on `event` and matches the corresponding HTTP webhook payload schema. */
|
|
3165
|
-
WsAlertEventPayload: components["schemas"]["WsAlertTraderFirstTradeEvent"] | components["schemas"]["WsAlertTraderNewMarketEvent"] | components["schemas"]["WsAlertTraderWhaleTradeEvent"] | components["schemas"]["WsAlertTraderNewTradeEvent"] | components["schemas"]["
|
|
3165
|
+
WsAlertEventPayload: components["schemas"]["WsAlertTraderFirstTradeEvent"] | components["schemas"]["WsAlertTraderNewMarketEvent"] | components["schemas"]["WsAlertTraderWhaleTradeEvent"] | components["schemas"]["WsAlertTraderNewTradeEvent"] | components["schemas"]["WsAlertTraderTradeEventEvent"] | components["schemas"]["WsAlertTraderGlobalPnlEvent"] | components["schemas"]["WsAlertTraderMarketPnlEvent"] | components["schemas"]["WsAlertTraderEventPnlEvent"] | components["schemas"]["WsAlertConditionMetricsEvent"] | components["schemas"]["WsAlertEventMetricsEvent"] | 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"]["WsAlertMarketCreatedEvent"] | components["schemas"]["WsAlertAssetPriceTickEvent"] | components["schemas"]["WsAlertAssetPriceWindowUpdateEvent"];
|
|
3166
3166
|
};
|
|
3167
3167
|
responses: never;
|
|
3168
3168
|
parameters: never;
|
|
@@ -3177,7 +3177,7 @@ export interface WsAlertSubscribeMap {
|
|
|
3177
3177
|
trader_new_market: components["schemas"]["WsAlertTraderNewMarketSubscribeMessage"];
|
|
3178
3178
|
trader_whale_trade: components["schemas"]["WsAlertTraderWhaleTradeSubscribeMessage"];
|
|
3179
3179
|
trader_new_trade: components["schemas"]["WsAlertTraderNewTradeSubscribeMessage"];
|
|
3180
|
-
|
|
3180
|
+
trader_trade_event: components["schemas"]["WsAlertTraderTradeEventSubscribeMessage"];
|
|
3181
3181
|
trader_global_pnl: components["schemas"]["WsAlertTraderGlobalPnlSubscribeMessage"];
|
|
3182
3182
|
trader_market_pnl: components["schemas"]["WsAlertTraderMarketPnlSubscribeMessage"];
|
|
3183
3183
|
trader_event_pnl: components["schemas"]["WsAlertTraderEventPnlSubscribeMessage"];
|
|
@@ -3202,7 +3202,7 @@ export interface WsAlertEventDataMap {
|
|
|
3202
3202
|
trader_new_market: components["schemas"]["NewMarketPayload"];
|
|
3203
3203
|
trader_whale_trade: components["schemas"]["WhaleTradePayload"];
|
|
3204
3204
|
trader_new_trade: components["schemas"]["NewTradePayload"];
|
|
3205
|
-
|
|
3205
|
+
trader_trade_event: components["schemas"]["WebhookTraderTradeEventPayload"];
|
|
3206
3206
|
trader_global_pnl: components["schemas"]["GlobalPnlPayload"];
|
|
3207
3207
|
trader_market_pnl: components["schemas"]["MarketPnlPayload"];
|
|
3208
3208
|
trader_event_pnl: components["schemas"]["EventPnlPayload"];
|