@structbuild/sdk 0.5.6-staging.3 → 0.5.6
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/client.d.ts +1 -2
- package/dist/generated/polymarket.d.ts +2912 -5416
- package/dist/generated/webhooks.d.ts +1568 -939
- package/dist/generated/ws-alerts.d.ts +1620 -955
- package/dist/generated/ws.d.ts +1286 -278
- package/dist/index.cjs +1 -45
- package/dist/index.cjs.map +5 -6
- package/dist/index.js +1 -45
- package/dist/index.js.map +5 -6
- package/dist/namespaces/index.d.ts +0 -1
- package/dist/namespaces/trader.d.ts +1 -5
- package/dist/types/index.d.ts +9 -86
- package/dist/types/ws.d.ts +7 -2
- package/package.json +1 -1
- package/dist/namespaces/smartMoney.d.ts +0 -13
|
@@ -317,6 +317,26 @@ export interface webhooks {
|
|
|
317
317
|
patch?: never;
|
|
318
318
|
trace?: never;
|
|
319
319
|
};
|
|
320
|
+
"tag-metrics": {
|
|
321
|
+
parameters: {
|
|
322
|
+
query?: never;
|
|
323
|
+
header?: never;
|
|
324
|
+
path?: never;
|
|
325
|
+
cookie?: never;
|
|
326
|
+
};
|
|
327
|
+
get?: never;
|
|
328
|
+
put?: never;
|
|
329
|
+
/**
|
|
330
|
+
* Tag metrics callback
|
|
331
|
+
* @description Fired when a tag's volume or transaction metrics cross a configured threshold. Use `timeframes` to restrict to specific windows (valid values: `1m`, `5m`, `30m`, `1h`, `6h`, `24h`, `7d`, `30d`).
|
|
332
|
+
*/
|
|
333
|
+
post: operations["tag-metrics"];
|
|
334
|
+
delete?: never;
|
|
335
|
+
options?: never;
|
|
336
|
+
head?: never;
|
|
337
|
+
patch?: never;
|
|
338
|
+
trace?: never;
|
|
339
|
+
};
|
|
320
340
|
"position-metrics": {
|
|
321
341
|
parameters: {
|
|
322
342
|
query?: never;
|
|
@@ -684,122 +704,233 @@ export interface components {
|
|
|
684
704
|
slug?: string | null;
|
|
685
705
|
event_slug?: string | null;
|
|
686
706
|
};
|
|
687
|
-
/** @description
|
|
707
|
+
/** @description Subscription filters for the `asset_price_tick` event. All fields are optional. */
|
|
708
|
+
AssetPriceTickFilters: {
|
|
709
|
+
/** @description Restrict to these crypto assets. Empty = all assets. */
|
|
710
|
+
asset_symbols?: components["schemas"]["WebhookAssetSymbol"][] | null;
|
|
711
|
+
};
|
|
712
|
+
/** @description Webhook payload for an asset price tick. */
|
|
688
713
|
AssetPriceTickPayload: {
|
|
714
|
+
/** @description Asset symbol */
|
|
715
|
+
symbol: components["schemas"]["WebhookAssetSymbol"];
|
|
689
716
|
/**
|
|
690
|
-
*
|
|
691
|
-
* @
|
|
717
|
+
* Format: double
|
|
718
|
+
* @description Current price from the Chainlink feed
|
|
692
719
|
*/
|
|
693
|
-
symbol: "BTC" | "ETH" | "SOL" | "XRP" | "DOGE" | "BNB" | "HYPE";
|
|
694
|
-
/** @description Current asset price in USD from the Chainlink feed */
|
|
695
720
|
price: number;
|
|
696
721
|
/**
|
|
697
722
|
* Format: int64
|
|
698
|
-
* @description Tick timestamp (milliseconds since
|
|
723
|
+
* @description Tick timestamp as reported by the WebSocket feed (milliseconds since epoch)
|
|
699
724
|
*/
|
|
700
725
|
timestamp_ms: number;
|
|
701
726
|
};
|
|
702
|
-
/** @description
|
|
727
|
+
/** @description Subscription filters for the `asset_price_window_update` event. All fields are optional. */
|
|
728
|
+
AssetPriceWindowUpdateFilters: {
|
|
729
|
+
/** @description Restrict to these crypto assets. Empty = all assets. */
|
|
730
|
+
asset_symbols?: components["schemas"]["WebhookAssetSymbol"][] | null;
|
|
731
|
+
/** @description Restrict to these candle sizes. Empty = all sizes. */
|
|
732
|
+
timeframes?: components["schemas"]["AssetWindowFilterTimeframe"][] | null;
|
|
733
|
+
};
|
|
734
|
+
/** @description Webhook payload for an asset price window open or close. */
|
|
703
735
|
AssetPriceWindowUpdatePayload: {
|
|
704
|
-
/**
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
symbol: "BTC" | "ETH" | "SOL" | "XRP" | "DOGE" | "BNB" | "HYPE";
|
|
709
|
-
/**
|
|
710
|
-
* @description Candle / window size
|
|
711
|
-
* @enum {string}
|
|
712
|
-
*/
|
|
713
|
-
variant: "5m" | "15m" | "1h" | "4h" | "1d" | "24h";
|
|
736
|
+
/** @description Asset symbol */
|
|
737
|
+
symbol: components["schemas"]["WebhookAssetSymbol"];
|
|
738
|
+
/** @description Time-window variant */
|
|
739
|
+
variant: components["schemas"]["AssetPriceWindowVariant"];
|
|
714
740
|
/**
|
|
715
741
|
* Format: int64
|
|
716
|
-
* @description Window start timestamp (milliseconds since
|
|
742
|
+
* @description Window start timestamp (milliseconds since epoch)
|
|
717
743
|
*/
|
|
718
744
|
start_time: number;
|
|
719
745
|
/**
|
|
720
746
|
* Format: int64
|
|
721
|
-
* @description Window end timestamp (milliseconds since
|
|
747
|
+
* @description Window end timestamp (milliseconds since epoch)
|
|
722
748
|
*/
|
|
723
749
|
end_time: number;
|
|
724
|
-
/**
|
|
750
|
+
/**
|
|
751
|
+
* Format: double
|
|
752
|
+
* @description Opening price at start_time
|
|
753
|
+
*/
|
|
725
754
|
open_price: number;
|
|
726
|
-
/**
|
|
755
|
+
/**
|
|
756
|
+
* Format: double
|
|
757
|
+
* @description Closing price at end_time (0.0 on an "open" update — not yet available)
|
|
758
|
+
*/
|
|
727
759
|
close_price: number;
|
|
760
|
+
/** @description "open" when the window starts, "close" when the window is complete */
|
|
761
|
+
update_type: components["schemas"]["AssetPriceWindowUpdateType"];
|
|
762
|
+
};
|
|
763
|
+
/**
|
|
764
|
+
* @description Whether this update is the open or the close of a candle.
|
|
765
|
+
* @enum {string}
|
|
766
|
+
*/
|
|
767
|
+
AssetPriceWindowUpdateType: "open" | "close";
|
|
768
|
+
/**
|
|
769
|
+
* @description Time-window variant emitted by the asset price window stream.
|
|
770
|
+
* @enum {string}
|
|
771
|
+
*/
|
|
772
|
+
AssetPriceWindowVariant: "5m" | "15m" | "1h" | "4h" | "1d" | "24h";
|
|
773
|
+
/**
|
|
774
|
+
* @description Candle sizes accepted by `asset_price_window_update.timeframes`.
|
|
775
|
+
* @enum {string}
|
|
776
|
+
*/
|
|
777
|
+
AssetWindowFilterTimeframe: "5m" | "15m" | "1h" | "4h" | "1d" | "24h";
|
|
778
|
+
/**
|
|
779
|
+
* @description Subscription filters for the `close_to_bond` event. At least one of
|
|
780
|
+
* `min_probability` or `max_probability` is required (enforced at runtime).
|
|
781
|
+
*/
|
|
782
|
+
CloseToBondFilters: {
|
|
728
783
|
/**
|
|
729
|
-
*
|
|
730
|
-
* @
|
|
784
|
+
* Format: double
|
|
785
|
+
* @description Trigger when the YES outcome price is ≥ this value (e.g. 0.95 for 95% certainty). At least one of `min_probability` or `max_probability` must be set.
|
|
786
|
+
*/
|
|
787
|
+
min_probability?: number | null;
|
|
788
|
+
/**
|
|
789
|
+
* Format: double
|
|
790
|
+
* @description Trigger when the YES outcome price is ≤ this value (e.g. 0.05 for near-certain NO).
|
|
731
791
|
*/
|
|
732
|
-
|
|
792
|
+
max_probability?: number | null;
|
|
793
|
+
/** @description Restrict to these markets. */
|
|
794
|
+
condition_ids?: string[] | null;
|
|
795
|
+
/** @description Restrict to these outcome token IDs. */
|
|
796
|
+
position_ids?: string[] | null;
|
|
797
|
+
/** @description Restrict to markets in these events. */
|
|
798
|
+
event_slugs?: string[] | null;
|
|
799
|
+
/** @description Restrict to these outcome names (e.g. \["Yes", "No"\]). */
|
|
800
|
+
outcomes?: string[] | null;
|
|
801
|
+
/** @description Restrict by outcome index. 0 = Yes/Up, 1 = No. Position 0 usually represents the Up/Yes side in binary markets. */
|
|
802
|
+
position_outcome_indices?: number[] | null;
|
|
803
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
804
|
+
exclude_shortterm_markets?: boolean | null;
|
|
733
805
|
};
|
|
734
|
-
/** @description
|
|
806
|
+
/** @description Close-to-bond webhook payload */
|
|
735
807
|
CloseToBondPayload: {
|
|
736
|
-
/** @description
|
|
808
|
+
/** @description Trader address (the limit-order maker) */
|
|
737
809
|
trader: string;
|
|
738
|
-
/** @description
|
|
810
|
+
/** @description Taker address (the order filler — often the exchange contract) */
|
|
739
811
|
taker: string;
|
|
740
|
-
/** @description
|
|
812
|
+
/** @description Position ID (ERC1155 token ID) */
|
|
741
813
|
position_id: string;
|
|
742
|
-
/** @description
|
|
814
|
+
/** @description Condition ID (parent market) */
|
|
743
815
|
condition_id?: string | null;
|
|
744
816
|
/** @description Outcome name (e.g. "Yes", "No") */
|
|
745
817
|
outcome?: string | null;
|
|
746
|
-
/**
|
|
818
|
+
/**
|
|
819
|
+
* Format: int32
|
|
820
|
+
* @description Outcome index (0 = Yes/Up, 1 = No). Position 0 usually represents Yes/Up.
|
|
821
|
+
*/
|
|
747
822
|
outcome_index?: number | null;
|
|
823
|
+
/** @description Market question */
|
|
748
824
|
question?: string | null;
|
|
825
|
+
/** @description Market slug */
|
|
749
826
|
market_slug?: string | null;
|
|
827
|
+
/** @description Event slug */
|
|
750
828
|
event_slug?: string | null;
|
|
829
|
+
/** @description Trade ID */
|
|
751
830
|
trade_id: string;
|
|
752
831
|
/** @description Transaction hash */
|
|
753
832
|
hash: string;
|
|
754
|
-
/**
|
|
833
|
+
/**
|
|
834
|
+
* Format: int64
|
|
835
|
+
* @description Block number
|
|
836
|
+
*/
|
|
755
837
|
block: number;
|
|
756
838
|
/**
|
|
757
839
|
* Format: int64
|
|
758
|
-
* @description Unix seconds
|
|
840
|
+
* @description Confirmed timestamp (Unix seconds)
|
|
759
841
|
*/
|
|
760
842
|
confirmed_at: number;
|
|
761
|
-
/**
|
|
843
|
+
/**
|
|
844
|
+
* Format: double
|
|
845
|
+
* @description USD size of the trade
|
|
846
|
+
*/
|
|
762
847
|
amount_usd: number;
|
|
848
|
+
/**
|
|
849
|
+
* Format: double
|
|
850
|
+
* @description Outcome shares traded
|
|
851
|
+
*/
|
|
763
852
|
shares_amount: number;
|
|
764
|
-
/**
|
|
853
|
+
/**
|
|
854
|
+
* Format: double
|
|
855
|
+
* @description Fee paid (USD)
|
|
856
|
+
*/
|
|
765
857
|
fee: number;
|
|
766
|
-
/** @
|
|
767
|
-
side:
|
|
768
|
-
/**
|
|
858
|
+
/** @description Trade side ("Buy" or "Sell") */
|
|
859
|
+
side: string;
|
|
860
|
+
/**
|
|
861
|
+
* Format: double
|
|
862
|
+
* @description Price per share (0.0–1.0) — the value that triggered the notification
|
|
863
|
+
*/
|
|
769
864
|
price: number;
|
|
770
|
-
/**
|
|
865
|
+
/**
|
|
866
|
+
* Format: double
|
|
867
|
+
* @description Implied probability of the outcome (0.0–1.0)
|
|
868
|
+
*/
|
|
771
869
|
probability?: number | null;
|
|
870
|
+
/** @description Which bond zone was entered: `"high"` (YES near-certain) or `"low"` (NO near-certain) */
|
|
871
|
+
bond_side: string;
|
|
772
872
|
/**
|
|
773
|
-
*
|
|
774
|
-
* @
|
|
873
|
+
* Format: double
|
|
874
|
+
* @description The probability threshold from the subscriber's filter that was breached
|
|
775
875
|
*/
|
|
776
|
-
bond_side: "high" | "low";
|
|
777
|
-
/** @description The probability threshold from the subscription filter that was breached */
|
|
778
876
|
threshold: number;
|
|
779
877
|
};
|
|
780
878
|
/** @description Payload delivered when a market's volume or transaction metrics cross a configured threshold */
|
|
781
879
|
ConditionMetricsPayload: {
|
|
782
880
|
/** @description Market condition ID */
|
|
783
881
|
condition_id?: string | null;
|
|
882
|
+
/** @description Aggregation window */
|
|
883
|
+
timeframe?: null | ("1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "6h" | "1d" | "24h" | "7d" | "30d");
|
|
784
884
|
/**
|
|
785
|
-
*
|
|
786
|
-
* @
|
|
885
|
+
* Format: double
|
|
886
|
+
* @description Total trading volume in USD for this timeframe
|
|
787
887
|
*/
|
|
788
|
-
timeframe?: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d" | null;
|
|
789
|
-
/** @description Total trading volume in USD for this timeframe */
|
|
790
888
|
volume_usd?: number | null;
|
|
791
|
-
/**
|
|
889
|
+
/**
|
|
890
|
+
* Format: double
|
|
891
|
+
* @description Total shares/contracts volume for this timeframe
|
|
892
|
+
*/
|
|
893
|
+
shares_volume?: number | null;
|
|
894
|
+
/**
|
|
895
|
+
* Format: double
|
|
896
|
+
* @description Builder-attributed trading volume in USD
|
|
897
|
+
*/
|
|
898
|
+
builder_usd_volume?: number | null;
|
|
899
|
+
/**
|
|
900
|
+
* Format: double
|
|
901
|
+
* @description Builder-attributed shares/contracts volume
|
|
902
|
+
*/
|
|
903
|
+
builder_shares_volume?: number | null;
|
|
904
|
+
/**
|
|
905
|
+
* Format: double
|
|
906
|
+
* @description Total fees collected in USD
|
|
907
|
+
*/
|
|
792
908
|
fees?: number | null;
|
|
909
|
+
/**
|
|
910
|
+
* Format: double
|
|
911
|
+
* @description Builder-attributed fees in USD
|
|
912
|
+
*/
|
|
913
|
+
builder_fees?: number | null;
|
|
793
914
|
/**
|
|
794
915
|
* Format: int64
|
|
795
916
|
* @description Total number of transactions
|
|
796
917
|
*/
|
|
797
918
|
txns?: number | null;
|
|
919
|
+
/**
|
|
920
|
+
* Format: int64
|
|
921
|
+
* @description Builder-attributed transaction count
|
|
922
|
+
*/
|
|
923
|
+
builder_txns?: number | null;
|
|
798
924
|
/**
|
|
799
925
|
* Format: int64
|
|
800
926
|
* @description Number of unique traders
|
|
801
927
|
*/
|
|
802
928
|
unique_traders?: number | null;
|
|
929
|
+
/**
|
|
930
|
+
* Format: int64
|
|
931
|
+
* @description Number of unique builder-attributed traders
|
|
932
|
+
*/
|
|
933
|
+
unique_builder_traders?: number | null;
|
|
803
934
|
};
|
|
804
935
|
/** @description CTF ConditionResolution: positions become redeemable on the Conditional Tokens contract. */
|
|
805
936
|
ConditionResolutionEvent: {
|
|
@@ -870,45 +1001,92 @@ export interface components {
|
|
|
870
1001
|
slug?: string | null;
|
|
871
1002
|
event_slug?: string | null;
|
|
872
1003
|
};
|
|
1004
|
+
/** @description Subscription filters for the `event_metrics` event. All fields are optional. */
|
|
1005
|
+
EventMetricsFilters: {
|
|
1006
|
+
/** @description Restrict to these events. Empty = all events. */
|
|
1007
|
+
event_slugs?: string[] | null;
|
|
1008
|
+
/** @description Restrict to these aggregation windows. */
|
|
1009
|
+
timeframes?: components["schemas"]["MetricFilterTimeframe"][] | null;
|
|
1010
|
+
/**
|
|
1011
|
+
* Format: double
|
|
1012
|
+
* @description Only fire when aggregated event volume ≥ this value (USD).
|
|
1013
|
+
*/
|
|
1014
|
+
min_volume_usd?: number | null;
|
|
1015
|
+
/** Format: double */
|
|
1016
|
+
max_volume_usd?: number | null;
|
|
1017
|
+
/** Format: int64 */
|
|
1018
|
+
min_txns?: number | null;
|
|
1019
|
+
/** Format: int64 */
|
|
1020
|
+
min_unique_traders?: number | null;
|
|
1021
|
+
/** Format: double */
|
|
1022
|
+
min_fees?: number | null;
|
|
1023
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
1024
|
+
exclude_shortterm_markets?: boolean | null;
|
|
1025
|
+
};
|
|
873
1026
|
/** @description Payload delivered when an event's aggregated volume or transaction metrics cross a configured threshold */
|
|
874
1027
|
EventMetricsPayload: {
|
|
875
1028
|
/** @description Event slug */
|
|
876
1029
|
event_slug?: string | null;
|
|
1030
|
+
/** @description Aggregation window */
|
|
1031
|
+
timeframe?: null | ("1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "6h" | "1d" | "24h" | "7d" | "30d");
|
|
877
1032
|
/**
|
|
878
|
-
*
|
|
879
|
-
* @
|
|
1033
|
+
* Format: double
|
|
1034
|
+
* @description Total aggregated volume across all markets in the event (USD)
|
|
880
1035
|
*/
|
|
881
|
-
timeframe?: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d" | null;
|
|
882
|
-
/** @description Total aggregated volume across all markets in the event (USD) */
|
|
883
1036
|
volume_usd?: number | null;
|
|
884
|
-
/**
|
|
1037
|
+
/**
|
|
1038
|
+
* Format: double
|
|
1039
|
+
* @description Total aggregated shares/contracts volume across all markets in the event
|
|
1040
|
+
*/
|
|
1041
|
+
shares_volume?: number | null;
|
|
1042
|
+
/**
|
|
1043
|
+
* Format: double
|
|
1044
|
+
* @description Builder-attributed aggregated volume in USD
|
|
1045
|
+
*/
|
|
1046
|
+
builder_usd_volume?: number | null;
|
|
1047
|
+
/**
|
|
1048
|
+
* Format: double
|
|
1049
|
+
* @description Builder-attributed aggregated shares/contracts volume
|
|
1050
|
+
*/
|
|
1051
|
+
builder_shares_volume?: number | null;
|
|
1052
|
+
/**
|
|
1053
|
+
* Format: double
|
|
1054
|
+
* @description Total fees collected in USD
|
|
1055
|
+
*/
|
|
885
1056
|
fees?: number | null;
|
|
1057
|
+
/**
|
|
1058
|
+
* Format: double
|
|
1059
|
+
* @description Builder-attributed fees in USD
|
|
1060
|
+
*/
|
|
1061
|
+
builder_fees?: number | null;
|
|
886
1062
|
/**
|
|
887
1063
|
* Format: int64
|
|
888
1064
|
* @description Total number of transactions
|
|
889
1065
|
*/
|
|
890
1066
|
txns?: number | null;
|
|
1067
|
+
/**
|
|
1068
|
+
* Format: int64
|
|
1069
|
+
* @description Builder-attributed transaction count
|
|
1070
|
+
*/
|
|
1071
|
+
builder_txns?: number | null;
|
|
891
1072
|
/**
|
|
892
1073
|
* Format: int64
|
|
893
1074
|
* @description Number of unique traders
|
|
894
1075
|
*/
|
|
895
1076
|
unique_traders?: number | null;
|
|
1077
|
+
/**
|
|
1078
|
+
* Format: int64
|
|
1079
|
+
* @description Number of unique builder-attributed traders
|
|
1080
|
+
*/
|
|
1081
|
+
unique_builder_traders?: number | null;
|
|
896
1082
|
};
|
|
897
|
-
/** @description
|
|
1083
|
+
/** @description Event PnL webhook payload. */
|
|
898
1084
|
EventPnlPayload: {
|
|
899
|
-
/** @description Trader wallet address (lowercase) */
|
|
900
1085
|
trader?: string | null;
|
|
901
|
-
/** @description Event slug */
|
|
902
1086
|
event_slug?: string | null;
|
|
903
|
-
/**
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
*/
|
|
907
|
-
timeframe: "1d" | "7d" | "30d" | "lifetime";
|
|
908
|
-
/**
|
|
909
|
-
* Format: int64
|
|
910
|
-
* @description Number of distinct markets traded in this event
|
|
911
|
-
*/
|
|
1087
|
+
/** @description Aggregation timeframe: "1d", "7d", "30d", or "lifetime" */
|
|
1088
|
+
timeframe: string;
|
|
1089
|
+
/** Format: int64 */
|
|
912
1090
|
markets_traded?: number | null;
|
|
913
1091
|
/** Format: int64 */
|
|
914
1092
|
outcomes_traded?: number | null;
|
|
@@ -920,44 +1098,58 @@ export interface components {
|
|
|
920
1098
|
total_redemptions?: number | null;
|
|
921
1099
|
/** Format: int64 */
|
|
922
1100
|
total_merges?: number | null;
|
|
923
|
-
/**
|
|
1101
|
+
/** Format: double */
|
|
924
1102
|
total_volume_usd?: number | null;
|
|
1103
|
+
/** Format: double */
|
|
925
1104
|
buy_usd?: number | null;
|
|
1105
|
+
/** Format: double */
|
|
926
1106
|
sell_usd?: number | null;
|
|
1107
|
+
/** Format: double */
|
|
927
1108
|
redemption_usd?: number | null;
|
|
1109
|
+
/** Format: double */
|
|
928
1110
|
merge_usd?: number | null;
|
|
929
|
-
/**
|
|
1111
|
+
/** Format: double */
|
|
930
1112
|
realized_pnl_usd?: number | null;
|
|
931
1113
|
/** Format: int64 */
|
|
932
1114
|
winning_markets?: number | null;
|
|
933
1115
|
/** Format: int64 */
|
|
934
1116
|
losing_markets?: number | null;
|
|
1117
|
+
/** Format: double */
|
|
935
1118
|
total_fees?: number | null;
|
|
936
|
-
/**
|
|
937
|
-
* Format: int64
|
|
938
|
-
* @description Unix seconds
|
|
939
|
-
*/
|
|
1119
|
+
/** Format: int64 */
|
|
940
1120
|
first_trade_at?: number | null;
|
|
941
|
-
/**
|
|
942
|
-
* Format: int64
|
|
943
|
-
* @description Unix seconds
|
|
944
|
-
*/
|
|
1121
|
+
/** Format: int64 */
|
|
945
1122
|
last_trade_at?: number | null;
|
|
946
1123
|
};
|
|
947
|
-
/** @description
|
|
1124
|
+
/** @description Subscription filters for the `event_volume_milestone` event. */
|
|
1125
|
+
EventVolumeMilestoneFilters: {
|
|
1126
|
+
/** @description **Required.** Aggregation windows to monitor. */
|
|
1127
|
+
timeframes: components["schemas"]["MetricFilterTimeframe"][];
|
|
1128
|
+
/** @description Restrict to these events. */
|
|
1129
|
+
event_slugs?: string[] | null;
|
|
1130
|
+
/** @description Specific USD milestones to trigger on. */
|
|
1131
|
+
milestone_amounts?: number[] | null;
|
|
1132
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
1133
|
+
exclude_shortterm_markets?: boolean | null;
|
|
1134
|
+
};
|
|
1135
|
+
/** @description Event volume milestone webhook payload */
|
|
948
1136
|
EventVolumeMilestonePayload: {
|
|
949
|
-
/** @description Event slug */
|
|
950
1137
|
event_slug: string;
|
|
1138
|
+
timeframe: string;
|
|
951
1139
|
/**
|
|
952
|
-
*
|
|
953
|
-
* @
|
|
1140
|
+
* Format: double
|
|
1141
|
+
* @description Milestone amount reached (USD)
|
|
954
1142
|
*/
|
|
955
|
-
timeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d";
|
|
956
|
-
/** @description The USD milestone amount that was crossed */
|
|
957
1143
|
milestone_usd: number;
|
|
958
|
-
/**
|
|
1144
|
+
/**
|
|
1145
|
+
* Format: double
|
|
1146
|
+
* @description Current volume (USD) that triggered the milestone
|
|
1147
|
+
*/
|
|
959
1148
|
current_volume_usd: number;
|
|
960
|
-
/**
|
|
1149
|
+
/**
|
|
1150
|
+
* Format: double
|
|
1151
|
+
* @description Total fees collected in this timeframe
|
|
1152
|
+
*/
|
|
961
1153
|
fees: number;
|
|
962
1154
|
/**
|
|
963
1155
|
* Format: int64
|
|
@@ -965,25 +1157,60 @@ export interface components {
|
|
|
965
1157
|
*/
|
|
966
1158
|
txns: number;
|
|
967
1159
|
};
|
|
968
|
-
/** @description
|
|
1160
|
+
/** @description Subscription filters for the `event_volume_spike` event. `spike_ratio` is required. */
|
|
1161
|
+
EventVolumeSpikeFilters: {
|
|
1162
|
+
/**
|
|
1163
|
+
* Format: double
|
|
1164
|
+
* @description **Required.** Multiplier threshold (must be > 1.0). Fires when current volume >= snapshot × ratio.
|
|
1165
|
+
*/
|
|
1166
|
+
spike_ratio: number;
|
|
1167
|
+
/**
|
|
1168
|
+
* Format: int64
|
|
1169
|
+
* @description Force snapshot reset after this many seconds (max 600 / 10 minutes).
|
|
1170
|
+
*/
|
|
1171
|
+
window_secs?: number | null;
|
|
1172
|
+
/** @description Restrict to these events. */
|
|
1173
|
+
event_slugs?: string[] | null;
|
|
1174
|
+
/** @description Restrict to these aggregation windows. */
|
|
1175
|
+
timeframes?: components["schemas"]["VolumeSpikeFilterTimeframe"][] | null;
|
|
1176
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
1177
|
+
exclude_shortterm_markets?: boolean | null;
|
|
1178
|
+
};
|
|
1179
|
+
/** @description Event volume spike webhook payload */
|
|
969
1180
|
EventVolumeSpikePayload: {
|
|
970
|
-
/** @description Event slug */
|
|
971
1181
|
event_slug: string;
|
|
1182
|
+
event_title?: string | null;
|
|
1183
|
+
image_url?: string | null;
|
|
1184
|
+
timeframe: string;
|
|
972
1185
|
/**
|
|
973
|
-
*
|
|
974
|
-
* @
|
|
1186
|
+
* Format: double
|
|
1187
|
+
* @description Current aggregated event volume at the time of the spike (USD)
|
|
975
1188
|
*/
|
|
976
|
-
timeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "1d" | "24h" | "7d" | "30d";
|
|
977
|
-
/** @description Current aggregated event volume at time of the spike (USD) */
|
|
978
1189
|
current_volume_usd: number;
|
|
979
|
-
/**
|
|
1190
|
+
/**
|
|
1191
|
+
* Format: double
|
|
1192
|
+
* @description Volume at the snapshot baseline (USD)
|
|
1193
|
+
*/
|
|
980
1194
|
snapshot_volume_usd: number;
|
|
981
|
-
/**
|
|
1195
|
+
/**
|
|
1196
|
+
* Format: double
|
|
1197
|
+
* @description New volume since the snapshot that triggered this notification (USD)
|
|
1198
|
+
*/
|
|
982
1199
|
delta_volume_usd: number;
|
|
983
|
-
/**
|
|
1200
|
+
/**
|
|
1201
|
+
* Format: double
|
|
1202
|
+
* @description Volume growth as a percentage of the snapshot (e.g. 200.0 means volume tripled)
|
|
1203
|
+
*/
|
|
984
1204
|
spike_pct: number;
|
|
985
|
-
/**
|
|
1205
|
+
/**
|
|
1206
|
+
* Format: int64
|
|
1207
|
+
* @description Total transactions in this timeframe
|
|
1208
|
+
*/
|
|
986
1209
|
txns: number;
|
|
1210
|
+
/**
|
|
1211
|
+
* Format: double
|
|
1212
|
+
* @description Total fees in this timeframe
|
|
1213
|
+
*/
|
|
987
1214
|
fees: number;
|
|
988
1215
|
};
|
|
989
1216
|
/** @description Payload delivered when a tracked trader executes their first-ever trade on Polymarket */
|
|
@@ -998,7 +1225,10 @@ export interface components {
|
|
|
998
1225
|
condition_id?: string | null;
|
|
999
1226
|
/** @description Outcome name (e.g. "Yes", "No") */
|
|
1000
1227
|
outcome?: string | null;
|
|
1001
|
-
/**
|
|
1228
|
+
/**
|
|
1229
|
+
* Format: int32
|
|
1230
|
+
* @description Outcome index: 0 = Yes/Up, 1 = No
|
|
1231
|
+
*/
|
|
1002
1232
|
outcome_index?: number | null;
|
|
1003
1233
|
/** @description Market question text */
|
|
1004
1234
|
question?: string | null;
|
|
@@ -1006,6 +1236,8 @@ export interface components {
|
|
|
1006
1236
|
market_slug?: string | null;
|
|
1007
1237
|
/** @description Parent event slug */
|
|
1008
1238
|
event_slug?: string | null;
|
|
1239
|
+
/** @description Market image URL */
|
|
1240
|
+
image_url?: string | null;
|
|
1009
1241
|
/** @description Unique trade identifier */
|
|
1010
1242
|
trade_id: string;
|
|
1011
1243
|
/** @description Transaction hash */
|
|
@@ -1020,148 +1252,128 @@ export interface components {
|
|
|
1020
1252
|
* @description Block confirmation timestamp (Unix seconds)
|
|
1021
1253
|
*/
|
|
1022
1254
|
confirmed_at: number;
|
|
1023
|
-
/**
|
|
1255
|
+
/**
|
|
1256
|
+
* Format: double
|
|
1257
|
+
* @description USD size of the trade (6 decimal places)
|
|
1258
|
+
*/
|
|
1024
1259
|
amount_usd: number;
|
|
1025
|
-
/** @description Outcome shares traded (6 decimal places) */
|
|
1026
|
-
shares_amount: number;
|
|
1027
|
-
/** @description Fee paid in USD (6 decimal places) */
|
|
1028
|
-
fee: number;
|
|
1029
1260
|
/**
|
|
1030
|
-
*
|
|
1031
|
-
* @
|
|
1261
|
+
* Format: double
|
|
1262
|
+
* @description Outcome shares traded (6 decimal places)
|
|
1032
1263
|
*/
|
|
1033
|
-
|
|
1034
|
-
/** @description Outcome token price (0.0–1.0) */
|
|
1035
|
-
price: number;
|
|
1264
|
+
shares_amount: number;
|
|
1036
1265
|
/**
|
|
1037
|
-
*
|
|
1038
|
-
* @
|
|
1266
|
+
* Format: double
|
|
1267
|
+
* @description Fee paid in USD (6 decimal places)
|
|
1039
1268
|
*/
|
|
1040
|
-
|
|
1269
|
+
fee: number;
|
|
1270
|
+
/** @description Trade direction */
|
|
1271
|
+
side: "Buy" | "Sell";
|
|
1041
1272
|
/**
|
|
1042
|
-
*
|
|
1043
|
-
* @
|
|
1273
|
+
* Format: double
|
|
1274
|
+
* @description Outcome token price (0.0–1.0)
|
|
1044
1275
|
*/
|
|
1276
|
+
price: number;
|
|
1277
|
+
/** @description Exchange contract that processed the trade */
|
|
1278
|
+
exchange: "CTFExchange" | "NegRiskExchange" | "ConditionalTokens" | "NegRiskAdapter" | "CTFExchangeV2" | "NegRiskExchangeV2" | "Unknown";
|
|
1279
|
+
/** @description Trade type (webhook events only fire on order fills) */
|
|
1045
1280
|
trade_type: "OrderFilled" | "OrdersMatched";
|
|
1046
1281
|
};
|
|
1047
|
-
/** @description
|
|
1282
|
+
/** @description Global PnL webhook payload. */
|
|
1048
1283
|
GlobalPnlPayload: {
|
|
1049
|
-
/** @description Trader wallet address (lowercase) */
|
|
1050
1284
|
trader?: string | null;
|
|
1051
|
-
/**
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
*/
|
|
1055
|
-
timeframe: "1d" | "7d" | "30d" | "lifetime";
|
|
1056
|
-
/** @description Realized PnL in USD (positive = profit, negative = loss) */
|
|
1285
|
+
/** @description Aggregation timeframe: "1d", "7d", "30d", or "lifetime" */
|
|
1286
|
+
timeframe: string;
|
|
1287
|
+
/** Format: double */
|
|
1057
1288
|
realized_pnl_usd?: number | null;
|
|
1058
|
-
/**
|
|
1059
|
-
* Format: int64
|
|
1060
|
-
* @description Number of distinct events traded
|
|
1061
|
-
*/
|
|
1289
|
+
/** Format: int64 */
|
|
1062
1290
|
events_traded?: number | null;
|
|
1063
|
-
/**
|
|
1064
|
-
* Format: int64
|
|
1065
|
-
* @description Number of distinct markets traded
|
|
1066
|
-
*/
|
|
1291
|
+
/** Format: int64 */
|
|
1067
1292
|
markets_traded?: number | null;
|
|
1068
|
-
/**
|
|
1069
|
-
* Format: int64
|
|
1070
|
-
* @description Total buy transactions
|
|
1071
|
-
*/
|
|
1293
|
+
/** Format: int64 */
|
|
1072
1294
|
total_buys?: number | null;
|
|
1073
|
-
/**
|
|
1074
|
-
* Format: int64
|
|
1075
|
-
* @description Total sell transactions
|
|
1076
|
-
*/
|
|
1295
|
+
/** Format: int64 */
|
|
1077
1296
|
total_sells?: number | null;
|
|
1078
|
-
/**
|
|
1079
|
-
* Format: int64
|
|
1080
|
-
* @description Total redemption transactions
|
|
1081
|
-
*/
|
|
1297
|
+
/** Format: int64 */
|
|
1082
1298
|
total_redemptions?: number | null;
|
|
1083
|
-
/**
|
|
1084
|
-
* Format: int64
|
|
1085
|
-
* @description Total merge transactions
|
|
1086
|
-
*/
|
|
1299
|
+
/** Format: int64 */
|
|
1087
1300
|
total_merges?: number | null;
|
|
1088
|
-
/**
|
|
1301
|
+
/** Format: double */
|
|
1089
1302
|
total_volume_usd?: number | null;
|
|
1090
|
-
/**
|
|
1303
|
+
/** Format: double */
|
|
1091
1304
|
buy_volume_usd?: number | null;
|
|
1092
|
-
/**
|
|
1305
|
+
/** Format: double */
|
|
1093
1306
|
sell_volume_usd?: number | null;
|
|
1094
|
-
/**
|
|
1307
|
+
/** Format: double */
|
|
1095
1308
|
redemption_volume_usd?: number | null;
|
|
1096
|
-
/**
|
|
1309
|
+
/** Format: double */
|
|
1097
1310
|
merge_volume_usd?: number | null;
|
|
1098
|
-
/**
|
|
1099
|
-
* Format: int64
|
|
1100
|
-
* @description Number of markets where trader realised a profit
|
|
1101
|
-
*/
|
|
1311
|
+
/** Format: int64 */
|
|
1102
1312
|
markets_won?: number | null;
|
|
1103
|
-
/**
|
|
1104
|
-
* Format: int64
|
|
1105
|
-
* @description Number of markets where trader realised a loss
|
|
1106
|
-
*/
|
|
1313
|
+
/** Format: int64 */
|
|
1107
1314
|
markets_lost?: number | null;
|
|
1108
|
-
/**
|
|
1315
|
+
/** Format: double */
|
|
1109
1316
|
market_win_rate_pct?: number | null;
|
|
1110
|
-
/**
|
|
1317
|
+
/** Format: double */
|
|
1111
1318
|
avg_pnl_per_market?: number | null;
|
|
1112
|
-
/**
|
|
1319
|
+
/** Format: double */
|
|
1113
1320
|
avg_pnl_per_trade?: number | null;
|
|
1114
|
-
/**
|
|
1321
|
+
/** Format: double */
|
|
1115
1322
|
avg_hold_time_seconds?: number | null;
|
|
1116
|
-
/**
|
|
1323
|
+
/** Format: double */
|
|
1117
1324
|
total_fees?: number | null;
|
|
1118
|
-
/**
|
|
1325
|
+
/** Format: double */
|
|
1119
1326
|
best_trade_pnl_usd?: number | null;
|
|
1120
|
-
/** @description Condition ID of the best trade */
|
|
1121
1327
|
best_trade_condition_id?: string | null;
|
|
1122
|
-
/**
|
|
1123
|
-
* Format: int64
|
|
1124
|
-
* @description Timestamp of the first trade (Unix seconds)
|
|
1125
|
-
*/
|
|
1328
|
+
/** Format: int64 */
|
|
1126
1329
|
first_trade_at?: number | null;
|
|
1127
|
-
/**
|
|
1128
|
-
* Format: int64
|
|
1129
|
-
* @description Timestamp of the most recent trade (Unix seconds)
|
|
1130
|
-
*/
|
|
1330
|
+
/** Format: int64 */
|
|
1131
1331
|
last_trade_at?: number | null;
|
|
1132
1332
|
};
|
|
1133
1333
|
/** @description Response for GET /v1/webhook/events */
|
|
1134
1334
|
ListEventsResponse: {
|
|
1135
1335
|
events: components["schemas"]["WebhookEventInfo"][];
|
|
1136
1336
|
};
|
|
1137
|
-
/** @description
|
|
1337
|
+
/** @description Subscription filters for the `market_created` event. All fields are optional. */
|
|
1338
|
+
MarketCreatedFilters: {
|
|
1339
|
+
/** @description Restrict to markets with these tags or category names (case-insensitive match). */
|
|
1340
|
+
tags?: string[] | null;
|
|
1341
|
+
/** @description Restrict to markets belonging to these events. */
|
|
1342
|
+
event_slugs?: string[] | null;
|
|
1343
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets (event slugs containing `updown`). Default: `false`. */
|
|
1344
|
+
exclude_shortterm_markets?: boolean | null;
|
|
1345
|
+
};
|
|
1346
|
+
/** @description Outcome entry in the market created payload — mirrors `NewMarketOutcome` */
|
|
1138
1347
|
MarketCreatedOutcome: {
|
|
1139
|
-
/**
|
|
1348
|
+
/**
|
|
1349
|
+
* Format: int32
|
|
1350
|
+
* @description Outcome index (0 = Yes, 1 = No)
|
|
1351
|
+
*/
|
|
1140
1352
|
index: number;
|
|
1141
1353
|
/** @description Outcome name (e.g. "Yes", "No") */
|
|
1142
1354
|
name: string;
|
|
1143
|
-
/** @description
|
|
1355
|
+
/** @description ERC1155 position token ID */
|
|
1144
1356
|
position_id: string;
|
|
1145
1357
|
};
|
|
1146
|
-
/** @description
|
|
1358
|
+
/** @description Market created webhook payload — mirrors `NewMarketPayload` field-for-field */
|
|
1147
1359
|
MarketCreatedPayload: {
|
|
1148
1360
|
/** @description Condition ID (0x-prefixed hex, lowercase) */
|
|
1149
1361
|
condition_id: string;
|
|
1150
1362
|
/** @description Market slug */
|
|
1151
1363
|
market_slug: string;
|
|
1152
|
-
/** @description
|
|
1364
|
+
/** @description Event slug (parent event) */
|
|
1153
1365
|
event_slug?: string | null;
|
|
1154
|
-
/** @description
|
|
1366
|
+
/** @description Event ID */
|
|
1155
1367
|
event_id?: string | null;
|
|
1156
|
-
/** @description
|
|
1368
|
+
/** @description Event title */
|
|
1157
1369
|
event_title?: string | null;
|
|
1158
|
-
/** @description Series slug
|
|
1370
|
+
/** @description Series slug */
|
|
1159
1371
|
series_slug?: string | null;
|
|
1160
|
-
/** @description
|
|
1372
|
+
/** @description Outcomes with their position IDs, index, and name */
|
|
1161
1373
|
outcomes: components["schemas"]["MarketCreatedOutcome"][];
|
|
1162
|
-
/** @description
|
|
1374
|
+
/** @description Market question */
|
|
1163
1375
|
question: string;
|
|
1164
|
-
/** @description
|
|
1376
|
+
/** @description Market title (short display name) */
|
|
1165
1377
|
title?: string | null;
|
|
1166
1378
|
/** @description Market description */
|
|
1167
1379
|
description: string;
|
|
@@ -1174,23 +1386,46 @@ export interface components {
|
|
|
1174
1386
|
/** @description Whether this is a neg-risk market */
|
|
1175
1387
|
neg_risk: boolean;
|
|
1176
1388
|
};
|
|
1177
|
-
/** @description
|
|
1178
|
-
|
|
1179
|
-
/** @description
|
|
1180
|
-
|
|
1181
|
-
/** @description
|
|
1182
|
-
|
|
1183
|
-
/** @description Parent event slug */
|
|
1184
|
-
event_slug?: string | null;
|
|
1389
|
+
/** @description Subscription filters for the `condition_metrics` event. All fields are optional. */
|
|
1390
|
+
MarketMetricsFilters: {
|
|
1391
|
+
/** @description Restrict to these markets. Empty = all markets. */
|
|
1392
|
+
condition_ids?: string[] | null;
|
|
1393
|
+
/** @description Restrict to these aggregation windows. Empty = all windows. */
|
|
1394
|
+
timeframes?: components["schemas"]["MetricFilterTimeframe"][] | null;
|
|
1185
1395
|
/**
|
|
1186
|
-
*
|
|
1187
|
-
* @
|
|
1396
|
+
* Format: double
|
|
1397
|
+
* @description Only fire when volume ≥ this value (USD).
|
|
1398
|
+
*/
|
|
1399
|
+
min_volume_usd?: number | null;
|
|
1400
|
+
/**
|
|
1401
|
+
* Format: double
|
|
1402
|
+
* @description Only fire when volume ≤ this value (USD).
|
|
1403
|
+
*/
|
|
1404
|
+
max_volume_usd?: number | null;
|
|
1405
|
+
/**
|
|
1406
|
+
* Format: int64
|
|
1407
|
+
* @description Only fire when transaction count ≥ this value.
|
|
1188
1408
|
*/
|
|
1189
|
-
|
|
1409
|
+
min_txns?: number | null;
|
|
1190
1410
|
/**
|
|
1191
1411
|
* Format: int64
|
|
1192
|
-
* @description
|
|
1412
|
+
* @description Only fire when unique trader count ≥ this value.
|
|
1413
|
+
*/
|
|
1414
|
+
min_unique_traders?: number | null;
|
|
1415
|
+
/**
|
|
1416
|
+
* Format: double
|
|
1417
|
+
* @description Only fire when total fees ≥ this value (USD).
|
|
1193
1418
|
*/
|
|
1419
|
+
min_fees?: number | null;
|
|
1420
|
+
};
|
|
1421
|
+
/** @description Market PnL webhook payload. */
|
|
1422
|
+
MarketPnlPayload: {
|
|
1423
|
+
trader?: string | null;
|
|
1424
|
+
condition_id?: string | null;
|
|
1425
|
+
event_slug?: string | null;
|
|
1426
|
+
/** @description Aggregation timeframe: "1d", "7d", "30d", or "lifetime" */
|
|
1427
|
+
timeframe: string;
|
|
1428
|
+
/** Format: int64 */
|
|
1194
1429
|
outcomes_traded?: number | null;
|
|
1195
1430
|
/** Format: int64 */
|
|
1196
1431
|
total_buys?: number | null;
|
|
@@ -1200,59 +1435,95 @@ export interface components {
|
|
|
1200
1435
|
total_redemptions?: number | null;
|
|
1201
1436
|
/** Format: int64 */
|
|
1202
1437
|
total_merges?: number | null;
|
|
1203
|
-
/**
|
|
1438
|
+
/** Format: double */
|
|
1204
1439
|
buy_usd?: number | null;
|
|
1205
|
-
/**
|
|
1440
|
+
/** Format: double */
|
|
1206
1441
|
sell_usd?: number | null;
|
|
1207
|
-
/**
|
|
1442
|
+
/** Format: double */
|
|
1208
1443
|
redemption_usd?: number | null;
|
|
1209
|
-
/**
|
|
1444
|
+
/** Format: double */
|
|
1210
1445
|
merge_usd?: number | null;
|
|
1211
|
-
/**
|
|
1446
|
+
/** Format: double */
|
|
1212
1447
|
realized_pnl_usd?: number | null;
|
|
1213
|
-
/**
|
|
1214
|
-
* Format: int64
|
|
1215
|
-
* @description Number of outcomes with positive PnL
|
|
1216
|
-
*/
|
|
1448
|
+
/** Format: int64 */
|
|
1217
1449
|
winning_outcomes?: number | null;
|
|
1218
|
-
/**
|
|
1450
|
+
/** Format: double */
|
|
1219
1451
|
total_fees?: number | null;
|
|
1452
|
+
/** Format: int64 */
|
|
1453
|
+
first_trade_at?: number | null;
|
|
1454
|
+
/** Format: int64 */
|
|
1455
|
+
last_trade_at?: number | null;
|
|
1456
|
+
};
|
|
1457
|
+
/** @description Subscription filters for the `market_volume_milestone` event. */
|
|
1458
|
+
MarketVolumeMilestoneFilters: {
|
|
1459
|
+
/** @description **Required.** Aggregation windows to monitor (e.g. \["1h", "24h"\]). */
|
|
1460
|
+
timeframes: components["schemas"]["MetricFilterTimeframe"][];
|
|
1461
|
+
/** @description Restrict to these markets. Empty = all markets. */
|
|
1462
|
+
condition_ids?: string[] | null;
|
|
1463
|
+
/** @description Specific USD milestones to trigger on (e.g. \[10000, 100000, 1000000\]). Empty = all milestones. */
|
|
1464
|
+
milestone_amounts?: number[] | null;
|
|
1465
|
+
};
|
|
1466
|
+
/** @description Subscription filters for the `market_volume_spike` event. `spike_ratio` is required. */
|
|
1467
|
+
MarketVolumeSpikeFilters: {
|
|
1220
1468
|
/**
|
|
1221
|
-
* Format:
|
|
1222
|
-
* @description
|
|
1469
|
+
* Format: double
|
|
1470
|
+
* @description **Required.** Multiplier threshold (must be > 1.0). Fires when current volume >= snapshot × ratio. The snapshot is set automatically on first data and resets after each fire.
|
|
1223
1471
|
*/
|
|
1224
|
-
|
|
1472
|
+
spike_ratio: number;
|
|
1225
1473
|
/**
|
|
1226
1474
|
* Format: int64
|
|
1227
|
-
* @description
|
|
1475
|
+
* @description Force snapshot reset after this many seconds (max 600 / 10 minutes).
|
|
1228
1476
|
*/
|
|
1229
|
-
|
|
1477
|
+
window_secs?: number | null;
|
|
1478
|
+
/** @description Restrict to these markets. Empty = all markets. */
|
|
1479
|
+
condition_ids?: string[] | null;
|
|
1480
|
+
/** @description Restrict to these aggregation windows. Empty = all windows. */
|
|
1481
|
+
timeframes?: components["schemas"]["VolumeSpikeFilterTimeframe"][] | null;
|
|
1230
1482
|
};
|
|
1231
|
-
/** @description
|
|
1483
|
+
/** @description Market volume spike webhook payload */
|
|
1232
1484
|
MarketVolumeSpikePayload: {
|
|
1233
|
-
/** @description Market condition ID */
|
|
1234
1485
|
condition_id: string;
|
|
1486
|
+
question?: string | null;
|
|
1487
|
+
market_slug?: string | null;
|
|
1488
|
+
event_slug?: string | null;
|
|
1489
|
+
image_url?: string | null;
|
|
1490
|
+
timeframe: string;
|
|
1235
1491
|
/**
|
|
1236
|
-
*
|
|
1237
|
-
* @
|
|
1492
|
+
* Format: double
|
|
1493
|
+
* @description Current window volume at the time of the spike (USD)
|
|
1238
1494
|
*/
|
|
1239
|
-
timeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "1d" | "24h" | "7d" | "30d";
|
|
1240
|
-
/** @description Current volume at the time of the spike (USD) */
|
|
1241
1495
|
current_volume_usd: number;
|
|
1242
|
-
/**
|
|
1496
|
+
/**
|
|
1497
|
+
* Format: double
|
|
1498
|
+
* @description Volume at the snapshot baseline (USD)
|
|
1499
|
+
*/
|
|
1243
1500
|
snapshot_volume_usd: number;
|
|
1244
|
-
/**
|
|
1501
|
+
/**
|
|
1502
|
+
* Format: double
|
|
1503
|
+
* @description New volume since the snapshot that triggered this notification (USD)
|
|
1504
|
+
*/
|
|
1245
1505
|
delta_volume_usd: number;
|
|
1246
|
-
/**
|
|
1506
|
+
/**
|
|
1507
|
+
* Format: double
|
|
1508
|
+
* @description Volume growth as a percentage of the snapshot (e.g. 200.0 means volume tripled)
|
|
1509
|
+
*/
|
|
1247
1510
|
spike_pct: number;
|
|
1248
1511
|
/**
|
|
1249
1512
|
* Format: int64
|
|
1250
1513
|
* @description Total transactions in this timeframe
|
|
1251
1514
|
*/
|
|
1252
1515
|
txns: number;
|
|
1253
|
-
/**
|
|
1516
|
+
/**
|
|
1517
|
+
* Format: double
|
|
1518
|
+
* @description Total fees in this timeframe
|
|
1519
|
+
*/
|
|
1254
1520
|
fees: number;
|
|
1255
1521
|
};
|
|
1522
|
+
/**
|
|
1523
|
+
* @description Aggregation windows emitted by the metrics / milestone streams.
|
|
1524
|
+
* @enum {string}
|
|
1525
|
+
*/
|
|
1526
|
+
MetricFilterTimeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d";
|
|
1256
1527
|
/** @description NegRisk Adapter: outcome reported for a neg-risk market question. */
|
|
1257
1528
|
NegRiskOutcomeReportedEvent: {
|
|
1258
1529
|
id: string;
|
|
@@ -1287,7 +1558,10 @@ export interface components {
|
|
|
1287
1558
|
condition_id?: string | null;
|
|
1288
1559
|
/** @description Outcome name (e.g. "Yes", "No") */
|
|
1289
1560
|
outcome?: string | null;
|
|
1290
|
-
/**
|
|
1561
|
+
/**
|
|
1562
|
+
* Format: int32
|
|
1563
|
+
* @description Outcome index: 0 = Yes/Up, 1 = No
|
|
1564
|
+
*/
|
|
1291
1565
|
outcome_index?: number | null;
|
|
1292
1566
|
/** @description Market question text */
|
|
1293
1567
|
question?: string | null;
|
|
@@ -1295,6 +1569,8 @@ export interface components {
|
|
|
1295
1569
|
market_slug?: string | null;
|
|
1296
1570
|
/** @description Parent event slug */
|
|
1297
1571
|
event_slug?: string | null;
|
|
1572
|
+
/** @description Market image URL */
|
|
1573
|
+
image_url?: string | null;
|
|
1298
1574
|
/** @description Unique trade identifier */
|
|
1299
1575
|
trade_id: string;
|
|
1300
1576
|
/** @description Transaction hash */
|
|
@@ -1309,32 +1585,44 @@ export interface components {
|
|
|
1309
1585
|
* @description Block confirmation timestamp (Unix seconds)
|
|
1310
1586
|
*/
|
|
1311
1587
|
confirmed_at: number;
|
|
1312
|
-
/**
|
|
1588
|
+
/**
|
|
1589
|
+
* Format: double
|
|
1590
|
+
* @description USD size of the trade (6 decimal places)
|
|
1591
|
+
*/
|
|
1313
1592
|
amount_usd: number;
|
|
1314
|
-
/**
|
|
1593
|
+
/**
|
|
1594
|
+
* Format: double
|
|
1595
|
+
* @description Outcome shares traded (6 decimal places)
|
|
1596
|
+
*/
|
|
1315
1597
|
shares_amount: number;
|
|
1316
|
-
/** @description Fee paid in USD (6 decimal places) */
|
|
1317
|
-
fee: number;
|
|
1318
1598
|
/**
|
|
1319
|
-
*
|
|
1320
|
-
* @
|
|
1599
|
+
* Format: double
|
|
1600
|
+
* @description Fee paid in USD (6 decimal places)
|
|
1321
1601
|
*/
|
|
1602
|
+
fee: number;
|
|
1603
|
+
/** @description Trade direction */
|
|
1322
1604
|
side: "Buy" | "Sell";
|
|
1323
|
-
/** @description Outcome token price (0.0–1.0) */
|
|
1324
|
-
price: number;
|
|
1325
|
-
/** @description Implied probability (0.0–1.0); null when outcome is unknown */
|
|
1326
|
-
probability?: number | null;
|
|
1327
1605
|
/**
|
|
1328
|
-
*
|
|
1329
|
-
* @
|
|
1606
|
+
* Format: double
|
|
1607
|
+
* @description Outcome token price (0.0–1.0)
|
|
1330
1608
|
*/
|
|
1331
|
-
|
|
1609
|
+
price: number;
|
|
1332
1610
|
/**
|
|
1333
|
-
*
|
|
1334
|
-
* @
|
|
1611
|
+
* Format: double
|
|
1612
|
+
* @description Implied probability (0.0–1.0); null when outcome is unknown
|
|
1335
1613
|
*/
|
|
1614
|
+
probability?: number | null;
|
|
1615
|
+
/** @description Exchange contract that processed the trade */
|
|
1616
|
+
exchange: "CTFExchange" | "NegRiskExchange" | "ConditionalTokens" | "NegRiskAdapter" | "CTFExchangeV2" | "NegRiskExchangeV2" | "Unknown";
|
|
1617
|
+
/** @description Trade type (webhook events only fire on order fills) */
|
|
1336
1618
|
trade_type: "OrderFilled" | "OrdersMatched";
|
|
1337
1619
|
};
|
|
1620
|
+
/**
|
|
1621
|
+
* @description Trade types accepted by `trader_new_trade.trade_types`. Webhook fires on
|
|
1622
|
+
* fill-style trades only.
|
|
1623
|
+
* @enum {string}
|
|
1624
|
+
*/
|
|
1625
|
+
NewTradeFilterType: "OrderFilled" | "OrdersMatched";
|
|
1338
1626
|
/** @description Payload delivered on every order-filled trade */
|
|
1339
1627
|
NewTradePayload: {
|
|
1340
1628
|
/** @description Limit-order maker wallet address (lowercase) */
|
|
@@ -1347,7 +1635,10 @@ export interface components {
|
|
|
1347
1635
|
condition_id?: string | null;
|
|
1348
1636
|
/** @description Outcome name (e.g. "Yes", "No") */
|
|
1349
1637
|
outcome?: string | null;
|
|
1350
|
-
/**
|
|
1638
|
+
/**
|
|
1639
|
+
* Format: int32
|
|
1640
|
+
* @description Outcome index: 0 = Yes/Up, 1 = No
|
|
1641
|
+
*/
|
|
1351
1642
|
outcome_index?: number | null;
|
|
1352
1643
|
/** @description Market question text */
|
|
1353
1644
|
question?: string | null;
|
|
@@ -1355,6 +1646,8 @@ export interface components {
|
|
|
1355
1646
|
market_slug?: string | null;
|
|
1356
1647
|
/** @description Parent event slug */
|
|
1357
1648
|
event_slug?: string | null;
|
|
1649
|
+
/** @description Market image URL */
|
|
1650
|
+
image_url?: string | null;
|
|
1358
1651
|
/** @description Unique trade identifier */
|
|
1359
1652
|
trade_id: string;
|
|
1360
1653
|
/** @description Transaction hash */
|
|
@@ -1369,32 +1662,43 @@ export interface components {
|
|
|
1369
1662
|
* @description Block confirmation timestamp (Unix seconds)
|
|
1370
1663
|
*/
|
|
1371
1664
|
confirmed_at: number;
|
|
1372
|
-
/**
|
|
1665
|
+
/**
|
|
1666
|
+
* Format: double
|
|
1667
|
+
* @description USD size of the trade (6 decimal places)
|
|
1668
|
+
*/
|
|
1373
1669
|
amount_usd: number;
|
|
1374
|
-
/**
|
|
1670
|
+
/**
|
|
1671
|
+
* Format: double
|
|
1672
|
+
* @description Outcome shares traded (6 decimal places)
|
|
1673
|
+
*/
|
|
1375
1674
|
shares_amount: number;
|
|
1376
|
-
/** @description Fee paid in USD (6 decimal places) */
|
|
1377
|
-
fee: number;
|
|
1378
1675
|
/**
|
|
1379
|
-
*
|
|
1380
|
-
* @
|
|
1676
|
+
* Format: double
|
|
1677
|
+
* @description Fee paid in USD (6 decimal places)
|
|
1381
1678
|
*/
|
|
1679
|
+
fee: number;
|
|
1680
|
+
/** @description Trade direction */
|
|
1382
1681
|
side: "Buy" | "Sell";
|
|
1383
|
-
/** @description Outcome token price (0.0–1.0) */
|
|
1384
|
-
price: number;
|
|
1385
|
-
/** @description Implied probability (0.0–1.0); null when outcome is unknown */
|
|
1386
|
-
probability?: number | null;
|
|
1387
1682
|
/**
|
|
1388
|
-
*
|
|
1389
|
-
* @
|
|
1683
|
+
* Format: double
|
|
1684
|
+
* @description Outcome token price (0.0–1.0)
|
|
1390
1685
|
*/
|
|
1391
|
-
|
|
1686
|
+
price: number;
|
|
1392
1687
|
/**
|
|
1393
|
-
*
|
|
1394
|
-
* @
|
|
1688
|
+
* Format: double
|
|
1689
|
+
* @description Implied probability (0.0–1.0); null when outcome is unknown
|
|
1395
1690
|
*/
|
|
1691
|
+
probability?: number | null;
|
|
1692
|
+
/** @description Exchange contract that processed the trade */
|
|
1693
|
+
exchange: "CTFExchange" | "NegRiskExchange" | "ConditionalTokens" | "NegRiskAdapter" | "CTFExchangeV2" | "NegRiskExchangeV2" | "Unknown";
|
|
1694
|
+
/** @description Trade type (webhook events only fire on order fills) */
|
|
1396
1695
|
trade_type: "OrderFilled" | "OrdersMatched";
|
|
1397
1696
|
};
|
|
1697
|
+
/**
|
|
1698
|
+
* @description Oracle event variants accepted by `oracle_events.oracle_event_types`.
|
|
1699
|
+
* @enum {string}
|
|
1700
|
+
*/
|
|
1701
|
+
OracleEventFilterType: "AssertionMade" | "AssertionDisputed" | "AssertionSettled" | "RequestPrice" | "ProposePrice" | "DisputePrice" | "Settle" | "QuestionResolved" | "QuestionEmergencyResolved" | "QuestionReset" | "QuestionInitialized" | "QuestionPaused" | "QuestionUnpaused" | "QuestionFlagged" | "QuestionUnflagged" | "ConditionResolution" | "NegRiskOutcomeReported";
|
|
1398
1702
|
/**
|
|
1399
1703
|
* @description Tagged enum for all oracle event types — serializes with `"event_type": "..."` discriminator
|
|
1400
1704
|
* and only includes fields relevant to each type.
|
|
@@ -1451,6 +1755,18 @@ export interface components {
|
|
|
1451
1755
|
/** @enum {string} */
|
|
1452
1756
|
event_type: "NegRiskOutcomeReported";
|
|
1453
1757
|
});
|
|
1758
|
+
/** @description Subscription filters for the `oracle_events` event. All fields are optional. */
|
|
1759
|
+
OracleEventsFilters: {
|
|
1760
|
+
/** @description Restrict to these event types (case-insensitive). Empty = all. */
|
|
1761
|
+
oracle_event_types?: components["schemas"]["OracleEventFilterType"][] | null;
|
|
1762
|
+
/** @description Restrict to events for these condition IDs. */
|
|
1763
|
+
condition_ids?: string[] | null;
|
|
1764
|
+
};
|
|
1765
|
+
/**
|
|
1766
|
+
* @description PnL aggregation windows accepted by `*_pnl.timeframes`.
|
|
1767
|
+
* @enum {string}
|
|
1768
|
+
*/
|
|
1769
|
+
PnlFilterTimeframe: "1d" | "7d" | "30d" | "lifetime";
|
|
1454
1770
|
/**
|
|
1455
1771
|
* @description PnL timeframe enum for webhook filtering
|
|
1456
1772
|
* @enum {string}
|
|
@@ -1460,7 +1776,7 @@ export interface components {
|
|
|
1460
1776
|
* @description Polymarket webhook event types
|
|
1461
1777
|
* @enum {string}
|
|
1462
1778
|
*/
|
|
1463
|
-
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" | "oracle_events";
|
|
1779
|
+
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" | "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";
|
|
1464
1780
|
/**
|
|
1465
1781
|
* @description Polymarket-specific webhook filters
|
|
1466
1782
|
*
|
|
@@ -1473,11 +1789,12 @@ export interface components {
|
|
|
1473
1789
|
* - event_pnl: traders, min_realized_pnl_usd, max_realized_pnl_usd, min_volume_usd, event_slugs, min_markets_traded
|
|
1474
1790
|
* - condition_metrics: condition_ids, min_volume_usd, max_volume_usd, min_fees, min_txns, timeframes
|
|
1475
1791
|
* - event_metrics: event_slugs, min_volume_usd, max_volume_usd, min_fees, min_txns, timeframes
|
|
1792
|
+
* - tag_metrics: tags, min_volume_usd, max_volume_usd, min_fees, min_txns, timeframes
|
|
1476
1793
|
* - position_metrics: position_ids, condition_ids, outcomes, min_volume_usd, max_volume_usd, min_buy_usd, min_sell_volume_usd, min_fees, min_txns, min_price_change_pct, min_probability_change_pct, timeframes
|
|
1477
1794
|
* - volume_milestone: condition_ids, timeframes, milestone_amounts
|
|
1478
1795
|
* - close_to_bond: min_probability (high zone threshold), max_probability (low zone threshold), condition_ids, position_ids, outcomes, position_outcome_indices, event_slugs, exclude_shortterm_markets
|
|
1479
1796
|
* - market_created: event_slugs, tags, exclude_shortterm_markets
|
|
1480
|
-
* - probability_spike: condition_ids, event_slugs, outcomes, min_probability_change_pct, spike_direction, window_secs, exclude_shortterm_markets
|
|
1797
|
+
* - probability_spike: condition_ids, event_slugs, outcomes, min_probability, max_probability, min_probability_change_pct, spike_direction, window_secs, exclude_shortterm_markets
|
|
1481
1798
|
* - price_spike: condition_ids, event_slugs, outcomes, min_price_change_pct, spike_direction, window_secs, exclude_shortterm_markets
|
|
1482
1799
|
* - trader_new_trade: wallet_addresses, min_usd_value, min_probability, max_probability, condition_ids, event_slugs, trade_types, exclude_shortterm_markets
|
|
1483
1800
|
* - trader_trade_event: wallet_addresses, min_usd_value, min_probability, max_probability, condition_ids, event_slugs, trade_types, exclude_shortterm_markets
|
|
@@ -1648,6 +1965,44 @@ export interface components {
|
|
|
1648
1965
|
*/
|
|
1649
1966
|
oracle_event_types?: string[];
|
|
1650
1967
|
};
|
|
1968
|
+
/** @description Subscription filters for the `position_metrics` event. All fields are optional. */
|
|
1969
|
+
PositionMetricsFilters: {
|
|
1970
|
+
/** @description Restrict to these outcome token IDs. */
|
|
1971
|
+
position_ids?: string[] | null;
|
|
1972
|
+
/** @description Restrict to positions within these markets. */
|
|
1973
|
+
condition_ids?: string[] | null;
|
|
1974
|
+
/** @description Restrict to positions with these outcome names (e.g. \["Yes", "No"\]). */
|
|
1975
|
+
outcomes?: string[] | null;
|
|
1976
|
+
/** @description Restrict to these aggregation windows. */
|
|
1977
|
+
timeframes?: components["schemas"]["MetricFilterTimeframe"][] | null;
|
|
1978
|
+
/**
|
|
1979
|
+
* Format: double
|
|
1980
|
+
* @description Only fire when position volume ≥ this value (USD).
|
|
1981
|
+
*/
|
|
1982
|
+
min_volume_usd?: number | null;
|
|
1983
|
+
/** Format: double */
|
|
1984
|
+
max_volume_usd?: number | null;
|
|
1985
|
+
/** Format: double */
|
|
1986
|
+
min_buy_usd?: number | null;
|
|
1987
|
+
/** Format: double */
|
|
1988
|
+
min_sell_volume_usd?: number | null;
|
|
1989
|
+
/** Format: int64 */
|
|
1990
|
+
min_txns?: number | null;
|
|
1991
|
+
/** Format: int64 */
|
|
1992
|
+
min_unique_traders?: number | null;
|
|
1993
|
+
/**
|
|
1994
|
+
* Format: double
|
|
1995
|
+
* @description Only fire when price change % ≥ this value.
|
|
1996
|
+
*/
|
|
1997
|
+
min_price_change_pct?: number | null;
|
|
1998
|
+
/**
|
|
1999
|
+
* Format: double
|
|
2000
|
+
* @description Only fire when probability change % ≥ this value.
|
|
2001
|
+
*/
|
|
2002
|
+
min_probability_change_pct?: number | null;
|
|
2003
|
+
/** Format: double */
|
|
2004
|
+
min_fees?: number | null;
|
|
2005
|
+
};
|
|
1651
2006
|
/** @description Payload delivered when a position's volume or transaction metrics cross a configured threshold */
|
|
1652
2007
|
PositionMetricsPayload: {
|
|
1653
2008
|
/** @description ERC-1155 outcome token ID */
|
|
@@ -1655,23 +2010,82 @@ export interface components {
|
|
|
1655
2010
|
/** @description Outcome name (e.g. "Yes", "No") */
|
|
1656
2011
|
outcome?: string | null;
|
|
1657
2012
|
/**
|
|
1658
|
-
* Format:
|
|
2013
|
+
* Format: int32
|
|
1659
2014
|
* @description Outcome index
|
|
1660
2015
|
*/
|
|
1661
2016
|
outcome_index?: number | null;
|
|
2017
|
+
/** @description Aggregation window */
|
|
2018
|
+
timeframe?: null | ("1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "6h" | "1d" | "24h" | "7d" | "30d");
|
|
1662
2019
|
/**
|
|
1663
|
-
*
|
|
1664
|
-
* @
|
|
2020
|
+
* Format: double
|
|
2021
|
+
* @description Total trading volume in USD
|
|
1665
2022
|
*/
|
|
1666
|
-
timeframe?: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d" | null;
|
|
1667
|
-
/** @description Total trading volume in USD */
|
|
1668
2023
|
volume_usd?: number | null;
|
|
1669
|
-
/**
|
|
2024
|
+
/**
|
|
2025
|
+
* Format: double
|
|
2026
|
+
* @description Buy volume in USD
|
|
2027
|
+
*/
|
|
1670
2028
|
buy_volume_usd?: number | null;
|
|
1671
|
-
/**
|
|
2029
|
+
/**
|
|
2030
|
+
* Format: double
|
|
2031
|
+
* @description Sell volume in USD
|
|
2032
|
+
*/
|
|
1672
2033
|
sell_volume_usd?: number | null;
|
|
1673
|
-
/**
|
|
2034
|
+
/**
|
|
2035
|
+
* Format: double
|
|
2036
|
+
* @description Total shares/contracts volume
|
|
2037
|
+
*/
|
|
2038
|
+
shares_volume?: number | null;
|
|
2039
|
+
/**
|
|
2040
|
+
* Format: double
|
|
2041
|
+
* @description Buy shares/contracts volume
|
|
2042
|
+
*/
|
|
2043
|
+
shares_buy_volume?: number | null;
|
|
2044
|
+
/**
|
|
2045
|
+
* Format: double
|
|
2046
|
+
* @description Sell shares/contracts volume
|
|
2047
|
+
*/
|
|
2048
|
+
shares_sell_volume?: number | null;
|
|
2049
|
+
/**
|
|
2050
|
+
* Format: double
|
|
2051
|
+
* @description Builder-attributed volume in USD
|
|
2052
|
+
*/
|
|
2053
|
+
builder_usd_volume?: number | null;
|
|
2054
|
+
/**
|
|
2055
|
+
* Format: double
|
|
2056
|
+
* @description Builder-attributed buy volume in USD
|
|
2057
|
+
*/
|
|
2058
|
+
builder_usd_buy_volume?: number | null;
|
|
2059
|
+
/**
|
|
2060
|
+
* Format: double
|
|
2061
|
+
* @description Builder-attributed sell volume in USD
|
|
2062
|
+
*/
|
|
2063
|
+
builder_usd_sell_volume?: number | null;
|
|
2064
|
+
/**
|
|
2065
|
+
* Format: double
|
|
2066
|
+
* @description Builder-attributed shares/contracts volume
|
|
2067
|
+
*/
|
|
2068
|
+
builder_shares_volume?: number | null;
|
|
2069
|
+
/**
|
|
2070
|
+
* Format: double
|
|
2071
|
+
* @description Builder-attributed buy shares/contracts volume
|
|
2072
|
+
*/
|
|
2073
|
+
builder_shares_buy_volume?: number | null;
|
|
2074
|
+
/**
|
|
2075
|
+
* Format: double
|
|
2076
|
+
* @description Builder-attributed sell shares/contracts volume
|
|
2077
|
+
*/
|
|
2078
|
+
builder_shares_sell_volume?: number | null;
|
|
2079
|
+
/**
|
|
2080
|
+
* Format: double
|
|
2081
|
+
* @description Total fees in USD
|
|
2082
|
+
*/
|
|
1674
2083
|
fees?: number | null;
|
|
2084
|
+
/**
|
|
2085
|
+
* Format: double
|
|
2086
|
+
* @description Builder-attributed fees in USD
|
|
2087
|
+
*/
|
|
2088
|
+
builder_fees?: number | null;
|
|
1675
2089
|
/** Format: int64 */
|
|
1676
2090
|
txns?: number | null;
|
|
1677
2091
|
/** Format: int64 */
|
|
@@ -1679,128 +2093,308 @@ export interface components {
|
|
|
1679
2093
|
/** Format: int64 */
|
|
1680
2094
|
sells?: number | null;
|
|
1681
2095
|
/** Format: int64 */
|
|
2096
|
+
builder_txns?: number | null;
|
|
2097
|
+
/** Format: int64 */
|
|
2098
|
+
builder_buys?: number | null;
|
|
2099
|
+
/** Format: int64 */
|
|
2100
|
+
builder_sells?: number | null;
|
|
2101
|
+
/** Format: int64 */
|
|
1682
2102
|
unique_traders?: number | null;
|
|
2103
|
+
/** Format: int64 */
|
|
2104
|
+
unique_builder_traders?: number | null;
|
|
2105
|
+
/** Format: double */
|
|
1683
2106
|
price_open?: number | null;
|
|
2107
|
+
/** Format: double */
|
|
1684
2108
|
price_close?: number | null;
|
|
2109
|
+
/** Format: double */
|
|
1685
2110
|
price_high?: number | null;
|
|
2111
|
+
/** Format: double */
|
|
1686
2112
|
price_low?: number | null;
|
|
2113
|
+
/** Format: double */
|
|
1687
2114
|
probability_open?: number | null;
|
|
2115
|
+
/** Format: double */
|
|
1688
2116
|
probability_close?: number | null;
|
|
2117
|
+
/** Format: double */
|
|
1689
2118
|
probability_high?: number | null;
|
|
2119
|
+
/** Format: double */
|
|
1690
2120
|
probability_low?: number | null;
|
|
2121
|
+
/** Format: double */
|
|
2122
|
+
avg_trade_shares?: number | null;
|
|
2123
|
+
/** Format: double */
|
|
2124
|
+
avg_buy_shares?: number | null;
|
|
2125
|
+
/** Format: double */
|
|
2126
|
+
avg_sell_shares?: number | null;
|
|
1691
2127
|
};
|
|
1692
|
-
/** @description
|
|
1693
|
-
|
|
1694
|
-
/** @description
|
|
2128
|
+
/** @description Subscription filters for the `position_volume_milestone` event. */
|
|
2129
|
+
PositionVolumeMilestoneFilters: {
|
|
2130
|
+
/** @description **Required.** Aggregation windows to monitor. */
|
|
2131
|
+
timeframes: components["schemas"]["MetricFilterTimeframe"][];
|
|
2132
|
+
/** @description Restrict to these outcome token IDs. */
|
|
2133
|
+
position_ids?: string[] | null;
|
|
2134
|
+
/** @description Restrict to positions within these markets. */
|
|
2135
|
+
condition_ids?: string[] | null;
|
|
2136
|
+
/** @description Restrict to these outcome names (e.g. \["Yes", "No"\]). */
|
|
2137
|
+
outcomes?: string[] | null;
|
|
2138
|
+
/** @description Specific USD milestones to trigger on. */
|
|
2139
|
+
milestone_amounts?: number[] | null;
|
|
2140
|
+
};
|
|
2141
|
+
/** @description Position volume milestone webhook payload */
|
|
2142
|
+
PositionVolumeMilestonePayload: {
|
|
1695
2143
|
condition_id?: string | null;
|
|
1696
|
-
/** @description ERC-1155 outcome token ID */
|
|
1697
2144
|
position_id: string;
|
|
1698
|
-
/** @description Outcome name (e.g. "Yes", "No") */
|
|
1699
2145
|
outcome?: string | null;
|
|
1700
|
-
/**
|
|
1701
|
-
* Format: int16
|
|
1702
|
-
* @description Outcome index
|
|
1703
|
-
*/
|
|
2146
|
+
/** Format: int32 */
|
|
1704
2147
|
outcome_index?: number | null;
|
|
2148
|
+
timeframe: string;
|
|
1705
2149
|
/**
|
|
1706
|
-
*
|
|
1707
|
-
* @
|
|
2150
|
+
* Format: double
|
|
2151
|
+
* @description Milestone amount reached (USD)
|
|
1708
2152
|
*/
|
|
1709
|
-
timeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d";
|
|
1710
|
-
/** @description The USD milestone amount that was crossed */
|
|
1711
2153
|
milestone_usd: number;
|
|
1712
|
-
/**
|
|
2154
|
+
/**
|
|
2155
|
+
* Format: double
|
|
2156
|
+
* @description Current volume (USD) that triggered the milestone
|
|
2157
|
+
*/
|
|
1713
2158
|
current_volume_usd: number;
|
|
1714
|
-
/**
|
|
2159
|
+
/**
|
|
2160
|
+
* Format: double
|
|
2161
|
+
* @description Buy volume (USD)
|
|
2162
|
+
*/
|
|
1715
2163
|
buy_volume_usd: number;
|
|
1716
|
-
/**
|
|
2164
|
+
/**
|
|
2165
|
+
* Format: double
|
|
2166
|
+
* @description Sell volume (USD)
|
|
2167
|
+
*/
|
|
1717
2168
|
sell_volume_usd: number;
|
|
1718
|
-
/**
|
|
2169
|
+
/**
|
|
2170
|
+
* Format: double
|
|
2171
|
+
* @description Total fees collected in this timeframe
|
|
2172
|
+
*/
|
|
1719
2173
|
fees: number;
|
|
1720
|
-
/**
|
|
2174
|
+
/**
|
|
2175
|
+
* Format: int64
|
|
2176
|
+
* @description Total transactions in this timeframe
|
|
2177
|
+
*/
|
|
1721
2178
|
txns: number;
|
|
1722
|
-
/**
|
|
2179
|
+
/**
|
|
2180
|
+
* Format: int64
|
|
2181
|
+
* @description Buy transactions
|
|
2182
|
+
*/
|
|
1723
2183
|
buys: number;
|
|
1724
|
-
/**
|
|
2184
|
+
/**
|
|
2185
|
+
* Format: int64
|
|
2186
|
+
* @description Sell transactions
|
|
2187
|
+
*/
|
|
1725
2188
|
sells: number;
|
|
1726
2189
|
};
|
|
1727
|
-
/** @description
|
|
2190
|
+
/** @description Subscription filters for the `position_volume_spike` event. `spike_ratio` is required. */
|
|
2191
|
+
PositionVolumeSpikeFilters: {
|
|
2192
|
+
/**
|
|
2193
|
+
* Format: double
|
|
2194
|
+
* @description **Required.** Multiplier threshold (must be > 1.0). Fires when current volume >= snapshot × ratio.
|
|
2195
|
+
*/
|
|
2196
|
+
spike_ratio: number;
|
|
2197
|
+
/**
|
|
2198
|
+
* Format: int64
|
|
2199
|
+
* @description Force snapshot reset after this many seconds (max 600 / 10 minutes).
|
|
2200
|
+
*/
|
|
2201
|
+
window_secs?: number | null;
|
|
2202
|
+
/** @description Restrict to these outcome token IDs. */
|
|
2203
|
+
position_ids?: string[] | null;
|
|
2204
|
+
/** @description Restrict to positions within these markets. */
|
|
2205
|
+
condition_ids?: string[] | null;
|
|
2206
|
+
/** @description Restrict to these outcome names. */
|
|
2207
|
+
outcomes?: string[] | null;
|
|
2208
|
+
/** @description Restrict to these aggregation windows. */
|
|
2209
|
+
timeframes?: components["schemas"]["VolumeSpikeFilterTimeframe"][] | null;
|
|
2210
|
+
};
|
|
2211
|
+
/** @description Position volume spike webhook payload */
|
|
1728
2212
|
PositionVolumeSpikePayload: {
|
|
1729
|
-
/** @description ERC-1155 outcome token ID */
|
|
1730
2213
|
position_id: string;
|
|
1731
|
-
/** @description Parent market condition ID */
|
|
1732
2214
|
condition_id: string;
|
|
1733
|
-
|
|
2215
|
+
question?: string | null;
|
|
2216
|
+
market_slug?: string | null;
|
|
2217
|
+
event_slug?: string | null;
|
|
2218
|
+
image_url?: string | null;
|
|
1734
2219
|
outcome?: string | null;
|
|
1735
|
-
/** Format:
|
|
2220
|
+
/** Format: int32 */
|
|
1736
2221
|
outcome_index?: number | null;
|
|
2222
|
+
timeframe: string;
|
|
1737
2223
|
/**
|
|
1738
|
-
*
|
|
1739
|
-
* @
|
|
2224
|
+
* Format: double
|
|
2225
|
+
* @description Current position volume at the time of the spike (USD)
|
|
1740
2226
|
*/
|
|
1741
|
-
timeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "1d" | "24h" | "7d" | "30d";
|
|
1742
|
-
/** @description Current position volume at the time of the spike (USD) */
|
|
1743
2227
|
current_volume_usd: number;
|
|
1744
|
-
/**
|
|
2228
|
+
/**
|
|
2229
|
+
* Format: double
|
|
2230
|
+
* @description Volume at the snapshot baseline (USD)
|
|
2231
|
+
*/
|
|
1745
2232
|
snapshot_volume_usd: number;
|
|
1746
|
-
/**
|
|
2233
|
+
/**
|
|
2234
|
+
* Format: double
|
|
2235
|
+
* @description New volume since the snapshot that triggered this notification (USD)
|
|
2236
|
+
*/
|
|
1747
2237
|
delta_volume_usd: number;
|
|
1748
|
-
/**
|
|
2238
|
+
/**
|
|
2239
|
+
* Format: double
|
|
2240
|
+
* @description Volume growth as a percentage of the snapshot (e.g. 200.0 means volume tripled)
|
|
2241
|
+
*/
|
|
1749
2242
|
spike_pct: number;
|
|
1750
|
-
/**
|
|
2243
|
+
/**
|
|
2244
|
+
* Format: int64
|
|
2245
|
+
* @description Total transactions in this timeframe
|
|
2246
|
+
*/
|
|
1751
2247
|
txns: number;
|
|
2248
|
+
/**
|
|
2249
|
+
* Format: double
|
|
2250
|
+
* @description Total fees in this timeframe
|
|
2251
|
+
*/
|
|
1752
2252
|
fees: number;
|
|
1753
2253
|
};
|
|
2254
|
+
/** @description Subscription filters for the `price_spike` event. */
|
|
2255
|
+
PriceSpikeFilters: {
|
|
2256
|
+
/** @description Restrict to specific outcome token IDs. Empty = all positions. */
|
|
2257
|
+
position_ids?: string[] | null;
|
|
2258
|
+
/** @description Restrict to specific market condition IDs. Empty = all markets. */
|
|
2259
|
+
condition_ids?: string[] | null;
|
|
2260
|
+
/** @description Restrict to specific events. Empty = all events. */
|
|
2261
|
+
event_slugs?: string[] | null;
|
|
2262
|
+
/** @description Restrict to these outcome names (e.g. \["Yes", "No"\]). */
|
|
2263
|
+
outcomes?: string[] | null;
|
|
2264
|
+
/**
|
|
2265
|
+
* Format: double
|
|
2266
|
+
* @description Minimum price percentage move to trigger (e.g. `10` for a 10% move).
|
|
2267
|
+
*/
|
|
2268
|
+
min_price_change_pct?: number | null;
|
|
2269
|
+
/**
|
|
2270
|
+
* Format: double
|
|
2271
|
+
* @description Minimum YES probability (0-1).
|
|
2272
|
+
*/
|
|
2273
|
+
min_probability?: number | null;
|
|
2274
|
+
/**
|
|
2275
|
+
* Format: double
|
|
2276
|
+
* @description Maximum YES probability (0-1).
|
|
2277
|
+
*/
|
|
2278
|
+
max_probability?: number | null;
|
|
2279
|
+
/**
|
|
2280
|
+
* Format: int64
|
|
2281
|
+
* @description Minimum trades accumulated in the observation window before firing.
|
|
2282
|
+
*/
|
|
2283
|
+
min_txns?: number | null;
|
|
2284
|
+
/**
|
|
2285
|
+
* Format: double
|
|
2286
|
+
* @description Minimum USD volume accumulated in the observation window before firing.
|
|
2287
|
+
*/
|
|
2288
|
+
min_volume_usd?: number | null;
|
|
2289
|
+
spike_direction?: null | components["schemas"]["SpikeDirection"];
|
|
2290
|
+
/**
|
|
2291
|
+
* Format: int64
|
|
2292
|
+
* @description Observation window in seconds. The first trade in each window sets the reference price; subsequent trades are compared to it. E.g. `60` detects moves that occur within 60 seconds.
|
|
2293
|
+
*/
|
|
2294
|
+
window_secs?: number | null;
|
|
2295
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
2296
|
+
exclude_shortterm_markets?: boolean | null;
|
|
2297
|
+
};
|
|
2298
|
+
/** @description Position price spike webhook payload */
|
|
1754
2299
|
PriceSpikePayload: {
|
|
1755
|
-
/** @description Outcome token ID */
|
|
1756
2300
|
position_id: string;
|
|
1757
|
-
/** @description Market condition ID */
|
|
1758
2301
|
condition_id?: string | null;
|
|
1759
|
-
|
|
2302
|
+
question?: string | null;
|
|
2303
|
+
market_slug?: string | null;
|
|
1760
2304
|
event_slug?: string | null;
|
|
1761
|
-
|
|
2305
|
+
image_url?: string | null;
|
|
1762
2306
|
outcome?: string | null;
|
|
2307
|
+
/** Format: int32 */
|
|
2308
|
+
outcome_index?: number | null;
|
|
1763
2309
|
/**
|
|
1764
|
-
* Format:
|
|
1765
|
-
* @description
|
|
2310
|
+
* Format: double
|
|
2311
|
+
* @description Price at the start of the observation window (the baseline snapshot)
|
|
1766
2312
|
*/
|
|
1767
|
-
outcome_index?: number | null;
|
|
1768
|
-
/** @description Price at the start of the observation window (baseline snapshot, 0.0–1.0) */
|
|
1769
2313
|
previous_price: number;
|
|
1770
|
-
/**
|
|
2314
|
+
/**
|
|
2315
|
+
* Format: double
|
|
2316
|
+
* @description Current price that triggered the spike
|
|
2317
|
+
*/
|
|
1771
2318
|
current_price: number;
|
|
2319
|
+
/** @description Direction of the spike: `"up"` (price rising) or `"down"` (price falling) */
|
|
2320
|
+
spike_direction: string;
|
|
1772
2321
|
/**
|
|
1773
|
-
*
|
|
1774
|
-
* @
|
|
2322
|
+
* Format: double
|
|
2323
|
+
* @description Detected spike percentage from the snapshot baseline. Positive = rising, negative = falling.
|
|
1775
2324
|
*/
|
|
1776
|
-
spike_direction: "up" | "down";
|
|
1777
|
-
/** @description Percentage move that triggered this notification. Positive = up, negative = down. */
|
|
1778
2325
|
spike_pct: number;
|
|
1779
2326
|
};
|
|
2327
|
+
/** @description Subscription filters for the `probability_spike` event. */
|
|
2328
|
+
ProbabilitySpikeFilters: {
|
|
2329
|
+
/** @description Restrict to specific outcome token IDs. Empty = all positions. */
|
|
2330
|
+
position_ids?: string[] | null;
|
|
2331
|
+
/** @description Restrict to specific market condition IDs. Empty = all markets. */
|
|
2332
|
+
condition_ids?: string[] | null;
|
|
2333
|
+
/** @description Restrict to specific events. Empty = all events. */
|
|
2334
|
+
event_slugs?: string[] | null;
|
|
2335
|
+
/** @description Restrict to these outcome names (e.g. \["Yes", "No"\]). */
|
|
2336
|
+
outcomes?: string[] | null;
|
|
2337
|
+
/**
|
|
2338
|
+
* Format: double
|
|
2339
|
+
* @description Minimum YES probability (0-1). At least one of `min_probability`/`max_probability` is enforced at runtime if you want a probability gate.
|
|
2340
|
+
*/
|
|
2341
|
+
min_probability?: number | null;
|
|
2342
|
+
/**
|
|
2343
|
+
* Format: double
|
|
2344
|
+
* @description Maximum YES probability (0-1).
|
|
2345
|
+
*/
|
|
2346
|
+
max_probability?: number | null;
|
|
2347
|
+
/**
|
|
2348
|
+
* Format: double
|
|
2349
|
+
* @description Minimum probability percentage move to trigger (e.g. `10` for a 10% move).
|
|
2350
|
+
*/
|
|
2351
|
+
min_probability_change_pct?: number | null;
|
|
2352
|
+
/**
|
|
2353
|
+
* Format: int64
|
|
2354
|
+
* @description Minimum trades accumulated in the observation window before firing.
|
|
2355
|
+
*/
|
|
2356
|
+
min_txns?: number | null;
|
|
2357
|
+
/**
|
|
2358
|
+
* Format: double
|
|
2359
|
+
* @description Minimum USD volume accumulated in the observation window before firing.
|
|
2360
|
+
*/
|
|
2361
|
+
min_volume_usd?: number | null;
|
|
2362
|
+
spike_direction?: null | components["schemas"]["SpikeDirection"];
|
|
2363
|
+
/**
|
|
2364
|
+
* Format: int64
|
|
2365
|
+
* @description Observation window in seconds. The first trade in each window sets the reference price; subsequent trades are compared to it. E.g. `60` detects moves that occur within 60 seconds.
|
|
2366
|
+
*/
|
|
2367
|
+
window_secs?: number | null;
|
|
2368
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
2369
|
+
exclude_shortterm_markets?: boolean | null;
|
|
2370
|
+
};
|
|
2371
|
+
/** @description Position probability spike webhook payload */
|
|
1780
2372
|
ProbabilitySpikePayload: {
|
|
1781
|
-
/** @description Outcome token ID */
|
|
1782
2373
|
position_id: string;
|
|
1783
|
-
/** @description Market condition ID */
|
|
1784
2374
|
condition_id?: string | null;
|
|
1785
|
-
|
|
2375
|
+
question?: string | null;
|
|
2376
|
+
market_slug?: string | null;
|
|
1786
2377
|
event_slug?: string | null;
|
|
1787
|
-
|
|
2378
|
+
image_url?: string | null;
|
|
1788
2379
|
outcome?: string | null;
|
|
2380
|
+
/** Format: int32 */
|
|
2381
|
+
outcome_index?: number | null;
|
|
1789
2382
|
/**
|
|
1790
|
-
* Format:
|
|
1791
|
-
* @description
|
|
2383
|
+
* Format: double
|
|
2384
|
+
* @description Probability at the start of the observation window (the baseline snapshot)
|
|
1792
2385
|
*/
|
|
1793
|
-
outcome_index?: number | null;
|
|
1794
|
-
/** @description Probability at the start of the observation window (baseline snapshot, 0.0–1.0) */
|
|
1795
2386
|
previous_probability: number;
|
|
1796
|
-
/**
|
|
2387
|
+
/**
|
|
2388
|
+
* Format: double
|
|
2389
|
+
* @description Current probability that triggered the spike
|
|
2390
|
+
*/
|
|
1797
2391
|
current_probability: number;
|
|
2392
|
+
/** @description Direction of the spike: `"up"` (probability rising) or `"down"` (probability falling) */
|
|
2393
|
+
spike_direction: string;
|
|
1798
2394
|
/**
|
|
1799
|
-
*
|
|
1800
|
-
* @
|
|
2395
|
+
* Format: double
|
|
2396
|
+
* @description Detected spike percentage from the snapshot baseline. Positive = rising, negative = falling.
|
|
1801
2397
|
*/
|
|
1802
|
-
spike_direction: "up" | "down";
|
|
1803
|
-
/** @description Percentage move that triggered this notification. Positive = up, negative = down. */
|
|
1804
2398
|
spike_pct: number;
|
|
1805
2399
|
};
|
|
1806
2400
|
/** @description V2 UMA OOv2: a price was proposed (resolution proposal). */
|
|
@@ -2092,98 +2686,469 @@ export interface components {
|
|
|
2092
2686
|
* @enum {string}
|
|
2093
2687
|
*/
|
|
2094
2688
|
SpikeDirection: "up" | "down" | "both";
|
|
2095
|
-
/** @description
|
|
2096
|
-
|
|
2097
|
-
/** @description
|
|
2098
|
-
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
secret?: string | null;
|
|
2102
|
-
filters?: null | components["schemas"]["WebhookFiltersBody"];
|
|
2103
|
-
status?: null | components["schemas"]["WebhookStatusBody"];
|
|
2104
|
-
/** @description Description/name */
|
|
2105
|
-
description?: string | null;
|
|
2106
|
-
};
|
|
2107
|
-
/** @description Payload delivered when a market's trading volume crosses a USD milestone in the specified timeframe */
|
|
2108
|
-
VolumeMilestonePayload: {
|
|
2109
|
-
/** @description Market condition ID */
|
|
2110
|
-
condition_id: string;
|
|
2111
|
-
/**
|
|
2112
|
-
* @description Aggregation window that crossed the milestone
|
|
2113
|
-
* @enum {string}
|
|
2114
|
-
*/
|
|
2115
|
-
timeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d";
|
|
2116
|
-
/** @description The USD milestone amount that was crossed */
|
|
2117
|
-
milestone_usd: number;
|
|
2118
|
-
/** @description Current volume at time of trigger (USD) */
|
|
2119
|
-
current_volume_usd: number;
|
|
2120
|
-
/** @description Total fees in USD for this timeframe */
|
|
2121
|
-
fees: number;
|
|
2689
|
+
/** @description Subscription filters for the `tag_metrics` event. All fields are optional. */
|
|
2690
|
+
TagMetricsFilters: {
|
|
2691
|
+
/** @description Restrict to these tags. Empty = all tags. */
|
|
2692
|
+
tags?: string[] | null;
|
|
2693
|
+
/** @description Restrict to these aggregation windows. */
|
|
2694
|
+
timeframes?: components["schemas"]["MetricFilterTimeframe"][] | null;
|
|
2122
2695
|
/**
|
|
2123
|
-
* Format:
|
|
2124
|
-
* @description
|
|
2696
|
+
* Format: double
|
|
2697
|
+
* @description Only fire when aggregated tag volume >= this value (USD).
|
|
2125
2698
|
*/
|
|
2126
|
-
|
|
2699
|
+
min_volume_usd?: number | null;
|
|
2700
|
+
/** Format: double */
|
|
2701
|
+
max_volume_usd?: number | null;
|
|
2702
|
+
/** Format: int64 */
|
|
2703
|
+
min_txns?: number | null;
|
|
2704
|
+
/** Format: int64 */
|
|
2705
|
+
min_unique_traders?: number | null;
|
|
2706
|
+
/** Format: double */
|
|
2707
|
+
min_fees?: number | null;
|
|
2127
2708
|
};
|
|
2128
|
-
/**
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
WebhookEventInfo: {
|
|
2135
|
-
/** @description Event type identifier (e.g. "first_trade") */
|
|
2136
|
-
event: string;
|
|
2137
|
-
/** @description Human-readable description */
|
|
2138
|
-
description: string;
|
|
2709
|
+
/** @description Payload delivered when a tag's aggregated volume or transaction metrics cross a configured threshold */
|
|
2710
|
+
TagMetricsPayload: {
|
|
2711
|
+
/** @description Tag label or slug */
|
|
2712
|
+
tag?: string | null;
|
|
2713
|
+
/** @description Aggregation window */
|
|
2714
|
+
timeframe?: null | ("1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "6h" | "1d" | "24h" | "7d" | "30d");
|
|
2139
2715
|
/**
|
|
2140
|
-
*
|
|
2141
|
-
* @
|
|
2716
|
+
* Format: double
|
|
2717
|
+
* @description Total aggregated volume for the tag (USD)
|
|
2142
2718
|
*/
|
|
2143
|
-
|
|
2719
|
+
volume_usd?: number | null;
|
|
2144
2720
|
/**
|
|
2145
|
-
* Format:
|
|
2146
|
-
* @description
|
|
2721
|
+
* Format: double
|
|
2722
|
+
* @description Total aggregated shares/contracts volume for the tag
|
|
2147
2723
|
*/
|
|
2148
|
-
|
|
2149
|
-
/** @description Filter field names that apply to this event type */
|
|
2150
|
-
applicable_filters: string[];
|
|
2151
|
-
};
|
|
2152
|
-
/** @description Webhook filters request body */
|
|
2153
|
-
WebhookFiltersBody: {
|
|
2154
|
-
/** @description Filter by wallet addresses (for first_trade / new_market / whale_trade). Max 500 entries. */
|
|
2155
|
-
wallet_addresses?: string[];
|
|
2156
|
-
/** @description Filter by trader addresses (for PnL webhooks). Max 500 entries. */
|
|
2157
|
-
traders?: string[];
|
|
2158
|
-
/** @description Filter by market/condition IDs. Max 500 entries. */
|
|
2159
|
-
condition_ids?: string[];
|
|
2160
|
-
/** @description Filter by position IDs (for position metrics / close_to_bond). Max 500 entries. */
|
|
2161
|
-
position_ids?: string[];
|
|
2162
|
-
/** @description Filter by event slugs. Max 500 entries. */
|
|
2163
|
-
event_slugs?: string[];
|
|
2164
|
-
/** @description Filter by tags or category names (case-insensitive) — for market_created. Max 500 entries. */
|
|
2165
|
-
tags?: string[];
|
|
2166
|
-
/** @description Filter by outcomes (e.g. "Yes", "No") — for position metrics / close_to_bond. Max 500 entries. */
|
|
2167
|
-
outcomes?: string[];
|
|
2168
|
-
/** @description Filter by position outcome index — for close_to_bond. Position 0 = Yes/Up, 1 = No. Max 500 entries. */
|
|
2169
|
-
position_outcome_indices?: number[];
|
|
2170
|
-
/** @description Filter by trade type — for `trader_new_trade` and `trader_trade_event`. Max 500 entries. */
|
|
2171
|
-
trade_types?: string[];
|
|
2724
|
+
shares_volume?: number | null;
|
|
2172
2725
|
/**
|
|
2173
2726
|
* Format: double
|
|
2174
|
-
* @description
|
|
2727
|
+
* @description Builder-attributed aggregated volume in USD
|
|
2175
2728
|
*/
|
|
2176
|
-
|
|
2729
|
+
builder_usd_volume?: number | null;
|
|
2177
2730
|
/**
|
|
2178
2731
|
* Format: double
|
|
2179
|
-
* @description
|
|
2732
|
+
* @description Builder-attributed aggregated shares/contracts volume
|
|
2180
2733
|
*/
|
|
2181
|
-
|
|
2734
|
+
builder_shares_volume?: number | null;
|
|
2182
2735
|
/**
|
|
2183
2736
|
* Format: double
|
|
2184
|
-
* @description
|
|
2737
|
+
* @description Total fees collected in USD
|
|
2185
2738
|
*/
|
|
2186
|
-
|
|
2739
|
+
fees?: number | null;
|
|
2740
|
+
/**
|
|
2741
|
+
* Format: double
|
|
2742
|
+
* @description Builder-attributed fees in USD
|
|
2743
|
+
*/
|
|
2744
|
+
builder_fees?: number | null;
|
|
2745
|
+
/**
|
|
2746
|
+
* Format: int64
|
|
2747
|
+
* @description Total number of transactions
|
|
2748
|
+
*/
|
|
2749
|
+
txns?: number | null;
|
|
2750
|
+
/**
|
|
2751
|
+
* Format: int64
|
|
2752
|
+
* @description Builder-attributed transaction count
|
|
2753
|
+
*/
|
|
2754
|
+
builder_txns?: number | null;
|
|
2755
|
+
/**
|
|
2756
|
+
* Format: int64
|
|
2757
|
+
* @description Number of unique traders
|
|
2758
|
+
*/
|
|
2759
|
+
unique_traders?: number | null;
|
|
2760
|
+
/**
|
|
2761
|
+
* Format: int64
|
|
2762
|
+
* @description Number of unique builder-attributed traders
|
|
2763
|
+
*/
|
|
2764
|
+
unique_builder_traders?: number | null;
|
|
2765
|
+
};
|
|
2766
|
+
/**
|
|
2767
|
+
* @description Trade-event types accepted by `trader_trade_event.trade_types`. Covers the
|
|
2768
|
+
* full set of typed prediction-trade variants.
|
|
2769
|
+
* @enum {string}
|
|
2770
|
+
*/
|
|
2771
|
+
TradeEventFilterType: "OrderFilled" | "Redemption" | "Merge" | "Split" | "Cancelled" | "PositionsConverted" | "OrdersMatched" | "Initialization" | "Proposal" | "Dispute" | "Settled" | "Resolution" | "ConditionResolution" | "Reset" | "Flag" | "Unflag" | "Pause" | "Unpause" | "ManualResolution" | "NegRiskOutcomeReported" | "RegisterToken" | "Approval";
|
|
2772
|
+
/** @description Subscription filters for the `trader_event_pnl` event. All fields are optional. */
|
|
2773
|
+
TraderEventPnlFilters: {
|
|
2774
|
+
/** @description Track only these trader wallet addresses. */
|
|
2775
|
+
traders?: string[] | null;
|
|
2776
|
+
/** @description Restrict to these events. */
|
|
2777
|
+
event_slugs?: string[] | null;
|
|
2778
|
+
/**
|
|
2779
|
+
* Format: double
|
|
2780
|
+
* @description Only fire when per-event realized PnL ≥ this value (USD).
|
|
2781
|
+
*/
|
|
2782
|
+
min_realized_pnl_usd?: number | null;
|
|
2783
|
+
/**
|
|
2784
|
+
* Format: double
|
|
2785
|
+
* @description Only fire when per-event realized PnL ≤ this value (USD).
|
|
2786
|
+
*/
|
|
2787
|
+
max_realized_pnl_usd?: number | null;
|
|
2788
|
+
/**
|
|
2789
|
+
* Format: double
|
|
2790
|
+
* @description Only fire when total event volume ≥ this value (USD).
|
|
2791
|
+
*/
|
|
2792
|
+
min_volume_usd?: number | null;
|
|
2793
|
+
/**
|
|
2794
|
+
* Format: double
|
|
2795
|
+
* @description Only fire when total event volume ≤ this value (USD).
|
|
2796
|
+
*/
|
|
2797
|
+
max_volume_usd?: number | null;
|
|
2798
|
+
/**
|
|
2799
|
+
* Format: double
|
|
2800
|
+
* @description Only fire when buy volume within the event ≥ this value (USD).
|
|
2801
|
+
*/
|
|
2802
|
+
min_buy_usd?: number | null;
|
|
2803
|
+
/**
|
|
2804
|
+
* Format: double
|
|
2805
|
+
* @description Only fire when sell volume within the event ≥ this value (USD).
|
|
2806
|
+
*/
|
|
2807
|
+
min_sell_volume_usd?: number | null;
|
|
2808
|
+
/**
|
|
2809
|
+
* Format: int64
|
|
2810
|
+
* @description Only fire when the trader has traded in ≥ this many markets within the event.
|
|
2811
|
+
*/
|
|
2812
|
+
min_markets_traded?: number | null;
|
|
2813
|
+
/** @description Restrict to these PnL windows. */
|
|
2814
|
+
timeframes?: components["schemas"]["PnlFilterTimeframe"][] | null;
|
|
2815
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
2816
|
+
exclude_shortterm_markets?: boolean | null;
|
|
2817
|
+
};
|
|
2818
|
+
/** @description Subscription filters for the `trader_first_trade` event. All fields are optional. */
|
|
2819
|
+
TraderFirstTradeFilters: {
|
|
2820
|
+
/** @description Only fire for trades by these wallet addresses (lowercase). Empty = all traders. */
|
|
2821
|
+
wallet_addresses?: string[] | null;
|
|
2822
|
+
/** @description Restrict to trades in these markets. Empty = all markets. */
|
|
2823
|
+
condition_ids?: string[] | null;
|
|
2824
|
+
/** @description Restrict to trades in markets belonging to these events. */
|
|
2825
|
+
event_slugs?: string[] | null;
|
|
2826
|
+
/**
|
|
2827
|
+
* Format: double
|
|
2828
|
+
* @description Minimum trade size in USD. Omit to match all sizes.
|
|
2829
|
+
*/
|
|
2830
|
+
min_usd_value?: number | null;
|
|
2831
|
+
/**
|
|
2832
|
+
* Format: double
|
|
2833
|
+
* @description Only fire when the outcome probability is ≥ this value.
|
|
2834
|
+
*/
|
|
2835
|
+
min_probability?: number | null;
|
|
2836
|
+
/**
|
|
2837
|
+
* Format: double
|
|
2838
|
+
* @description Only fire when the outcome probability is ≤ this value.
|
|
2839
|
+
*/
|
|
2840
|
+
max_probability?: number | null;
|
|
2841
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets (event slugs containing `updown`). Default: `false`. */
|
|
2842
|
+
exclude_shortterm_markets?: boolean | null;
|
|
2843
|
+
};
|
|
2844
|
+
/** @description Subscription filters for the `trader_global_pnl` event. All fields are optional. */
|
|
2845
|
+
TraderGlobalPnlFilters: {
|
|
2846
|
+
/** @description Track only these trader wallet addresses. Empty = all traders. */
|
|
2847
|
+
traders?: string[] | null;
|
|
2848
|
+
/**
|
|
2849
|
+
* Format: double
|
|
2850
|
+
* @description Only fire when realized PnL ≥ this value (USD). Use negative values for loss thresholds.
|
|
2851
|
+
*/
|
|
2852
|
+
min_realized_pnl_usd?: number | null;
|
|
2853
|
+
/**
|
|
2854
|
+
* Format: double
|
|
2855
|
+
* @description Only fire when realized PnL ≤ this value (USD).
|
|
2856
|
+
*/
|
|
2857
|
+
max_realized_pnl_usd?: number | null;
|
|
2858
|
+
/**
|
|
2859
|
+
* Format: double
|
|
2860
|
+
* @description Only fire when total trading volume ≥ this value (USD).
|
|
2861
|
+
*/
|
|
2862
|
+
min_volume_usd?: number | null;
|
|
2863
|
+
/**
|
|
2864
|
+
* Format: double
|
|
2865
|
+
* @description Only fire when total trading volume ≤ this value (USD).
|
|
2866
|
+
*/
|
|
2867
|
+
max_volume_usd?: number | null;
|
|
2868
|
+
/**
|
|
2869
|
+
* Format: double
|
|
2870
|
+
* @description Only fire when buy volume ≥ this value (USD).
|
|
2871
|
+
*/
|
|
2872
|
+
min_buy_usd?: number | null;
|
|
2873
|
+
/**
|
|
2874
|
+
* Format: double
|
|
2875
|
+
* @description Only fire when sell volume ≥ this value (USD).
|
|
2876
|
+
*/
|
|
2877
|
+
min_sell_volume_usd?: number | null;
|
|
2878
|
+
/**
|
|
2879
|
+
* Format: double
|
|
2880
|
+
* @description Only fire when market win rate ≥ this percentage (0.0–100.0).
|
|
2881
|
+
*/
|
|
2882
|
+
min_win_rate?: number | null;
|
|
2883
|
+
/**
|
|
2884
|
+
* Format: int64
|
|
2885
|
+
* @description Only fire when the trader has traded in ≥ this many markets.
|
|
2886
|
+
*/
|
|
2887
|
+
min_markets_traded?: number | null;
|
|
2888
|
+
/** @description Restrict to these PnL windows. Empty = all windows. */
|
|
2889
|
+
timeframes?: components["schemas"]["PnlFilterTimeframe"][] | null;
|
|
2890
|
+
};
|
|
2891
|
+
/** @description Subscription filters for the `trader_market_pnl` event. All fields are optional. */
|
|
2892
|
+
TraderMarketPnlFilters: {
|
|
2893
|
+
/** @description Track only these trader wallet addresses. */
|
|
2894
|
+
traders?: string[] | null;
|
|
2895
|
+
/** @description Restrict to these markets. */
|
|
2896
|
+
condition_ids?: string[] | null;
|
|
2897
|
+
/** @description Restrict to markets in these events. */
|
|
2898
|
+
event_slugs?: string[] | null;
|
|
2899
|
+
/**
|
|
2900
|
+
* Format: double
|
|
2901
|
+
* @description Only fire when per-market realized PnL ≥ this value (USD).
|
|
2902
|
+
*/
|
|
2903
|
+
min_realized_pnl_usd?: number | null;
|
|
2904
|
+
/**
|
|
2905
|
+
* Format: double
|
|
2906
|
+
* @description Only fire when per-market realized PnL ≤ this value (USD).
|
|
2907
|
+
*/
|
|
2908
|
+
max_realized_pnl_usd?: number | null;
|
|
2909
|
+
/**
|
|
2910
|
+
* Format: double
|
|
2911
|
+
* @description Only fire when total volume (buy + sell + redemption + merge) ≥ this value (USD).
|
|
2912
|
+
*/
|
|
2913
|
+
min_volume_usd?: number | null;
|
|
2914
|
+
/**
|
|
2915
|
+
* Format: double
|
|
2916
|
+
* @description Only fire when total volume ≤ this value (USD).
|
|
2917
|
+
*/
|
|
2918
|
+
max_volume_usd?: number | null;
|
|
2919
|
+
/**
|
|
2920
|
+
* Format: double
|
|
2921
|
+
* @description Only fire when buy volume in the market ≥ this value (USD).
|
|
2922
|
+
*/
|
|
2923
|
+
min_buy_usd?: number | null;
|
|
2924
|
+
/**
|
|
2925
|
+
* Format: double
|
|
2926
|
+
* @description Only fire when sell volume in the market ≥ this value (USD).
|
|
2927
|
+
*/
|
|
2928
|
+
min_sell_volume_usd?: number | null;
|
|
2929
|
+
/** @description Restrict to these PnL windows. */
|
|
2930
|
+
timeframes?: components["schemas"]["PnlFilterTimeframe"][] | null;
|
|
2931
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
2932
|
+
exclude_shortterm_markets?: boolean | null;
|
|
2933
|
+
};
|
|
2934
|
+
/** @description Subscription filters for the `trader_new_market` event. All fields are optional. */
|
|
2935
|
+
TraderNewMarketFilters: {
|
|
2936
|
+
/** @description Only fire for these wallet addresses (lowercase). Empty = all traders. */
|
|
2937
|
+
wallet_addresses?: string[] | null;
|
|
2938
|
+
/** @description Restrict to these markets. */
|
|
2939
|
+
condition_ids?: string[] | null;
|
|
2940
|
+
/** @description Restrict to markets belonging to these events. */
|
|
2941
|
+
event_slugs?: string[] | null;
|
|
2942
|
+
/**
|
|
2943
|
+
* Format: double
|
|
2944
|
+
* @description Minimum trade size in USD. Omit to match all sizes.
|
|
2945
|
+
*/
|
|
2946
|
+
min_usd_value?: number | null;
|
|
2947
|
+
/**
|
|
2948
|
+
* Format: double
|
|
2949
|
+
* @description Only fire when the outcome probability is ≥ this value.
|
|
2950
|
+
*/
|
|
2951
|
+
min_probability?: number | null;
|
|
2952
|
+
/**
|
|
2953
|
+
* Format: double
|
|
2954
|
+
* @description Only fire when the outcome probability is ≤ this value.
|
|
2955
|
+
*/
|
|
2956
|
+
max_probability?: number | null;
|
|
2957
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
2958
|
+
exclude_shortterm_markets?: boolean | null;
|
|
2959
|
+
};
|
|
2960
|
+
/** @description Subscription filters for the `trader_new_trade` event. All fields are optional. */
|
|
2961
|
+
TraderNewTradeFilters: {
|
|
2962
|
+
/** @description Only fire for trades by these wallet addresses. Empty = all traders. */
|
|
2963
|
+
wallet_addresses?: string[] | null;
|
|
2964
|
+
/** @description Restrict to these markets. */
|
|
2965
|
+
condition_ids?: string[] | null;
|
|
2966
|
+
/** @description Restrict to markets belonging to these events. */
|
|
2967
|
+
event_slugs?: string[] | null;
|
|
2968
|
+
/**
|
|
2969
|
+
* Format: double
|
|
2970
|
+
* @description Minimum trade size in USD. Defaults to 0 (matches all trades).
|
|
2971
|
+
* @default 0
|
|
2972
|
+
*/
|
|
2973
|
+
min_usd_value: number | null;
|
|
2974
|
+
/**
|
|
2975
|
+
* Format: double
|
|
2976
|
+
* @description Only fire when outcome probability is ≥ this value.
|
|
2977
|
+
*/
|
|
2978
|
+
min_probability?: number | null;
|
|
2979
|
+
/**
|
|
2980
|
+
* Format: double
|
|
2981
|
+
* @description Only fire when outcome probability is ≤ this value.
|
|
2982
|
+
*/
|
|
2983
|
+
max_probability?: number | null;
|
|
2984
|
+
/** @description Only fire for these fill-style trade types. Empty = OrderFilled and OrdersMatched only (default). */
|
|
2985
|
+
trade_types?: ("OrderFilled" | "OrdersMatched")[] | null;
|
|
2986
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
2987
|
+
exclude_shortterm_markets?: boolean | null;
|
|
2988
|
+
};
|
|
2989
|
+
/**
|
|
2990
|
+
* @description Subscription filters for the `trader_trade_event` event. All fields are optional.
|
|
2991
|
+
* `event_slugs` and `exclude_shortterm_markets` require explicit `trade_types` that
|
|
2992
|
+
* exclude `PositionsConverted`, because conversion events do not currently carry
|
|
2993
|
+
* `event_slug` in the typed webhook payload.
|
|
2994
|
+
*/
|
|
2995
|
+
TraderTradeEventFilters: {
|
|
2996
|
+
/** @description Only fire for events associated with these wallet addresses. Empty = all traders. */
|
|
2997
|
+
wallet_addresses?: string[] | null;
|
|
2998
|
+
/** @description Restrict to these markets. For `PositionsConverted`, this also matches the NegRisk `market_id`. */
|
|
2999
|
+
condition_ids?: string[] | null;
|
|
3000
|
+
/** @description Restrict to markets belonging to these events. Requires explicit `trade_types` that exclude `PositionsConverted`. */
|
|
3001
|
+
event_slugs?: string[] | null;
|
|
3002
|
+
/**
|
|
3003
|
+
* Format: double
|
|
3004
|
+
* @description Minimum USD amount for the underlying event. Defaults to 0 (matches all events).
|
|
3005
|
+
* @default 0
|
|
3006
|
+
*/
|
|
3007
|
+
min_usd_value: number | null;
|
|
3008
|
+
/**
|
|
3009
|
+
* Format: double
|
|
3010
|
+
* @description Only fire when event probability is ≥ this value. Events without probability data do not match.
|
|
3011
|
+
*/
|
|
3012
|
+
min_probability?: number | null;
|
|
3013
|
+
/**
|
|
3014
|
+
* Format: double
|
|
3015
|
+
* @description Only fire when event probability is ≤ this value. Events without probability data do not match.
|
|
3016
|
+
*/
|
|
3017
|
+
max_probability?: number | null;
|
|
3018
|
+
/** @description Only fire for these trade types. Empty = all supported trade-event variants. */
|
|
3019
|
+
trade_types?: ("OrderFilled" | "Redemption" | "Merge" | "Split" | "Cancelled" | "PositionsConverted" | "OrdersMatched" | "Initialization" | "Proposal" | "Dispute" | "Settled" | "Resolution" | "ConditionResolution" | "Reset" | "Flag" | "Unflag" | "Pause" | "Unpause" | "ManualResolution" | "NegRiskOutcomeReported" | "RegisterToken" | "Approval")[] | null;
|
|
3020
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets. Requires explicit `trade_types` that exclude `PositionsConverted`. Default: `false`. */
|
|
3021
|
+
exclude_shortterm_markets?: boolean | null;
|
|
3022
|
+
};
|
|
3023
|
+
/** @description Subscription filters for the `trader_whale_trade` event. All fields are optional. */
|
|
3024
|
+
TraderWhaleTradeFilters: {
|
|
3025
|
+
/** @description Only fire for trades by these wallet addresses. Empty = all traders. */
|
|
3026
|
+
wallet_addresses?: string[] | null;
|
|
3027
|
+
/** @description Restrict to these markets. */
|
|
3028
|
+
condition_ids?: string[] | null;
|
|
3029
|
+
/** @description Restrict to markets belonging to these events. */
|
|
3030
|
+
event_slugs?: string[] | null;
|
|
3031
|
+
/**
|
|
3032
|
+
* Format: double
|
|
3033
|
+
* @description Minimum trade size in USD. Defaults to 0 (matches all trades).
|
|
3034
|
+
* @default 0
|
|
3035
|
+
*/
|
|
3036
|
+
min_usd_value: number | null;
|
|
3037
|
+
/**
|
|
3038
|
+
* Format: double
|
|
3039
|
+
* @description Only fire when outcome probability is ≥ this value.
|
|
3040
|
+
*/
|
|
3041
|
+
min_probability?: number | null;
|
|
3042
|
+
/**
|
|
3043
|
+
* Format: double
|
|
3044
|
+
* @description Only fire when outcome probability is ≤ this value.
|
|
3045
|
+
*/
|
|
3046
|
+
max_probability?: number | null;
|
|
3047
|
+
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
3048
|
+
exclude_shortterm_markets?: boolean | null;
|
|
3049
|
+
};
|
|
3050
|
+
/** @description Request body for updating a webhook */
|
|
3051
|
+
UpdateWebhookRequestBody: {
|
|
3052
|
+
/** @description Destination URL for webhook deliveries (must be HTTPS) */
|
|
3053
|
+
url?: string | null;
|
|
3054
|
+
event?: null | components["schemas"]["PolymarketWebhookEvent"];
|
|
3055
|
+
/** @description New secret for HMAC signature verification */
|
|
3056
|
+
secret?: string | null;
|
|
3057
|
+
filters?: null | components["schemas"]["WebhookFiltersBody"];
|
|
3058
|
+
status?: null | components["schemas"]["WebhookStatusBody"];
|
|
3059
|
+
/** @description Description/name */
|
|
3060
|
+
description?: string | null;
|
|
3061
|
+
};
|
|
3062
|
+
/** @description Volume milestone webhook payload */
|
|
3063
|
+
VolumeMilestonePayload: {
|
|
3064
|
+
condition_id: string;
|
|
3065
|
+
timeframe: string;
|
|
3066
|
+
/**
|
|
3067
|
+
* Format: double
|
|
3068
|
+
* @description Milestone amount reached (USD)
|
|
3069
|
+
*/
|
|
3070
|
+
milestone_usd: number;
|
|
3071
|
+
/**
|
|
3072
|
+
* Format: double
|
|
3073
|
+
* @description Current volume (USD) that triggered the milestone
|
|
3074
|
+
*/
|
|
3075
|
+
current_volume_usd: number;
|
|
3076
|
+
/**
|
|
3077
|
+
* Format: double
|
|
3078
|
+
* @description Total fees collected in this timeframe
|
|
3079
|
+
*/
|
|
3080
|
+
fees: number;
|
|
3081
|
+
/**
|
|
3082
|
+
* Format: int64
|
|
3083
|
+
* @description Total transactions in this timeframe
|
|
3084
|
+
*/
|
|
3085
|
+
txns: number;
|
|
3086
|
+
};
|
|
3087
|
+
/**
|
|
3088
|
+
* @description Aggregation windows accepted by `*_volume_spike.timeframes`. Includes `1d`
|
|
3089
|
+
* in addition to the metric set.
|
|
3090
|
+
* @enum {string}
|
|
3091
|
+
*/
|
|
3092
|
+
VolumeSpikeFilterTimeframe: "1m" | "5m" | "30m" | "1h" | "6h" | "1d" | "24h" | "7d" | "30d";
|
|
3093
|
+
/**
|
|
3094
|
+
* @description Crypto asset symbols accepted by `asset_price_tick` and `asset_price_window_update` filters.
|
|
3095
|
+
* @enum {string}
|
|
3096
|
+
*/
|
|
3097
|
+
WebhookAssetSymbol: "BTC" | "ETH" | "SOL" | "XRP" | "DOGE" | "BNB" | "HYPE";
|
|
3098
|
+
/** @description Single event type entry for the events list */
|
|
3099
|
+
WebhookEventInfo: {
|
|
3100
|
+
/** @description Event type identifier (e.g. "first_trade") */
|
|
3101
|
+
event: string;
|
|
3102
|
+
/** @description Human-readable description */
|
|
3103
|
+
description: string;
|
|
3104
|
+
/**
|
|
3105
|
+
* @description Category grouping for the event type
|
|
3106
|
+
* @enum {string}
|
|
3107
|
+
*/
|
|
3108
|
+
category: "trader" | "trade" | "market" | "event" | "tag" | "position" | "assets";
|
|
3109
|
+
/**
|
|
3110
|
+
* Format: int64
|
|
3111
|
+
* @description Millicredits consumed per webhook delivery (1 credit = 1000 mc)
|
|
3112
|
+
*/
|
|
3113
|
+
millicredits_cost: number;
|
|
3114
|
+
/** @description Filter field names that apply to this event type */
|
|
3115
|
+
applicable_filters: string[];
|
|
3116
|
+
};
|
|
3117
|
+
/** @description Webhook filters request body */
|
|
3118
|
+
WebhookFiltersBody: {
|
|
3119
|
+
/** @description Filter by wallet addresses (for first_trade / new_market / whale_trade). Max 500 entries. */
|
|
3120
|
+
wallet_addresses?: string[];
|
|
3121
|
+
/** @description Filter by trader addresses (for PnL webhooks). Max 500 entries. */
|
|
3122
|
+
traders?: string[];
|
|
3123
|
+
/** @description Filter by market/condition IDs. Max 500 entries. */
|
|
3124
|
+
condition_ids?: string[];
|
|
3125
|
+
/** @description Filter by position IDs (for position metrics / close_to_bond). Max 500 entries. */
|
|
3126
|
+
position_ids?: string[];
|
|
3127
|
+
/** @description Filter by event slugs. Max 500 entries. */
|
|
3128
|
+
event_slugs?: string[];
|
|
3129
|
+
/** @description Filter by tags or category names (case-insensitive) — for market_created. Max 500 entries. */
|
|
3130
|
+
tags?: string[];
|
|
3131
|
+
/** @description Filter by outcomes (e.g. "Yes", "No") — for position metrics / close_to_bond. Max 500 entries. */
|
|
3132
|
+
outcomes?: string[];
|
|
3133
|
+
/** @description Filter by position outcome index — for close_to_bond. Position 0 = Yes/Up, 1 = No. Max 500 entries. */
|
|
3134
|
+
position_outcome_indices?: number[];
|
|
3135
|
+
/** @description Filter by trade type — for `trader_new_trade` and `trader_trade_event`. Max 500 entries. */
|
|
3136
|
+
trade_types?: string[];
|
|
3137
|
+
/**
|
|
3138
|
+
* Format: double
|
|
3139
|
+
* @description Minimum USD trade size (for whale_trade / first_trade)
|
|
3140
|
+
*/
|
|
3141
|
+
min_usd_value?: number | null;
|
|
3142
|
+
/**
|
|
3143
|
+
* Format: double
|
|
3144
|
+
* @description Minimum probability threshold (0.0 - 1.0)
|
|
3145
|
+
*/
|
|
3146
|
+
min_probability?: number | null;
|
|
3147
|
+
/**
|
|
3148
|
+
* Format: double
|
|
3149
|
+
* @description Maximum probability threshold (0.0 - 1.0)
|
|
3150
|
+
*/
|
|
3151
|
+
max_probability?: number | null;
|
|
2187
3152
|
/**
|
|
2188
3153
|
* Format: double
|
|
2189
3154
|
* @description Minimum realized PnL (USD) — for global_pnl / market_pnl / event_pnl
|
|
@@ -2367,7 +3332,10 @@ export interface components {
|
|
|
2367
3332
|
condition_id?: string | null;
|
|
2368
3333
|
/** @description Outcome name (e.g. "Yes", "No") */
|
|
2369
3334
|
outcome?: string | null;
|
|
2370
|
-
/**
|
|
3335
|
+
/**
|
|
3336
|
+
* Format: int32
|
|
3337
|
+
* @description Outcome index: 0 = Yes/Up, 1 = No
|
|
3338
|
+
*/
|
|
2371
3339
|
outcome_index?: number | null;
|
|
2372
3340
|
/** @description Market question text */
|
|
2373
3341
|
question?: string | null;
|
|
@@ -2375,6 +3343,8 @@ export interface components {
|
|
|
2375
3343
|
market_slug?: string | null;
|
|
2376
3344
|
/** @description Parent event slug */
|
|
2377
3345
|
event_slug?: string | null;
|
|
3346
|
+
/** @description Market image URL */
|
|
3347
|
+
image_url?: string | null;
|
|
2378
3348
|
/** @description Unique trade identifier */
|
|
2379
3349
|
trade_id: string;
|
|
2380
3350
|
/** @description Transaction hash */
|
|
@@ -2389,30 +3359,36 @@ export interface components {
|
|
|
2389
3359
|
* @description Block confirmation timestamp (Unix seconds)
|
|
2390
3360
|
*/
|
|
2391
3361
|
confirmed_at: number;
|
|
2392
|
-
/**
|
|
3362
|
+
/**
|
|
3363
|
+
* Format: double
|
|
3364
|
+
* @description USD size of the trade (6 decimal places)
|
|
3365
|
+
*/
|
|
2393
3366
|
amount_usd: number;
|
|
2394
|
-
/**
|
|
3367
|
+
/**
|
|
3368
|
+
* Format: double
|
|
3369
|
+
* @description Outcome shares traded (6 decimal places)
|
|
3370
|
+
*/
|
|
2395
3371
|
shares_amount: number;
|
|
2396
|
-
/** @description Fee paid in USD (6 decimal places) */
|
|
2397
|
-
fee: number;
|
|
2398
3372
|
/**
|
|
2399
|
-
*
|
|
2400
|
-
* @
|
|
3373
|
+
* Format: double
|
|
3374
|
+
* @description Fee paid in USD (6 decimal places)
|
|
2401
3375
|
*/
|
|
3376
|
+
fee: number;
|
|
3377
|
+
/** @description Trade direction */
|
|
2402
3378
|
side: "Buy" | "Sell";
|
|
2403
|
-
/** @description Outcome token price (0.0–1.0) */
|
|
2404
|
-
price: number;
|
|
2405
|
-
/** @description Implied probability (0.0–1.0); null when outcome is unknown */
|
|
2406
|
-
probability?: number | null;
|
|
2407
3379
|
/**
|
|
2408
|
-
*
|
|
2409
|
-
* @
|
|
3380
|
+
* Format: double
|
|
3381
|
+
* @description Outcome token price (0.0–1.0)
|
|
2410
3382
|
*/
|
|
2411
|
-
|
|
3383
|
+
price: number;
|
|
2412
3384
|
/**
|
|
2413
|
-
*
|
|
2414
|
-
* @
|
|
3385
|
+
* Format: double
|
|
3386
|
+
* @description Implied probability (0.0–1.0); null when outcome is unknown
|
|
2415
3387
|
*/
|
|
3388
|
+
probability?: number | null;
|
|
3389
|
+
/** @description Exchange contract that processed the trade */
|
|
3390
|
+
exchange: "CTFExchange" | "NegRiskExchange" | "ConditionalTokens" | "NegRiskAdapter" | "CTFExchangeV2" | "NegRiskExchangeV2" | "Unknown";
|
|
3391
|
+
/** @description Trade type (webhook events only fire on order fills) */
|
|
2416
3392
|
trade_type: "OrderFilled" | "OrdersMatched";
|
|
2417
3393
|
};
|
|
2418
3394
|
/** @description Outer envelope for every webhook HTTP POST delivery. The `data` field contains the event-specific payload. Delivery headers sent with every POST: `X-Webhook-ID` (subscription UUID), `X-Delivery-ID` (this attempt's UUID), `X-Event-Type` (event name string, e.g. `trader_first_trade`), `X-Attempt` (attempt number, 1-indexed). When the webhook has a secret configured, `X-Webhook-Signature: sha256=<hmac-hex>` is also included — compute HMAC-SHA256 over the raw request body using your secret to verify. */
|
|
@@ -2466,25 +3442,70 @@ export interface components {
|
|
|
2466
3442
|
condition_id: string | null;
|
|
2467
3443
|
position_id: string;
|
|
2468
3444
|
outcome?: string;
|
|
2469
|
-
outcome_index: number | null;
|
|
3445
|
+
outcome_index: number | null;
|
|
3446
|
+
question?: string;
|
|
3447
|
+
image_url?: string;
|
|
3448
|
+
slug?: string;
|
|
3449
|
+
event_slug?: string;
|
|
3450
|
+
usd_amount: number;
|
|
3451
|
+
shares_amount: number;
|
|
3452
|
+
price: number;
|
|
3453
|
+
probability?: number;
|
|
3454
|
+
fee: number;
|
|
3455
|
+
fee_shares: number;
|
|
3456
|
+
fee_pct: number;
|
|
3457
|
+
/**
|
|
3458
|
+
* @description Exchange contract that processed the event
|
|
3459
|
+
* @enum {string}
|
|
3460
|
+
*/
|
|
3461
|
+
exchange: "CTFExchange" | "NegRiskExchange" | "ConditionalTokens" | "NegRiskAdapter" | "Unknown";
|
|
3462
|
+
/** @enum {string} */
|
|
3463
|
+
trade_type: "OrderFilled" | "OrdersMatched";
|
|
3464
|
+
} | {
|
|
3465
|
+
id: string;
|
|
3466
|
+
hash: string;
|
|
3467
|
+
/** Format: int64 */
|
|
3468
|
+
block: number;
|
|
3469
|
+
/** Format: int64 */
|
|
3470
|
+
confirmed_at: number;
|
|
3471
|
+
/** Format: int64 */
|
|
3472
|
+
log_index: number;
|
|
3473
|
+
/** Format: int64 */
|
|
3474
|
+
block_index: number;
|
|
3475
|
+
order_hash?: string;
|
|
3476
|
+
trader: {
|
|
3477
|
+
address: string;
|
|
3478
|
+
name: string | null;
|
|
3479
|
+
pseudonym: string | null;
|
|
3480
|
+
profile_image: string | null;
|
|
3481
|
+
x_username: string | null;
|
|
3482
|
+
verified_badge: boolean;
|
|
3483
|
+
};
|
|
3484
|
+
taker?: string;
|
|
3485
|
+
/** @enum {string} */
|
|
3486
|
+
side?: "Buy" | "Sell";
|
|
3487
|
+
condition_id?: string | null;
|
|
3488
|
+
position_id?: string;
|
|
3489
|
+
outcome?: string;
|
|
3490
|
+
outcome_index?: number | null;
|
|
2470
3491
|
question?: string;
|
|
2471
3492
|
image_url?: string;
|
|
2472
3493
|
slug?: string;
|
|
2473
3494
|
event_slug?: string;
|
|
2474
3495
|
usd_amount: number;
|
|
2475
|
-
shares_amount
|
|
2476
|
-
price
|
|
3496
|
+
shares_amount?: number;
|
|
3497
|
+
price?: number;
|
|
2477
3498
|
probability?: number;
|
|
2478
|
-
fee
|
|
2479
|
-
fee_shares
|
|
2480
|
-
fee_pct
|
|
3499
|
+
fee?: number;
|
|
3500
|
+
fee_shares?: number;
|
|
3501
|
+
fee_pct?: number;
|
|
2481
3502
|
/**
|
|
2482
3503
|
* @description Exchange contract that processed the event
|
|
2483
3504
|
* @enum {string}
|
|
2484
3505
|
*/
|
|
2485
3506
|
exchange: "CTFExchange" | "NegRiskExchange" | "ConditionalTokens" | "NegRiskAdapter" | "Unknown";
|
|
2486
3507
|
/** @enum {string} */
|
|
2487
|
-
trade_type: "
|
|
3508
|
+
trade_type: "MakerRebate" | "Reward" | "Yield";
|
|
2488
3509
|
} | {
|
|
2489
3510
|
id: string;
|
|
2490
3511
|
hash: string;
|
|
@@ -2789,534 +3810,99 @@ export interface components {
|
|
|
2789
3810
|
/** Format: int64 */
|
|
2790
3811
|
block_index: number;
|
|
2791
3812
|
oracle_contract: string;
|
|
2792
|
-
condition_id: string;
|
|
2793
|
-
oracle: string;
|
|
2794
|
-
proposed_outcome?: string;
|
|
2795
|
-
question?: string;
|
|
2796
|
-
image_url?: string;
|
|
2797
|
-
slug?: string;
|
|
2798
|
-
event_slug?: string;
|
|
2799
|
-
/** @enum {string} */
|
|
2800
|
-
trade_type: "ConditionResolution";
|
|
2801
|
-
} | {
|
|
2802
|
-
id: string;
|
|
2803
|
-
hash: string;
|
|
2804
|
-
/** Format: int64 */
|
|
2805
|
-
block: number;
|
|
2806
|
-
/** Format: int64 */
|
|
2807
|
-
confirmed_at: number;
|
|
2808
|
-
/** Format: int64 */
|
|
2809
|
-
log_index: number;
|
|
2810
|
-
/** Format: int64 */
|
|
2811
|
-
block_index: number;
|
|
2812
|
-
oracle_contract: string;
|
|
2813
|
-
condition_id: string;
|
|
2814
|
-
question?: string;
|
|
2815
|
-
image_url?: string;
|
|
2816
|
-
slug?: string;
|
|
2817
|
-
event_slug?: string;
|
|
2818
|
-
/** @enum {string} */
|
|
2819
|
-
trade_type: "Reset" | "Flag" | "Unflag" | "Pause" | "Unpause";
|
|
2820
|
-
} | {
|
|
2821
|
-
id: string;
|
|
2822
|
-
hash: string;
|
|
2823
|
-
/** Format: int64 */
|
|
2824
|
-
block: number;
|
|
2825
|
-
/** Format: int64 */
|
|
2826
|
-
confirmed_at: number;
|
|
2827
|
-
/** Format: int64 */
|
|
2828
|
-
log_index: number;
|
|
2829
|
-
/** Format: int64 */
|
|
2830
|
-
block_index: number;
|
|
2831
|
-
oracle_contract: string;
|
|
2832
|
-
condition_id: string;
|
|
2833
|
-
proposed_outcome?: string;
|
|
2834
|
-
question?: string;
|
|
2835
|
-
image_url?: string;
|
|
2836
|
-
slug?: string;
|
|
2837
|
-
event_slug?: string;
|
|
2838
|
-
/** @enum {string} */
|
|
2839
|
-
trade_type: "ManualResolution";
|
|
2840
|
-
} | {
|
|
2841
|
-
id: string;
|
|
2842
|
-
hash: string;
|
|
2843
|
-
/** Format: int64 */
|
|
2844
|
-
block: number;
|
|
2845
|
-
/** Format: int64 */
|
|
2846
|
-
confirmed_at: number;
|
|
2847
|
-
/** Format: int64 */
|
|
2848
|
-
log_index: number;
|
|
2849
|
-
/** Format: int64 */
|
|
2850
|
-
block_index: number;
|
|
2851
|
-
oracle_contract: string;
|
|
2852
|
-
condition_id: string;
|
|
2853
|
-
proposed_outcome?: string;
|
|
2854
|
-
question?: string;
|
|
2855
|
-
image_url?: string;
|
|
2856
|
-
slug?: string;
|
|
2857
|
-
event_slug?: string;
|
|
2858
|
-
/** @enum {string} */
|
|
2859
|
-
trade_type: "NegRiskOutcomeReported";
|
|
2860
|
-
} | {
|
|
2861
|
-
id: string;
|
|
2862
|
-
hash: string;
|
|
2863
|
-
/** Format: int64 */
|
|
2864
|
-
block: number;
|
|
2865
|
-
/** Format: int64 */
|
|
2866
|
-
confirmed_at: number;
|
|
2867
|
-
/** Format: int64 */
|
|
2868
|
-
log_index: number;
|
|
2869
|
-
/** Format: int64 */
|
|
2870
|
-
block_index: number;
|
|
2871
|
-
condition_id: string;
|
|
2872
|
-
token0: string;
|
|
2873
|
-
token1: string;
|
|
2874
|
-
question?: string;
|
|
2875
|
-
image_url?: string;
|
|
2876
|
-
slug?: string;
|
|
2877
|
-
event_slug?: string;
|
|
2878
|
-
/**
|
|
2879
|
-
* @description Exchange contract that processed the event
|
|
2880
|
-
* @enum {string}
|
|
2881
|
-
*/
|
|
2882
|
-
exchange: "CTFExchange" | "NegRiskExchange" | "ConditionalTokens" | "NegRiskAdapter" | "Unknown";
|
|
2883
|
-
/** @enum {string} */
|
|
2884
|
-
trade_type: "RegisterToken";
|
|
2885
|
-
} | {
|
|
2886
|
-
id: string;
|
|
2887
|
-
hash: string;
|
|
2888
|
-
/** Format: int64 */
|
|
2889
|
-
block: number;
|
|
2890
|
-
/** Format: int64 */
|
|
2891
|
-
confirmed_at: number;
|
|
2892
|
-
/** Format: int64 */
|
|
2893
|
-
log_index: number;
|
|
2894
|
-
/** Format: int64 */
|
|
2895
|
-
block_index: number;
|
|
2896
|
-
trader: {
|
|
2897
|
-
address: string;
|
|
2898
|
-
name: string | null;
|
|
2899
|
-
pseudonym: string | null;
|
|
2900
|
-
profile_image: string | null;
|
|
2901
|
-
x_username: string | null;
|
|
2902
|
-
verified_badge: boolean;
|
|
2903
|
-
};
|
|
2904
|
-
operator: string;
|
|
2905
|
-
approved: boolean;
|
|
2906
|
-
question?: string;
|
|
2907
|
-
image_url?: string;
|
|
2908
|
-
slug?: string;
|
|
2909
|
-
event_slug?: string;
|
|
2910
|
-
/**
|
|
2911
|
-
* @description Exchange contract that processed the event
|
|
2912
|
-
* @enum {string}
|
|
2913
|
-
*/
|
|
2914
|
-
exchange: "CTFExchange" | "NegRiskExchange" | "ConditionalTokens" | "NegRiskAdapter" | "Unknown";
|
|
2915
|
-
/** @enum {string} */
|
|
2916
|
-
trade_type: "Approval";
|
|
2917
|
-
};
|
|
2918
|
-
/** @description Subscription filters for the `trader_first_trade` event. All fields are optional. */
|
|
2919
|
-
TraderFirstTradeFilters: {
|
|
2920
|
-
/** @description Only fire for trades by these wallet addresses (lowercase). Empty = all traders. */
|
|
2921
|
-
wallet_addresses?: string[];
|
|
2922
|
-
/** @description Restrict to trades in these markets. Empty = all markets. */
|
|
2923
|
-
condition_ids?: string[];
|
|
2924
|
-
/** @description Restrict to trades in markets belonging to these events. */
|
|
2925
|
-
event_slugs?: string[];
|
|
2926
|
-
/** @description Minimum trade size in USD. Omit to match all sizes. */
|
|
2927
|
-
min_usd_value?: number;
|
|
2928
|
-
/** @description Only fire when the outcome probability is ≥ this value. */
|
|
2929
|
-
min_probability?: number;
|
|
2930
|
-
/** @description Only fire when the outcome probability is ≤ this value. */
|
|
2931
|
-
max_probability?: number;
|
|
2932
|
-
/** @description When `true`, suppress webhooks for short-term "updown" markets (event slugs containing `updown`). Default: `false`. */
|
|
2933
|
-
exclude_shortterm_markets?: boolean;
|
|
2934
|
-
};
|
|
2935
|
-
/** @description Subscription filters for the `trader_new_market` event. All fields are optional. */
|
|
2936
|
-
TraderNewMarketFilters: {
|
|
2937
|
-
/** @description Only fire for these wallet addresses (lowercase). Empty = all traders. */
|
|
2938
|
-
wallet_addresses?: string[];
|
|
2939
|
-
/** @description Restrict to these markets. */
|
|
2940
|
-
condition_ids?: string[];
|
|
2941
|
-
/** @description Restrict to markets belonging to these events. */
|
|
2942
|
-
event_slugs?: string[];
|
|
2943
|
-
/** @description Minimum trade size in USD. Omit to match all sizes. */
|
|
2944
|
-
min_usd_value?: number;
|
|
2945
|
-
/** @description Only fire when the outcome probability is ≥ this value. */
|
|
2946
|
-
min_probability?: number;
|
|
2947
|
-
/** @description Only fire when the outcome probability is ≤ this value. */
|
|
2948
|
-
max_probability?: number;
|
|
2949
|
-
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
2950
|
-
exclude_shortterm_markets?: boolean;
|
|
2951
|
-
};
|
|
2952
|
-
/** @description Subscription filters for the `trader_whale_trade` event. All fields are optional. */
|
|
2953
|
-
TraderWhaleTradeFilters: {
|
|
2954
|
-
/** @description Only fire for trades by these wallet addresses. Empty = all traders. */
|
|
2955
|
-
wallet_addresses?: string[];
|
|
2956
|
-
/** @description Restrict to these markets. */
|
|
2957
|
-
condition_ids?: string[];
|
|
2958
|
-
/** @description Restrict to markets belonging to these events. */
|
|
2959
|
-
event_slugs?: string[];
|
|
2960
|
-
/**
|
|
2961
|
-
* @description Minimum trade size in USD. Defaults to 0 (matches all trades).
|
|
2962
|
-
* @default 0
|
|
2963
|
-
*/
|
|
2964
|
-
min_usd_value: number;
|
|
2965
|
-
/** @description Only fire when outcome probability is ≥ this value. */
|
|
2966
|
-
min_probability?: number;
|
|
2967
|
-
/** @description Only fire when outcome probability is ≤ this value. */
|
|
2968
|
-
max_probability?: number;
|
|
2969
|
-
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
2970
|
-
exclude_shortterm_markets?: boolean;
|
|
2971
|
-
};
|
|
2972
|
-
/** @description Subscription filters for the `trader_new_trade` event. All fields are optional. */
|
|
2973
|
-
TraderNewTradeFilters: {
|
|
2974
|
-
/** @description Only fire for trades by these wallet addresses. Empty = all traders. */
|
|
2975
|
-
wallet_addresses?: string[];
|
|
2976
|
-
/** @description Restrict to these markets. */
|
|
2977
|
-
condition_ids?: string[];
|
|
2978
|
-
/** @description Restrict to markets belonging to these events. */
|
|
2979
|
-
event_slugs?: string[];
|
|
2980
|
-
/**
|
|
2981
|
-
* @description Minimum trade size in USD. Defaults to 0 (matches all trades).
|
|
2982
|
-
* @default 0
|
|
2983
|
-
*/
|
|
2984
|
-
min_usd_value: number;
|
|
2985
|
-
/** @description Only fire when outcome probability is ≥ this value. */
|
|
2986
|
-
min_probability?: number;
|
|
2987
|
-
/** @description Only fire when outcome probability is ≤ this value. */
|
|
2988
|
-
max_probability?: number;
|
|
2989
|
-
/** @description Only fire for these fill-style trade types. Empty = OrderFilled and OrdersMatched only (default). */
|
|
2990
|
-
trade_types?: ("OrderFilled" | "OrdersMatched")[];
|
|
2991
|
-
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
2992
|
-
exclude_shortterm_markets?: boolean;
|
|
2993
|
-
};
|
|
2994
|
-
/** @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. */
|
|
2995
|
-
TraderTradeEventFilters: {
|
|
2996
|
-
/** @description Only fire for events associated with these wallet addresses. Empty = all traders. */
|
|
2997
|
-
wallet_addresses?: string[];
|
|
2998
|
-
/** @description Restrict to these markets. For `PositionsConverted`, this also matches the NegRisk `market_id`. */
|
|
2999
|
-
condition_ids?: string[];
|
|
3000
|
-
/** @description Restrict to markets belonging to these events. Requires explicit `trade_types` that exclude `PositionsConverted`. */
|
|
3001
|
-
event_slugs?: string[];
|
|
3002
|
-
/**
|
|
3003
|
-
* @description Minimum USD amount for the underlying event. Defaults to 0 (matches all events).
|
|
3004
|
-
* @default 0
|
|
3005
|
-
*/
|
|
3006
|
-
min_usd_value: number;
|
|
3007
|
-
/** @description Only fire when event probability is ≥ this value. Events without probability data do not match. */
|
|
3008
|
-
min_probability?: number;
|
|
3009
|
-
/** @description Only fire when event probability is ≤ this value. Events without probability data do not match. */
|
|
3010
|
-
max_probability?: number;
|
|
3011
|
-
/** @description Only fire for these trade types. Empty = all supported trade-event variants. */
|
|
3012
|
-
trade_types?: ("OrderFilled" | "Redemption" | "Merge" | "Split" | "Cancelled" | "PositionsConverted" | "OrdersMatched" | "Initialization" | "Proposal" | "Dispute" | "Settled" | "Resolution" | "ConditionResolution" | "Reset" | "Flag" | "Unflag" | "Pause" | "Unpause" | "ManualResolution" | "NegRiskOutcomeReported" | "RegisterToken" | "Approval")[];
|
|
3013
|
-
/** @description When `true`, suppress webhooks for short-term "updown" markets. Requires explicit `trade_types` that exclude `PositionsConverted`. Default: `false`. */
|
|
3014
|
-
exclude_shortterm_markets?: boolean;
|
|
3015
|
-
};
|
|
3016
|
-
/** @description Subscription filters for the `trader_global_pnl` event. All fields are optional. */
|
|
3017
|
-
TraderGlobalPnlFilters: {
|
|
3018
|
-
/** @description Track only these trader wallet addresses. Empty = all traders. */
|
|
3019
|
-
traders?: string[];
|
|
3020
|
-
/** @description Only fire when realized PnL ≥ this value (USD). Use negative values for loss thresholds. */
|
|
3021
|
-
min_realized_pnl_usd?: number;
|
|
3022
|
-
/** @description Only fire when realized PnL ≤ this value (USD). */
|
|
3023
|
-
max_realized_pnl_usd?: number;
|
|
3024
|
-
/** @description Only fire when total trading volume ≥ this value (USD). */
|
|
3025
|
-
min_volume_usd?: number;
|
|
3026
|
-
/** @description Only fire when total trading volume ≤ this value (USD). */
|
|
3027
|
-
max_volume_usd?: number;
|
|
3028
|
-
/** @description Only fire when buy volume ≥ this value (USD). */
|
|
3029
|
-
min_buy_usd?: number;
|
|
3030
|
-
/** @description Only fire when sell volume ≥ this value (USD). */
|
|
3031
|
-
min_sell_volume_usd?: number;
|
|
3032
|
-
/** @description Only fire when market win rate ≥ this percentage (0.0–100.0). */
|
|
3033
|
-
min_win_rate?: number;
|
|
3034
|
-
/**
|
|
3035
|
-
* Format: int64
|
|
3036
|
-
* @description Only fire when the trader has traded in ≥ this many markets.
|
|
3037
|
-
*/
|
|
3038
|
-
min_markets_traded?: number;
|
|
3039
|
-
/** @description Restrict to these PnL windows. Empty = all windows. */
|
|
3040
|
-
timeframes?: ("1d" | "7d" | "30d" | "lifetime")[];
|
|
3041
|
-
};
|
|
3042
|
-
/** @description Subscription filters for the `trader_market_pnl` event. All fields are optional. */
|
|
3043
|
-
TraderMarketPnlFilters: {
|
|
3044
|
-
/** @description Track only these trader wallet addresses. */
|
|
3045
|
-
traders?: string[];
|
|
3046
|
-
/** @description Restrict to these markets. */
|
|
3047
|
-
condition_ids?: string[];
|
|
3048
|
-
/** @description Restrict to markets in these events. */
|
|
3049
|
-
event_slugs?: string[];
|
|
3050
|
-
/** @description Only fire when per-market realized PnL ≥ this value (USD). */
|
|
3051
|
-
min_realized_pnl_usd?: number;
|
|
3052
|
-
/** @description Only fire when per-market realized PnL ≤ this value (USD). */
|
|
3053
|
-
max_realized_pnl_usd?: number;
|
|
3054
|
-
/** @description Only fire when total volume (buy + sell + redemption + merge) ≥ this value (USD). */
|
|
3055
|
-
min_volume_usd?: number;
|
|
3056
|
-
/** @description Only fire when total volume ≤ this value (USD). */
|
|
3057
|
-
max_volume_usd?: number;
|
|
3058
|
-
/** @description Only fire when buy volume in the market ≥ this value (USD). */
|
|
3059
|
-
min_buy_usd?: number;
|
|
3060
|
-
/** @description Only fire when sell volume in the market ≥ this value (USD). */
|
|
3061
|
-
min_sell_volume_usd?: number;
|
|
3062
|
-
/** @description Restrict to these PnL windows. */
|
|
3063
|
-
timeframes?: ("1d" | "7d" | "30d" | "lifetime")[];
|
|
3064
|
-
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
3065
|
-
exclude_shortterm_markets?: boolean;
|
|
3066
|
-
};
|
|
3067
|
-
/** @description Subscription filters for the `trader_event_pnl` event. All fields are optional. */
|
|
3068
|
-
TraderEventPnlFilters: {
|
|
3069
|
-
/** @description Track only these trader wallet addresses. */
|
|
3070
|
-
traders?: string[];
|
|
3071
|
-
/** @description Restrict to these events. */
|
|
3072
|
-
event_slugs?: string[];
|
|
3073
|
-
/** @description Only fire when per-event realized PnL ≥ this value (USD). */
|
|
3074
|
-
min_realized_pnl_usd?: number;
|
|
3075
|
-
/** @description Only fire when per-event realized PnL ≤ this value (USD). */
|
|
3076
|
-
max_realized_pnl_usd?: number;
|
|
3077
|
-
/** @description Only fire when total event volume ≥ this value (USD). */
|
|
3078
|
-
min_volume_usd?: number;
|
|
3079
|
-
/** @description Only fire when total event volume ≤ this value (USD). */
|
|
3080
|
-
max_volume_usd?: number;
|
|
3081
|
-
/** @description Only fire when buy volume within the event ≥ this value (USD). */
|
|
3082
|
-
min_buy_usd?: number;
|
|
3083
|
-
/** @description Only fire when sell volume within the event ≥ this value (USD). */
|
|
3084
|
-
min_sell_volume_usd?: number;
|
|
3085
|
-
/**
|
|
3086
|
-
* Format: int64
|
|
3087
|
-
* @description Only fire when the trader has traded in ≥ this many markets within the event.
|
|
3088
|
-
*/
|
|
3089
|
-
min_markets_traded?: number;
|
|
3090
|
-
/** @description Restrict to these PnL windows. */
|
|
3091
|
-
timeframes?: ("1d" | "7d" | "30d" | "lifetime")[];
|
|
3092
|
-
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
3093
|
-
exclude_shortterm_markets?: boolean;
|
|
3094
|
-
};
|
|
3095
|
-
/** @description Subscription filters for the `condition_metrics` event. All fields are optional. */
|
|
3096
|
-
MarketMetricsFilters: {
|
|
3097
|
-
/** @description Restrict to these markets. Empty = all markets. */
|
|
3098
|
-
condition_ids?: string[];
|
|
3099
|
-
/** @description Restrict to these aggregation windows. Empty = all windows. */
|
|
3100
|
-
timeframes?: ("1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d")[];
|
|
3101
|
-
/** @description Only fire when volume ≥ this value (USD). */
|
|
3102
|
-
min_volume_usd?: number;
|
|
3103
|
-
/** @description Only fire when volume ≤ this value (USD). */
|
|
3104
|
-
max_volume_usd?: number;
|
|
3105
|
-
/**
|
|
3106
|
-
* Format: int64
|
|
3107
|
-
* @description Only fire when transaction count ≥ this value.
|
|
3108
|
-
*/
|
|
3109
|
-
min_txns?: number;
|
|
3110
|
-
/**
|
|
3111
|
-
* Format: int64
|
|
3112
|
-
* @description Only fire when unique trader count ≥ this value.
|
|
3113
|
-
*/
|
|
3114
|
-
min_unique_traders?: number;
|
|
3115
|
-
/** @description Only fire when total fees ≥ this value (USD). */
|
|
3116
|
-
min_fees?: number;
|
|
3117
|
-
};
|
|
3118
|
-
/** @description Subscription filters for the `event_metrics` event. All fields are optional. */
|
|
3119
|
-
EventMetricsFilters: {
|
|
3120
|
-
/** @description Restrict to these events. Empty = all events. */
|
|
3121
|
-
event_slugs?: string[];
|
|
3122
|
-
/** @description Restrict to these aggregation windows. */
|
|
3123
|
-
timeframes?: ("1m" | "5m" | "30m" | "1h" | "6h" | "24h" | "7d" | "30d")[];
|
|
3124
|
-
/** @description Only fire when aggregated event volume ≥ this value (USD). */
|
|
3125
|
-
min_volume_usd?: number;
|
|
3126
|
-
max_volume_usd?: number;
|
|
3813
|
+
condition_id: string;
|
|
3814
|
+
oracle: string;
|
|
3815
|
+
proposed_outcome?: string;
|
|
3816
|
+
question?: string;
|
|
3817
|
+
image_url?: string;
|
|
3818
|
+
slug?: string;
|
|
3819
|
+
event_slug?: string;
|
|
3820
|
+
/** @enum {string} */
|
|
3821
|
+
trade_type: "ConditionResolution";
|
|
3822
|
+
} | {
|
|
3823
|
+
id: string;
|
|
3824
|
+
hash: string;
|
|
3127
3825
|
/** Format: int64 */
|
|
3128
|
-
|
|
3826
|
+
block: number;
|
|
3129
3827
|
/** Format: int64 */
|
|
3130
|
-
|
|
3131
|
-
|
|
3132
|
-
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3136
|
-
|
|
3137
|
-
|
|
3138
|
-
|
|
3139
|
-
|
|
3140
|
-
|
|
3141
|
-
/** @
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
|
|
3147
|
-
|
|
3148
|
-
|
|
3149
|
-
|
|
3150
|
-
/** Format: int64 */
|
|
3151
|
-
|
|
3152
|
-
/** Format: int64 */
|
|
3153
|
-
|
|
3154
|
-
|
|
3155
|
-
|
|
3156
|
-
|
|
3157
|
-
|
|
3158
|
-
|
|
3159
|
-
|
|
3160
|
-
|
|
3161
|
-
|
|
3162
|
-
|
|
3163
|
-
|
|
3164
|
-
|
|
3165
|
-
|
|
3166
|
-
/**
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
|
-
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
|
|
3174
|
-
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
|
|
3182
|
-
|
|
3183
|
-
|
|
3184
|
-
|
|
3185
|
-
|
|
3186
|
-
/**
|
|
3187
|
-
|
|
3188
|
-
/**
|
|
3189
|
-
|
|
3190
|
-
|
|
3191
|
-
|
|
3192
|
-
|
|
3193
|
-
|
|
3194
|
-
|
|
3195
|
-
|
|
3196
|
-
|
|
3197
|
-
|
|
3198
|
-
|
|
3199
|
-
|
|
3200
|
-
|
|
3201
|
-
/** @description Minimum probability percentage move to trigger (e.g. `10` for a 10% move). */
|
|
3202
|
-
min_probability_change_pct?: number;
|
|
3203
|
-
/**
|
|
3204
|
-
* @description `"up"` = probability rising only (default when omitted), `"down"` = falling only, `"both"` = either direction.
|
|
3205
|
-
* @enum {string}
|
|
3206
|
-
*/
|
|
3207
|
-
spike_direction?: "up" | "down" | "both";
|
|
3208
|
-
/** @description Observation window in seconds. The first trade in each window sets the reference price; subsequent trades are compared to it. E.g. `60` detects moves that occur within 60 seconds. */
|
|
3209
|
-
window_secs?: number;
|
|
3210
|
-
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
3211
|
-
exclude_shortterm_markets?: boolean;
|
|
3212
|
-
};
|
|
3213
|
-
/** @description Subscription filters for the `price_spike` event. */
|
|
3214
|
-
PriceSpikeFilters: {
|
|
3215
|
-
/** @description Restrict to specific outcome token IDs. Empty = all positions. */
|
|
3216
|
-
position_ids?: string[];
|
|
3217
|
-
/** @description Restrict to specific market condition IDs. Empty = all markets. */
|
|
3218
|
-
condition_ids?: string[];
|
|
3219
|
-
/** @description Restrict to specific events. Empty = all events. */
|
|
3220
|
-
event_slugs?: string[];
|
|
3221
|
-
/** @description Restrict to these outcome names (e.g. ["Yes", "No"]). */
|
|
3222
|
-
outcomes?: string[];
|
|
3223
|
-
/** @description Minimum price percentage move to trigger (e.g. `10` for a 10% move). */
|
|
3224
|
-
min_price_change_pct?: number;
|
|
3828
|
+
confirmed_at: number;
|
|
3829
|
+
/** Format: int64 */
|
|
3830
|
+
log_index: number;
|
|
3831
|
+
/** Format: int64 */
|
|
3832
|
+
block_index: number;
|
|
3833
|
+
oracle_contract: string;
|
|
3834
|
+
condition_id: string;
|
|
3835
|
+
question?: string;
|
|
3836
|
+
image_url?: string;
|
|
3837
|
+
slug?: string;
|
|
3838
|
+
event_slug?: string;
|
|
3839
|
+
/** @enum {string} */
|
|
3840
|
+
trade_type: "Reset" | "Flag" | "Unflag" | "Pause" | "Unpause";
|
|
3841
|
+
} | {
|
|
3842
|
+
id: string;
|
|
3843
|
+
hash: string;
|
|
3844
|
+
/** Format: int64 */
|
|
3845
|
+
block: number;
|
|
3846
|
+
/** Format: int64 */
|
|
3847
|
+
confirmed_at: number;
|
|
3848
|
+
/** Format: int64 */
|
|
3849
|
+
log_index: number;
|
|
3850
|
+
/** Format: int64 */
|
|
3851
|
+
block_index: number;
|
|
3852
|
+
oracle_contract: string;
|
|
3853
|
+
condition_id: string;
|
|
3854
|
+
proposed_outcome?: string;
|
|
3855
|
+
question?: string;
|
|
3856
|
+
image_url?: string;
|
|
3857
|
+
slug?: string;
|
|
3858
|
+
event_slug?: string;
|
|
3859
|
+
/** @enum {string} */
|
|
3860
|
+
trade_type: "ManualResolution";
|
|
3861
|
+
} | {
|
|
3862
|
+
id: string;
|
|
3863
|
+
hash: string;
|
|
3864
|
+
/** Format: int64 */
|
|
3865
|
+
block: number;
|
|
3866
|
+
/** Format: int64 */
|
|
3867
|
+
confirmed_at: number;
|
|
3868
|
+
/** Format: int64 */
|
|
3869
|
+
log_index: number;
|
|
3870
|
+
/** Format: int64 */
|
|
3871
|
+
block_index: number;
|
|
3872
|
+
oracle_contract: string;
|
|
3873
|
+
condition_id: string;
|
|
3874
|
+
proposed_outcome?: string;
|
|
3875
|
+
question?: string;
|
|
3876
|
+
image_url?: string;
|
|
3877
|
+
slug?: string;
|
|
3878
|
+
event_slug?: string;
|
|
3879
|
+
/** @enum {string} */
|
|
3880
|
+
trade_type: "NegRiskOutcomeReported";
|
|
3881
|
+
} | {
|
|
3882
|
+
id: string;
|
|
3883
|
+
hash: string;
|
|
3884
|
+
/** Format: int64 */
|
|
3885
|
+
block: number;
|
|
3886
|
+
/** Format: int64 */
|
|
3887
|
+
confirmed_at: number;
|
|
3888
|
+
/** Format: int64 */
|
|
3889
|
+
log_index: number;
|
|
3890
|
+
/** Format: int64 */
|
|
3891
|
+
block_index: number;
|
|
3892
|
+
condition_id: string;
|
|
3893
|
+
token0: string;
|
|
3894
|
+
token1: string;
|
|
3895
|
+
question?: string;
|
|
3896
|
+
image_url?: string;
|
|
3897
|
+
slug?: string;
|
|
3898
|
+
event_slug?: string;
|
|
3225
3899
|
/**
|
|
3226
|
-
* @description
|
|
3900
|
+
* @description Exchange contract that processed the event
|
|
3227
3901
|
* @enum {string}
|
|
3228
3902
|
*/
|
|
3229
|
-
|
|
3230
|
-
/** @
|
|
3231
|
-
|
|
3232
|
-
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
3233
|
-
exclude_shortterm_markets?: boolean;
|
|
3234
|
-
};
|
|
3235
|
-
/** @description Subscription filters for the `market_volume_spike` event. `spike_ratio` is required. */
|
|
3236
|
-
MarketVolumeSpikeFilters: {
|
|
3237
|
-
/** @description **Required.** Multiplier threshold (must be > 1.0). Fires when current volume >= snapshot × ratio. The snapshot is set automatically on first data and resets after each fire. */
|
|
3238
|
-
spike_ratio: number;
|
|
3239
|
-
/** @description Force snapshot reset after this many seconds (max 600 / 10 minutes). */
|
|
3240
|
-
window_secs?: number;
|
|
3241
|
-
/** @description Restrict to these markets. Empty = all markets. */
|
|
3242
|
-
condition_ids?: string[];
|
|
3243
|
-
/** @description Restrict to these aggregation windows. Empty = all windows. */
|
|
3244
|
-
timeframes?: ("1m" | "5m" | "30m" | "1h" | "6h" | "1d" | "24h" | "7d" | "30d")[];
|
|
3245
|
-
};
|
|
3246
|
-
/** @description Subscription filters for the `event_volume_spike` event. `spike_ratio` is required. */
|
|
3247
|
-
EventVolumeSpikeFilters: {
|
|
3248
|
-
/** @description **Required.** Multiplier threshold (must be > 1.0). Fires when current volume >= snapshot × ratio. */
|
|
3249
|
-
spike_ratio: number;
|
|
3250
|
-
/** @description Force snapshot reset after this many seconds (max 600 / 10 minutes). */
|
|
3251
|
-
window_secs?: number;
|
|
3252
|
-
/** @description Restrict to these events. */
|
|
3253
|
-
event_slugs?: string[];
|
|
3254
|
-
/** @description Restrict to these aggregation windows. */
|
|
3255
|
-
timeframes?: ("1m" | "5m" | "30m" | "1h" | "6h" | "1d" | "24h" | "7d" | "30d")[];
|
|
3256
|
-
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
3257
|
-
exclude_shortterm_markets?: boolean;
|
|
3258
|
-
};
|
|
3259
|
-
/** @description Subscription filters for the `position_volume_spike` event. `spike_ratio` is required. */
|
|
3260
|
-
PositionVolumeSpikeFilters: {
|
|
3261
|
-
/** @description **Required.** Multiplier threshold (must be > 1.0). Fires when current volume >= snapshot × ratio. */
|
|
3262
|
-
spike_ratio: number;
|
|
3263
|
-
/** @description Force snapshot reset after this many seconds (max 600 / 10 minutes). */
|
|
3264
|
-
window_secs?: number;
|
|
3265
|
-
/** @description Restrict to these outcome token IDs. */
|
|
3266
|
-
position_ids?: string[];
|
|
3267
|
-
/** @description Restrict to positions within these markets. */
|
|
3268
|
-
condition_ids?: string[];
|
|
3269
|
-
/** @description Restrict to these outcome names. */
|
|
3270
|
-
outcomes?: string[];
|
|
3271
|
-
/** @description Restrict to these aggregation windows. */
|
|
3272
|
-
timeframes?: ("1m" | "5m" | "30m" | "1h" | "6h" | "1d" | "24h" | "7d" | "30d")[];
|
|
3273
|
-
};
|
|
3274
|
-
/** @description Subscription filters for the `close_to_bond` event. At least one of `min_probability` or `max_probability` is required. */
|
|
3275
|
-
CloseToBondFilters: {
|
|
3276
|
-
/** @description Trigger when the YES outcome price is ≥ this value (e.g. 0.95 for 95% certainty). At least one of `min_probability` or `max_probability` must be set. */
|
|
3277
|
-
min_probability?: number;
|
|
3278
|
-
/** @description Trigger when the YES outcome price is ≤ this value (e.g. 0.05 for near-certain NO). */
|
|
3279
|
-
max_probability?: number;
|
|
3280
|
-
/** @description Restrict to these markets. */
|
|
3281
|
-
condition_ids?: string[];
|
|
3282
|
-
/** @description Restrict to these outcome token IDs. */
|
|
3283
|
-
position_ids?: string[];
|
|
3284
|
-
/** @description Restrict to markets in these events. */
|
|
3285
|
-
event_slugs?: string[];
|
|
3286
|
-
/** @description Restrict to these outcome names (e.g. ["Yes", "No"]). */
|
|
3287
|
-
outcomes?: string[];
|
|
3288
|
-
/** @description Restrict by outcome index. 0 = Yes/Up, 1 = No. Position 0 usually represents the Up/Yes side in binary markets. */
|
|
3289
|
-
position_outcome_indices?: number[];
|
|
3290
|
-
/** @description When `true`, suppress webhooks for short-term "updown" markets. Default: `false`. */
|
|
3291
|
-
exclude_shortterm_markets?: boolean;
|
|
3292
|
-
} | unknown | unknown;
|
|
3293
|
-
/** @description Subscription filters for the `market_created` event. All fields are optional. */
|
|
3294
|
-
MarketCreatedFilters: {
|
|
3295
|
-
/** @description Restrict to markets with these tags or category names (case-insensitive match). */
|
|
3296
|
-
tags?: string[];
|
|
3297
|
-
/** @description Restrict to markets belonging to these events. */
|
|
3298
|
-
event_slugs?: string[];
|
|
3299
|
-
/** @description When `true`, suppress webhooks for short-term "updown" markets (event slugs containing `updown`). Default: `false`. */
|
|
3300
|
-
exclude_shortterm_markets?: boolean;
|
|
3301
|
-
};
|
|
3302
|
-
/** @description Subscription filters for the `oracle_events` event. All fields are optional. */
|
|
3303
|
-
OracleEventsFilters: {
|
|
3304
|
-
/** @description Restrict to these event types (case-insensitive). Empty = all. */
|
|
3305
|
-
oracle_event_types?: ("AssertionMade" | "AssertionDisputed" | "AssertionSettled" | "RequestPrice" | "ProposePrice" | "DisputePrice" | "Settle" | "QuestionResolved" | "QuestionEmergencyResolved" | "QuestionReset" | "QuestionInitialized" | "QuestionPaused" | "QuestionUnpaused" | "QuestionFlagged" | "QuestionUnflagged" | "ConditionResolution" | "NegRiskOutcomeReported")[];
|
|
3306
|
-
/** @description Restrict to events for these condition IDs. */
|
|
3307
|
-
condition_ids?: string[];
|
|
3308
|
-
};
|
|
3309
|
-
/** @description Subscription filters for the `asset_price_tick` event. All fields are optional. */
|
|
3310
|
-
AssetPriceTickFilters: {
|
|
3311
|
-
/** @description Restrict to these crypto assets. Empty = all assets. */
|
|
3312
|
-
asset_symbols?: ("BTC" | "ETH" | "SOL" | "XRP" | "DOGE" | "BNB" | "HYPE")[];
|
|
3313
|
-
};
|
|
3314
|
-
/** @description Subscription filters for the `asset_price_window_update` event. All fields are optional. */
|
|
3315
|
-
AssetPriceWindowUpdateFilters: {
|
|
3316
|
-
/** @description Restrict to these crypto assets. Empty = all assets. */
|
|
3317
|
-
asset_symbols?: ("BTC" | "ETH" | "SOL" | "XRP" | "DOGE" | "BNB" | "HYPE")[];
|
|
3318
|
-
/** @description Restrict to these candle sizes. Empty = all sizes. */
|
|
3319
|
-
timeframes?: ("5m" | "15m" | "1h" | "4h" | "1d" | "24h")[];
|
|
3903
|
+
exchange: "CTFExchange" | "NegRiskExchange" | "ConditionalTokens" | "NegRiskAdapter" | "Unknown";
|
|
3904
|
+
/** @enum {string} */
|
|
3905
|
+
trade_type: "RegisterToken";
|
|
3320
3906
|
};
|
|
3321
3907
|
};
|
|
3322
3908
|
responses: never;
|
|
@@ -4068,6 +4654,49 @@ export interface operations {
|
|
|
4068
4654
|
};
|
|
4069
4655
|
};
|
|
4070
4656
|
};
|
|
4657
|
+
"tag-metrics": {
|
|
4658
|
+
parameters: {
|
|
4659
|
+
query?: never;
|
|
4660
|
+
header: {
|
|
4661
|
+
/** @description UUID of the webhook subscription that fired */
|
|
4662
|
+
"X-Webhook-ID": string;
|
|
4663
|
+
/** @description UUID of this specific delivery attempt (matches envelope `id` field) */
|
|
4664
|
+
"X-Delivery-ID": string;
|
|
4665
|
+
/** @description Event name string (e.g. `trader_first_trade`) */
|
|
4666
|
+
"X-Event-Type": string;
|
|
4667
|
+
/** @description Delivery attempt number (1 = first attempt) */
|
|
4668
|
+
"X-Attempt": number;
|
|
4669
|
+
/** @description HMAC-SHA256 of the raw request body: `sha256=<hex>`. Present only when the webhook has a secret configured. Verify with: HMAC-SHA256(secret, raw_body_bytes) == hex_part. */
|
|
4670
|
+
"X-Webhook-Signature"?: string;
|
|
4671
|
+
};
|
|
4672
|
+
path?: never;
|
|
4673
|
+
cookie?: never;
|
|
4674
|
+
};
|
|
4675
|
+
/** @description Webhook delivery envelope. The `data` field contains the event-specific payload. */
|
|
4676
|
+
requestBody: {
|
|
4677
|
+
content: {
|
|
4678
|
+
"application/json": components["schemas"]["WebhookDeliveryEnvelope"] & {
|
|
4679
|
+
data?: components["schemas"]["TagMetricsPayload"];
|
|
4680
|
+
};
|
|
4681
|
+
};
|
|
4682
|
+
};
|
|
4683
|
+
responses: {
|
|
4684
|
+
/** @description Webhook delivery acknowledged */
|
|
4685
|
+
200: {
|
|
4686
|
+
headers: {
|
|
4687
|
+
[name: string]: unknown;
|
|
4688
|
+
};
|
|
4689
|
+
content?: never;
|
|
4690
|
+
};
|
|
4691
|
+
/** @description Server error (will retry) */
|
|
4692
|
+
500: {
|
|
4693
|
+
headers: {
|
|
4694
|
+
[name: string]: unknown;
|
|
4695
|
+
};
|
|
4696
|
+
content?: never;
|
|
4697
|
+
};
|
|
4698
|
+
};
|
|
4699
|
+
};
|
|
4071
4700
|
"position-metrics": {
|
|
4072
4701
|
parameters: {
|
|
4073
4702
|
query?: never;
|