nansen-cli 2.2.0 → 2.4.0

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.
Files changed (78) hide show
  1. package/CHANGELOG.md +108 -0
  2. package/README.md +109 -33
  3. package/docs/auth.md +56 -0
  4. package/docs/browser-login.md +101 -7
  5. package/docs/error-codes.md +249 -0
  6. package/package.json +10 -4
  7. package/skills/nansen-agent-guide/SKILL.md +54 -1
  8. package/skills/nansen-alerts-webhook-listener/SKILL.md +1 -1
  9. package/skills/nansen-dca-tracker/SKILL.md +1 -1
  10. package/skills/nansen-defi-positions/SKILL.md +1 -1
  11. package/skills/nansen-exit-signals/SKILL.md +2 -2
  12. package/skills/nansen-fund-tracker/SKILL.md +1 -1
  13. package/skills/nansen-general-search/SKILL.md +1 -1
  14. package/skills/nansen-holder-analysis/SKILL.md +2 -2
  15. package/skills/nansen-limit-orders/SKILL.md +1 -1
  16. package/skills/nansen-mpp-payment/SKILL.md +2 -2
  17. package/skills/nansen-perp-screener/SKILL.md +1 -1
  18. package/skills/nansen-perp-trader-profile/SKILL.md +1 -1
  19. package/skills/nansen-polymarket-deep-dive/SKILL.md +1 -1
  20. package/skills/nansen-polymarket-insider-scan/SKILL.md +1 -1
  21. package/skills/nansen-polymarket-trader-profile/SKILL.md +1 -1
  22. package/skills/nansen-portfolio-tracker/SKILL.md +1 -1
  23. package/skills/nansen-prediction-markets/SKILL.md +1 -1
  24. package/skills/nansen-sm-cross-chain-flows/SKILL.md +1 -1
  25. package/skills/nansen-smart-alerts/SKILL.md +2 -1
  26. package/skills/nansen-smart-money-alpha/SKILL.md +1 -1
  27. package/skills/nansen-smart-money-tracker/SKILL.md +8 -7
  28. package/skills/nansen-smart-money-trend/SKILL.md +1 -1
  29. package/skills/nansen-token-research/SKILL.md +1 -1
  30. package/skills/nansen-token-screener/SKILL.md +1 -1
  31. package/skills/nansen-token-transfer-analysis/SKILL.md +1 -1
  32. package/skills/nansen-trading/SKILL.md +1 -1
  33. package/skills/nansen-wallet-batch/SKILL.md +1 -1
  34. package/skills/nansen-wallet-clustering/SKILL.md +1 -1
  35. package/skills/nansen-wallet-deep-dive/SKILL.md +1 -1
  36. package/skills/nansen-wallet-keychain-migration/SKILL.md +1 -1
  37. package/skills/nansen-wallet-manager/SKILL.md +1 -1
  38. package/skills/nansen-wallet-profiler/SKILL.md +1 -1
  39. package/skills/nansen-web-fetcher/SKILL.md +1 -1
  40. package/skills/nansen-web-searcher/SKILL.md +1 -1
  41. package/src/api-endpoints.json +1605 -0
  42. package/src/api.js +336 -121
  43. package/src/auth-credentials.js +1 -0
  44. package/src/auth-state.js +2 -2
  45. package/src/auth-store-native.js +6 -1
  46. package/src/auth-store-worker.js +1 -1
  47. package/src/auth-store.js +9 -4
  48. package/src/bridge.js +19 -10
  49. package/src/cli.js +258 -107
  50. package/src/commands/agent.js +2 -3
  51. package/src/commands/alerts.js +277 -9
  52. package/src/commands/completion.js +6 -1
  53. package/src/commands/feedback.js +413 -0
  54. package/src/commands/mcp.js +1 -1
  55. package/src/commands/research.js +14 -37
  56. package/src/cost-cache.js +33 -7
  57. package/src/doctor.js +14 -5
  58. package/src/error-codes.js +226 -0
  59. package/src/feedback-journal.js +86 -0
  60. package/src/input-validation.js +551 -0
  61. package/src/limit-order.js +12 -3
  62. package/src/perp.js +2 -1
  63. package/src/privy.js +144 -48
  64. package/src/query-options.js +30 -7
  65. package/src/rpc-urls.js +3 -1
  66. package/src/schema.json +1254 -150
  67. package/src/solana-tx.js +4 -0
  68. package/src/telemetry.js +5 -1
  69. package/src/trade-validation.js +190 -21
  70. package/src/trading.js +229 -129
  71. package/src/transfer.js +7 -1
  72. package/src/update-check.js +32 -5
  73. package/src/wallet.js +220 -57
  74. package/src/walletconnect-x402.js +152 -52
  75. package/src/x402-audit.js +191 -0
  76. package/src/x402-payment-balance.js +90 -0
  77. package/src/x402-policy.js +151 -4
  78. package/src/x402.js +51 -22
package/src/schema.json CHANGED
@@ -1,5 +1,175 @@
1
1
  {
2
2
  "commands": {
3
+ "feedback": {
4
+ "description": "Read the account feedback preference, submit product feedback, or recover an account-scoped receipt. Free; seven new reports per account per UTC week.",
5
+ "notes": "Use the configured API key or login session. Keep the same submission ID and unchanged report after an uncertain result. No caching or payment fallback. Remove credentials and unnecessary personal context from reports. Without --submission-id, save one private submission before sending. Resume with nansen feedback resume. Use --new for a deliberate new report after confirmation or local erasure. Pending data expires after one calendar year; feedback commands enforce cleanup. Automatic IDs require POSIX private storage and native locking; otherwise supply an explicit ID. The report file is a JSON object with required category and description. Category is one of bug, data_quality, documentation, missing_capability, usability or other; a feature request or product gap is missing_capability. Optional fields: endpoint, tool, goal, expected_behavior, observed_behavior, workaround, request_ids and client. The API rejects any other field or category with a 422, so do not add fields such as title, summary or severity. nansen feedback submit --help lists the limits. Agents: send on your own only after an authenticated read shows the account preference is enabled and host controls permit it. Otherwise show the report and ask first; a direct user request permits that report. Use nansen feedback preferences --json for a fresh account preference before each new automatic report. If the read fails, show the report and ask. Host or local-deny controls still apply. Direct lasting choices to Superapp settings. Never enable the preference automatically. Submit is noninteractive and does not verify approval. New submissions may be paused before release or during an outage. A 503 with reason feedback_admissions_paused means this attempt accepted no new report and used no weekly allowance. Tell the user feedback is unavailable and stop; do not keep retrying or ask for approval again in the same session. Preserve the ID and unchanged file for a later retry. A 403 with reason feedback_not_enabled means this account is outside rollout. Stop automatic retries; approval and saved preferences do not override it. Preserve IDs and earlier uncertain outcomes. Accepted-ID replays and receipt reads remain available during a pause.",
6
+ "subcommands": {
7
+ "submit": {
8
+ "description": "Submit a JSON report. Received means saved; human review may still be pending.",
9
+ "endpoint": "/api/v1/feedback",
10
+ "options": {
11
+ "file": {
12
+ "type": "string",
13
+ "required": true,
14
+ "description": "JSON report file. Fields and categories are listed under report."
15
+ },
16
+ "submission-id": {
17
+ "type": "string",
18
+ "required": false,
19
+ "description": "New opaque ID: 1 to 128 ASCII letters, digits, underscores or hyphens. Reuse with unchanged file on retries."
20
+ },
21
+ "json": {
22
+ "type": "boolean",
23
+ "description": "Return the standard JSON receipt or error envelope."
24
+ },
25
+ "new": {
26
+ "type": "boolean",
27
+ "description": "Deliberately start a new generated submission after confirmation or local erasure. Never replaces pending data."
28
+ }
29
+ },
30
+ "returns": [
31
+ "feedback_id",
32
+ "submission_id",
33
+ "status",
34
+ "disposition",
35
+ "received_at",
36
+ "updated_at",
37
+ "expires_at",
38
+ "replayed",
39
+ "quota"
40
+ ],
41
+ "examples": [
42
+ "nansen feedback submit --file feedback.json --json",
43
+ "nansen feedback submit --file feedback.json --submission-id report-123 --json"
44
+ ],
45
+ "report": {
46
+ "description": "JSON object in --file. Unknown fields and categories are rejected.",
47
+ "fields": {
48
+ "category": {
49
+ "required": true,
50
+ "description": "Kind of problem. A feature request or product gap is missing_capability.",
51
+ "enum": [
52
+ "bug",
53
+ "data_quality",
54
+ "documentation",
55
+ "missing_capability",
56
+ "usability",
57
+ "other"
58
+ ]
59
+ },
60
+ "description": {
61
+ "required": true,
62
+ "description": "What happened and what was needed, up to 2,000 characters."
63
+ },
64
+ "endpoint": {
65
+ "description": "API endpoint path involved, without query string or credentials, up to 256 characters."
66
+ },
67
+ "tool": {
68
+ "description": "Tool name involved, up to 256 characters."
69
+ },
70
+ "goal": {
71
+ "description": "What you were trying to do, up to 2,000 characters."
72
+ },
73
+ "expected_behavior": {
74
+ "description": "What you expected, up to 2,000 characters."
75
+ },
76
+ "observed_behavior": {
77
+ "description": "What happened instead, up to 2,000 characters."
78
+ },
79
+ "workaround": {
80
+ "description": "Any workaround used, up to 2,000 characters."
81
+ },
82
+ "request_ids": {
83
+ "description": "Array of up to 10 distinct request IDs from your own requests, each up to 128 characters."
84
+ },
85
+ "client": {
86
+ "description": "Object with name and version, up to 64 characters each. Attribution only."
87
+ }
88
+ },
89
+ "example": {
90
+ "category": "missing_capability",
91
+ "description": "I need to compare labels across 50 wallets but cannot find a bulk lookup.",
92
+ "goal": "Compare labels across a wallet list."
93
+ }
94
+ }
95
+ },
96
+ "get": {
97
+ "description": "Read the current receipt. Reviewed means triaged; closed means review complete. Neither promises a fix date.",
98
+ "endpoint": "/api/v1/feedback/{feedback_id}",
99
+ "args": [
100
+ {
101
+ "name": "feedback-id",
102
+ "required": true,
103
+ "description": "Feedback ID from a submit receipt, such as fb_01JA8Z6K2R7N4Q9V3T5W8X1Y2Z."
104
+ }
105
+ ],
106
+ "options": {
107
+ "json": {
108
+ "type": "boolean",
109
+ "description": "Return the standard JSON receipt or error envelope."
110
+ }
111
+ },
112
+ "returns": [
113
+ "feedback_id",
114
+ "submission_id",
115
+ "status",
116
+ "disposition",
117
+ "received_at",
118
+ "updated_at",
119
+ "expires_at"
120
+ ],
121
+ "examples": [
122
+ "nansen feedback get fb_123 --json"
123
+ ]
124
+ },
125
+ "resume": {
126
+ "description": "Retry the saved report and ID with the original account and API environment, or read its confirmed receipt. Does not need the original file.",
127
+ "options": {
128
+ "json": {
129
+ "type": "boolean",
130
+ "description": "Return structured output."
131
+ }
132
+ },
133
+ "examples": [
134
+ "nansen feedback resume --json"
135
+ ]
136
+ },
137
+ "forget": {
138
+ "description": "Erase local recovery data offline. Does not delete a server report or the original input file. Stops replay until a deliberate --new submission.",
139
+ "options": {
140
+ "json": {
141
+ "type": "boolean",
142
+ "description": "Return structured output."
143
+ }
144
+ },
145
+ "examples": [
146
+ "nansen feedback forget --json"
147
+ ]
148
+ },
149
+ "preferences": {
150
+ "method": "GET",
151
+ "endpoint": "/api/v1/feedback/preferences",
152
+ "description": "Read the authenticated account preference fresh, with no credits or report quota. Does not change it.",
153
+ "options": {
154
+ "json": {
155
+ "type": "boolean",
156
+ "description": "Return the standard JSON preference or error envelope."
157
+ }
158
+ },
159
+ "returns": [
160
+ "automatic_reporting",
161
+ "configured",
162
+ "version",
163
+ "updated_at",
164
+ "can_manage"
165
+ ],
166
+ "examples": [
167
+ "nansen feedback preferences",
168
+ "nansen feedback preferences --json"
169
+ ]
170
+ }
171
+ }
172
+ },
3
173
  "perp": {
4
174
  "description": "Hyperliquid perpetual trading commands",
5
175
  "subcommands": {
@@ -267,7 +437,7 @@
267
437
  "notes": "Signed locally and submitted directly to Hyperliquid. apiEndpoints lists the Nansen API routes each command reads (compliance screening, market metadata, builder-fee status)."
268
438
  },
269
439
  "bridge": {
270
- "description": "Move funds between Base and Hyperliquid",
440
+ "description": "Move funds between EVM chains and Hyperliquid",
271
441
  "notes": "Supported routes: base -> hyperliquid (deposit); hyperliquid -> base, hyperliquid -> ethereum, hyperliquid -> arbitrum (withdrawal). Any other combination is rejected. base -> hyperliquid deposits currently support USDC only — a non-USDC --from-token is rejected with INVALID_INPUT before the quote is created. Deposits broadcast an EVM transaction from the local wallet, so they require a locally signable origin chain; withdrawals sign a Hyperliquid action and never transact on the destination chain.",
272
442
  "routes": [
273
443
  {
@@ -438,9 +608,13 @@
438
608
  "wallet": {
439
609
  "type": "string",
440
610
  "required": true,
441
- "description": "Wallet address to fetch DeFi positions for"
611
+ "description": "Wallet address to fetch DeFi positions for",
612
+ "aliases": [
613
+ "address"
614
+ ]
442
615
  }
443
- }
616
+ },
617
+ "pagination": false
444
618
  }
445
619
  },
446
620
  "description": "Portfolio analytics"
@@ -455,6 +629,30 @@
455
629
  "type": "string",
456
630
  "default": "solana",
457
631
  "description": "Chain to query"
632
+ },
633
+ "chains": {
634
+ "type": "string",
635
+ "description": "Comma-separated chains; overrides --chain",
636
+ "repeatable": true
637
+ },
638
+ "filters": {
639
+ "type": "string",
640
+ "format": "json",
641
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
642
+ },
643
+ "sort": {
644
+ "type": "string",
645
+ "description": "Sort as field or field:asc|desc, sent as order_by"
646
+ },
647
+ "order-by": {
648
+ "type": "string",
649
+ "format": "json",
650
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
651
+ },
652
+ "labels": {
653
+ "type": "string",
654
+ "description": "Smart money labels to include, comma-separated or repeated; sent as filters.include_smart_money_labels",
655
+ "repeatable": true
458
656
  }
459
657
  }
460
658
  },
@@ -466,16 +664,86 @@
466
664
  "type": "string",
467
665
  "default": "solana",
468
666
  "description": "Chain to query"
667
+ },
668
+ "chains": {
669
+ "type": "string",
670
+ "description": "Comma-separated chains; overrides --chain",
671
+ "repeatable": true
672
+ },
673
+ "filters": {
674
+ "type": "string",
675
+ "format": "json",
676
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
677
+ },
678
+ "sort": {
679
+ "type": "string",
680
+ "description": "Sort as field or field:asc|desc, sent as order_by"
681
+ },
682
+ "order-by": {
683
+ "type": "string",
684
+ "format": "json",
685
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
686
+ },
687
+ "labels": {
688
+ "type": "string",
689
+ "description": "Smart money labels to include, comma-separated or repeated; sent as filters.include_smart_money_labels",
690
+ "repeatable": true
469
691
  }
470
692
  }
471
693
  },
472
694
  "perp-trades": {
473
695
  "endpoint": "/api/v1/smart-money/perp-trades",
474
- "description": "Perpetual trading on Hyperliquid"
696
+ "description": "Perpetual trading on Hyperliquid",
697
+ "options": {
698
+ "filters": {
699
+ "type": "string",
700
+ "format": "json",
701
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
702
+ },
703
+ "sort": {
704
+ "type": "string",
705
+ "description": "Sort as field or field:asc|desc, sent as order_by"
706
+ },
707
+ "order-by": {
708
+ "type": "string",
709
+ "format": "json",
710
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
711
+ },
712
+ "labels": {
713
+ "type": "string",
714
+ "description": "Smart money labels to include, comma-separated or repeated; sent as filters.include_smart_money_labels",
715
+ "repeatable": true
716
+ },
717
+ "only-new-positions": {
718
+ "type": "boolean",
719
+ "description": "Only trades that open a new position"
720
+ }
721
+ }
475
722
  },
476
723
  "dcas": {
477
724
  "endpoint": "/api/v1/smart-money/dcas",
478
- "description": "DCA strategies on Jupiter"
725
+ "description": "DCA strategies on Jupiter",
726
+ "options": {
727
+ "filters": {
728
+ "type": "string",
729
+ "format": "json",
730
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
731
+ },
732
+ "sort": {
733
+ "type": "string",
734
+ "description": "Sort as field or field:asc|desc, sent as order_by"
735
+ },
736
+ "order-by": {
737
+ "type": "string",
738
+ "format": "json",
739
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
740
+ },
741
+ "labels": {
742
+ "type": "string",
743
+ "description": "Smart money labels to include, comma-separated or repeated; sent as filters.include_smart_money_labels",
744
+ "repeatable": true
745
+ }
746
+ }
479
747
  },
480
748
  "holdings": {
481
749
  "endpoint": "/api/v1/smart-money/holdings",
@@ -485,6 +753,34 @@
485
753
  "type": "string",
486
754
  "default": "solana",
487
755
  "description": "Chain to query"
756
+ },
757
+ "chains": {
758
+ "type": "string",
759
+ "description": "Comma-separated chains; overrides --chain",
760
+ "repeatable": true
761
+ },
762
+ "filters": {
763
+ "type": "string",
764
+ "format": "json",
765
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
766
+ },
767
+ "sort": {
768
+ "type": "string",
769
+ "description": "Sort as field or field:asc|desc, sent as order_by"
770
+ },
771
+ "order-by": {
772
+ "type": "string",
773
+ "format": "json",
774
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
775
+ },
776
+ "labels": {
777
+ "type": "string",
778
+ "description": "Smart money labels to include, comma-separated or repeated; sent as filters.include_smart_money_labels",
779
+ "repeatable": true
780
+ },
781
+ "token": {
782
+ "type": "string",
783
+ "description": "Only this token (contract address); sent as filters.token_address"
488
784
  }
489
785
  }
490
786
  },
@@ -502,6 +798,30 @@
502
798
  "minimum": 0,
503
799
  "default": 30,
504
800
  "description": "Lookback window in days"
801
+ },
802
+ "chains": {
803
+ "type": "string",
804
+ "description": "Comma-separated chains; overrides --chain",
805
+ "repeatable": true
806
+ },
807
+ "filters": {
808
+ "type": "string",
809
+ "format": "json",
810
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
811
+ },
812
+ "sort": {
813
+ "type": "string",
814
+ "description": "Sort as field or field:asc|desc, sent as order_by"
815
+ },
816
+ "order-by": {
817
+ "type": "string",
818
+ "format": "json",
819
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
820
+ },
821
+ "labels": {
822
+ "type": "string",
823
+ "description": "Smart money labels to include, comma-separated or repeated; sent as filters.include_smart_money_labels",
824
+ "repeatable": true
505
825
  }
506
826
  }
507
827
  }
@@ -529,6 +849,25 @@
529
849
  "minimum": 0,
530
850
  "default": 30,
531
851
  "description": "Lookback window in days"
852
+ },
853
+ "date": {
854
+ "type": "string",
855
+ "description": "Date range: YYYY-MM-DD or {\"from\":\"YYYY-MM-DD\",\"to\":\"YYYY-MM-DD\"}; overrides --days",
856
+ "format": "json"
857
+ },
858
+ "filters": {
859
+ "type": "string",
860
+ "format": "json",
861
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
862
+ },
863
+ "sort": {
864
+ "type": "string",
865
+ "description": "Sort as field or field:asc|desc, sent as order_by"
866
+ },
867
+ "order-by": {
868
+ "type": "string",
869
+ "format": "json",
870
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
532
871
  }
533
872
  }
534
873
  },
@@ -552,7 +891,8 @@
552
891
  "default": 30,
553
892
  "description": "Lookback window in days"
554
893
  }
555
- }
894
+ },
895
+ "pagination": false
556
896
  },
557
897
  "balance": {
558
898
  "endpoint": "/api/v1/profiler/address/current-balance",
@@ -561,12 +901,36 @@
561
901
  "address": {
562
902
  "type": "string",
563
903
  "required": true,
564
- "description": "Wallet address to profile"
904
+ "description": "Wallet address to profile",
905
+ "requiredUnless": [
906
+ "entity"
907
+ ]
565
908
  },
566
909
  "chain": {
567
910
  "type": "string",
568
911
  "default": "ethereum",
569
912
  "description": "Chain to profile the address on"
913
+ },
914
+ "entity": {
915
+ "type": "string",
916
+ "aliases": [
917
+ "entity-name"
918
+ ],
919
+ "description": "Nansen entity name to profile instead of --address"
920
+ },
921
+ "filters": {
922
+ "type": "string",
923
+ "format": "json",
924
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
925
+ },
926
+ "sort": {
927
+ "type": "string",
928
+ "description": "Sort as field or field:asc|desc, sent as order_by"
929
+ },
930
+ "order-by": {
931
+ "type": "string",
932
+ "format": "json",
933
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
570
934
  }
571
935
  }
572
936
  },
@@ -589,6 +953,20 @@
589
953
  "minimum": 0,
590
954
  "default": 30,
591
955
  "description": "Lookback window in days"
956
+ },
957
+ "filters": {
958
+ "type": "string",
959
+ "format": "json",
960
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
961
+ },
962
+ "sort": {
963
+ "type": "string",
964
+ "description": "Sort as field or field:asc|desc, sent as order_by"
965
+ },
966
+ "order-by": {
967
+ "type": "string",
968
+ "format": "json",
969
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
592
970
  }
593
971
  }
594
972
  },
@@ -598,7 +976,12 @@
598
976
  "options": {
599
977
  "addresses": {
600
978
  "type": "string",
601
- "description": "Comma-separated list (or JSON array) of up to 10 distinct wallet addresses; required unless --file <path> is provided"
979
+ "description": "Comma-separated list (or JSON array) of up to 10 distinct wallet addresses; required unless --file <path> is provided",
980
+ "required": true,
981
+ "requiredUnless": [
982
+ "file"
983
+ ],
984
+ "repeatable": true
602
985
  },
603
986
  "file": {
604
987
  "type": "string",
@@ -614,6 +997,20 @@
614
997
  "minimum": 0,
615
998
  "default": 30,
616
999
  "description": "Lookback window in days (max 90 for this command)"
1000
+ },
1001
+ "filters": {
1002
+ "type": "string",
1003
+ "format": "json",
1004
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1005
+ },
1006
+ "sort": {
1007
+ "type": "string",
1008
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1009
+ },
1010
+ "order-by": {
1011
+ "type": "string",
1012
+ "format": "json",
1013
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
617
1014
  }
618
1015
  }
619
1016
  },
@@ -636,6 +1033,20 @@
636
1033
  "minimum": 0,
637
1034
  "default": 30,
638
1035
  "description": "Lookback window in days"
1036
+ },
1037
+ "filters": {
1038
+ "type": "string",
1039
+ "format": "json",
1040
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1041
+ },
1042
+ "sort": {
1043
+ "type": "string",
1044
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1045
+ },
1046
+ "order-by": {
1047
+ "type": "string",
1048
+ "format": "json",
1049
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
639
1050
  }
640
1051
  }
641
1052
  },
@@ -652,6 +1063,15 @@
652
1063
  "type": "string",
653
1064
  "default": "ethereum",
654
1065
  "description": "Chain to profile the address on"
1066
+ },
1067
+ "sort": {
1068
+ "type": "string",
1069
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1070
+ },
1071
+ "order-by": {
1072
+ "type": "string",
1073
+ "format": "json",
1074
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
655
1075
  }
656
1076
  }
657
1077
  },
@@ -664,7 +1084,8 @@
664
1084
  "required": true,
665
1085
  "description": "Address whose first funder to find"
666
1086
  }
667
- }
1087
+ },
1088
+ "pagination": false
668
1089
  },
669
1090
  "pnl": {
670
1091
  "endpoint": "/api/v1/profiler/address/pnl",
@@ -685,6 +1106,25 @@
685
1106
  "minimum": 0,
686
1107
  "default": 30,
687
1108
  "description": "Lookback window in days"
1109
+ },
1110
+ "date": {
1111
+ "type": "string",
1112
+ "description": "Date range: YYYY-MM-DD or {\"from\":\"YYYY-MM-DD\",\"to\":\"YYYY-MM-DD\"}; overrides --days",
1113
+ "format": "json"
1114
+ },
1115
+ "filters": {
1116
+ "type": "string",
1117
+ "format": "json",
1118
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1119
+ },
1120
+ "sort": {
1121
+ "type": "string",
1122
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1123
+ },
1124
+ "order-by": {
1125
+ "type": "string",
1126
+ "format": "json",
1127
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
688
1128
  }
689
1129
  }
690
1130
  },
@@ -712,8 +1152,23 @@
712
1152
  "type": "string",
713
1153
  "required": true,
714
1154
  "description": "Hyperliquid trader address"
1155
+ },
1156
+ "filters": {
1157
+ "type": "string",
1158
+ "format": "json",
1159
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1160
+ },
1161
+ "sort": {
1162
+ "type": "string",
1163
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1164
+ },
1165
+ "order-by": {
1166
+ "type": "string",
1167
+ "format": "json",
1168
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
715
1169
  }
716
- }
1170
+ },
1171
+ "pagination": false
717
1172
  },
718
1173
  "perp-trades": {
719
1174
  "endpoint": "/api/v1/profiler/perp-trades",
@@ -729,6 +1184,20 @@
729
1184
  "minimum": 0,
730
1185
  "default": 30,
731
1186
  "description": "Lookback window in days"
1187
+ },
1188
+ "filters": {
1189
+ "type": "string",
1190
+ "format": "json",
1191
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1192
+ },
1193
+ "sort": {
1194
+ "type": "string",
1195
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1196
+ },
1197
+ "order-by": {
1198
+ "type": "string",
1199
+ "format": "json",
1200
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
732
1201
  }
733
1202
  }
734
1203
  },
@@ -751,6 +1220,25 @@
751
1220
  "minimum": 0,
752
1221
  "default": 30,
753
1222
  "description": "Lookback window in days"
1223
+ },
1224
+ "date": {
1225
+ "type": "string",
1226
+ "description": "Date range: YYYY-MM-DD or {\"from\":\"YYYY-MM-DD\",\"to\":\"YYYY-MM-DD\"}; overrides --days",
1227
+ "format": "json"
1228
+ },
1229
+ "filters": {
1230
+ "type": "string",
1231
+ "format": "json",
1232
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1233
+ },
1234
+ "sort": {
1235
+ "type": "string",
1236
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1237
+ },
1238
+ "order-by": {
1239
+ "type": "string",
1240
+ "format": "json",
1241
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
754
1242
  }
755
1243
  }
756
1244
  },
@@ -763,7 +1251,8 @@
763
1251
  "required": true,
764
1252
  "description": "Entity or label name to search for"
765
1253
  }
766
- }
1254
+ },
1255
+ "pagination": false
767
1256
  },
768
1257
  "batch": {
769
1258
  "description": "Batch profile multiple addresses",
@@ -776,14 +1265,29 @@
776
1265
  "include": {
777
1266
  "type": "string",
778
1267
  "default": "labels,balance",
779
- "description": "Comma-separated sections to fetch per address: labels, balance, pnl"
1268
+ "description": "Comma-separated sections to fetch per address: labels, balance, pnl",
1269
+ "repeatable": true
780
1270
  },
781
1271
  "delay": {
782
1272
  "type": "number",
783
1273
  "default": 1000,
784
1274
  "description": "Delay in milliseconds between API calls"
1275
+ },
1276
+ "addresses": {
1277
+ "type": "string",
1278
+ "description": "Comma-separated addresses (max 100)",
1279
+ "required": true,
1280
+ "requiredUnless": [
1281
+ "file"
1282
+ ],
1283
+ "repeatable": true
1284
+ },
1285
+ "file": {
1286
+ "type": "string",
1287
+ "description": "File with one address per line"
785
1288
  }
786
- }
1289
+ },
1290
+ "pagination": false
787
1291
  },
788
1292
  "trace": {
789
1293
  "description": "Multi-hop counterparty trace (BFS)",
@@ -819,7 +1323,8 @@
819
1323
  "default": 1000,
820
1324
  "description": "Delay in milliseconds between API calls"
821
1325
  }
822
- }
1326
+ },
1327
+ "pagination": false
823
1328
  },
824
1329
  "compare": {
825
1330
  "description": "Compare two wallets (shared counterparties, tokens)",
@@ -827,7 +1332,8 @@
827
1332
  "addresses": {
828
1333
  "type": "string",
829
1334
  "required": true,
830
- "description": "Comma-separated list (or JSON array) of wallet addresses to compare"
1335
+ "description": "Comma-separated list (or JSON array) of wallet addresses to compare",
1336
+ "repeatable": true
831
1337
  },
832
1338
  "chain": {
833
1339
  "type": "string",
@@ -840,7 +1346,8 @@
840
1346
  "default": 30,
841
1347
  "description": "Lookback window in days"
842
1348
  }
843
- }
1349
+ },
1350
+ "pagination": false
844
1351
  }
845
1352
  },
846
1353
  "description": "Wallet profiling - detailed information about any blockchain address"
@@ -859,7 +1366,10 @@
859
1366
  "token": {
860
1367
  "type": "string",
861
1368
  "required": true,
862
- "description": "Token contract address (mint address on Solana)"
1369
+ "description": "Token contract address (mint address on Solana)",
1370
+ "aliases": [
1371
+ "token-address"
1372
+ ]
863
1373
  },
864
1374
  "days": {
865
1375
  "type": "integer",
@@ -876,7 +1386,31 @@
876
1386
  "whale",
877
1387
  "exchange"
878
1388
  ],
879
- "default": "top_100_holders"
1389
+ "default": "top_100_holders",
1390
+ "type": "string"
1391
+ },
1392
+ "date": {
1393
+ "type": "string",
1394
+ "description": "Date range: YYYY-MM-DD or {\"from\":\"YYYY-MM-DD\",\"to\":\"YYYY-MM-DD\"}; overrides --days",
1395
+ "format": "json"
1396
+ },
1397
+ "filters": {
1398
+ "type": "string",
1399
+ "format": "json",
1400
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1401
+ },
1402
+ "sort": {
1403
+ "type": "string",
1404
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1405
+ },
1406
+ "order-by": {
1407
+ "type": "string",
1408
+ "format": "json",
1409
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1410
+ },
1411
+ "smart-money": {
1412
+ "type": "boolean",
1413
+ "description": "Only smart money wallets"
880
1414
  }
881
1415
  }
882
1416
  },
@@ -892,7 +1426,10 @@
892
1426
  "token": {
893
1427
  "type": "string",
894
1428
  "required": true,
895
- "description": "Token contract address (mint address on Solana)"
1429
+ "description": "Token contract address (mint address on Solana)",
1430
+ "aliases": [
1431
+ "token-address"
1432
+ ]
896
1433
  },
897
1434
  "days": {
898
1435
  "type": "integer",
@@ -906,7 +1443,31 @@
906
1443
  "BUY",
907
1444
  "SELL"
908
1445
  ],
909
- "default": "BUY"
1446
+ "default": "BUY",
1447
+ "type": "string"
1448
+ },
1449
+ "date": {
1450
+ "type": "string",
1451
+ "description": "Date range: YYYY-MM-DD or {\"from\":\"YYYY-MM-DD\",\"to\":\"YYYY-MM-DD\"}; overrides --days",
1452
+ "format": "json"
1453
+ },
1454
+ "filters": {
1455
+ "type": "string",
1456
+ "format": "json",
1457
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1458
+ },
1459
+ "sort": {
1460
+ "type": "string",
1461
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1462
+ },
1463
+ "order-by": {
1464
+ "type": "string",
1465
+ "format": "json",
1466
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1467
+ },
1468
+ "smart-money": {
1469
+ "type": "boolean",
1470
+ "description": "Only smart money wallets"
910
1471
  }
911
1472
  }
912
1473
  },
@@ -922,13 +1483,34 @@
922
1483
  "token": {
923
1484
  "type": "string",
924
1485
  "required": true,
925
- "description": "Token contract address (mint address on Solana)"
1486
+ "description": "Token contract address (mint address on Solana)",
1487
+ "aliases": [
1488
+ "token-address"
1489
+ ]
926
1490
  },
927
1491
  "days": {
928
1492
  "type": "integer",
929
1493
  "minimum": 0,
930
1494
  "default": 30,
931
1495
  "description": "Lookback window in days"
1496
+ },
1497
+ "filters": {
1498
+ "type": "string",
1499
+ "format": "json",
1500
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1501
+ },
1502
+ "sort": {
1503
+ "type": "string",
1504
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1505
+ },
1506
+ "order-by": {
1507
+ "type": "string",
1508
+ "format": "json",
1509
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1510
+ },
1511
+ "smart-money": {
1512
+ "type": "boolean",
1513
+ "description": "Only smart money wallets"
932
1514
  }
933
1515
  }
934
1516
  },
@@ -944,13 +1526,46 @@
944
1526
  "token": {
945
1527
  "type": "string",
946
1528
  "required": true,
947
- "description": "Token contract address (mint address on Solana)"
1529
+ "description": "Token contract address (mint address on Solana)",
1530
+ "aliases": [
1531
+ "token-address"
1532
+ ]
948
1533
  },
949
1534
  "days": {
950
1535
  "type": "integer",
951
1536
  "minimum": 0,
952
1537
  "default": 30,
953
1538
  "description": "Lookback window in days"
1539
+ },
1540
+ "filters": {
1541
+ "type": "string",
1542
+ "format": "json",
1543
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1544
+ },
1545
+ "sort": {
1546
+ "type": "string",
1547
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1548
+ },
1549
+ "order-by": {
1550
+ "type": "string",
1551
+ "format": "json",
1552
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1553
+ },
1554
+ "from": {
1555
+ "type": "string",
1556
+ "description": "Only transfers from this address; sent as filters.from_address"
1557
+ },
1558
+ "to": {
1559
+ "type": "string",
1560
+ "description": "Only transfers to this address; sent as filters.to_address"
1561
+ },
1562
+ "enrich": {
1563
+ "type": "boolean",
1564
+ "description": "Add Nansen labels for the from/to addresses (extra requests)"
1565
+ },
1566
+ "smart-money": {
1567
+ "type": "boolean",
1568
+ "description": "Only smart money wallets"
954
1569
  }
955
1570
  }
956
1571
  },
@@ -966,11 +1581,32 @@
966
1581
  "token": {
967
1582
  "type": "string",
968
1583
  "required": true,
969
- "description": "Token contract address (mint address on Solana)"
1584
+ "description": "Token contract address (mint address on Solana)",
1585
+ "aliases": [
1586
+ "token-address"
1587
+ ]
970
1588
  },
971
1589
  "premium-labels": {
972
1590
  "description": "Include premium Nansen labels in the response (true=premium, false=free-tier). When omitted, uses API default.",
973
1591
  "type": "boolean"
1592
+ },
1593
+ "filters": {
1594
+ "type": "string",
1595
+ "format": "json",
1596
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1597
+ },
1598
+ "sort": {
1599
+ "type": "string",
1600
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1601
+ },
1602
+ "order-by": {
1603
+ "type": "string",
1604
+ "format": "json",
1605
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1606
+ },
1607
+ "smart-money": {
1608
+ "type": "boolean",
1609
+ "description": "Only smart money wallets"
974
1610
  }
975
1611
  }
976
1612
  },
@@ -986,7 +1622,10 @@
986
1622
  "token": {
987
1623
  "type": "string",
988
1624
  "required": true,
989
- "description": "Token contract address (mint address on Solana)"
1625
+ "description": "Token contract address (mint address on Solana)",
1626
+ "aliases": [
1627
+ "token-address"
1628
+ ]
990
1629
  },
991
1630
  "days": {
992
1631
  "type": "integer",
@@ -997,6 +1636,24 @@
997
1636
  "premium-labels": {
998
1637
  "description": "Include premium Nansen labels in the response (true=premium, false=free-tier). When omitted, uses API default.",
999
1638
  "type": "boolean"
1639
+ },
1640
+ "filters": {
1641
+ "type": "string",
1642
+ "format": "json",
1643
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1644
+ },
1645
+ "sort": {
1646
+ "type": "string",
1647
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1648
+ },
1649
+ "order-by": {
1650
+ "type": "string",
1651
+ "format": "json",
1652
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1653
+ },
1654
+ "smart-money": {
1655
+ "type": "boolean",
1656
+ "description": "Only smart money wallets"
1000
1657
  }
1001
1658
  }
1002
1659
  },
@@ -1007,7 +1664,10 @@
1007
1664
  "symbol": {
1008
1665
  "type": "string",
1009
1666
  "required": true,
1010
- "description": "Perp symbol, e.g. BTC"
1667
+ "description": "Perp symbol, e.g. BTC",
1668
+ "aliases": [
1669
+ "token-symbol"
1670
+ ]
1011
1671
  },
1012
1672
  "days": {
1013
1673
  "type": "integer",
@@ -1018,6 +1678,24 @@
1018
1678
  "premium-labels": {
1019
1679
  "description": "Include premium Nansen labels in the response (true=premium, false=free-tier). When omitted, uses API default.",
1020
1680
  "type": "boolean"
1681
+ },
1682
+ "filters": {
1683
+ "type": "string",
1684
+ "format": "json",
1685
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1686
+ },
1687
+ "sort": {
1688
+ "type": "string",
1689
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1690
+ },
1691
+ "order-by": {
1692
+ "type": "string",
1693
+ "format": "json",
1694
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1695
+ },
1696
+ "smart-money": {
1697
+ "type": "boolean",
1698
+ "description": "Only smart money wallets"
1021
1699
  }
1022
1700
  }
1023
1701
  },
@@ -1027,8 +1705,29 @@
1027
1705
  "options": {
1028
1706
  "symbol": {
1029
1707
  "type": "string",
1030
- "required": true,
1031
- "description": "Perp symbol, e.g. BTC"
1708
+ "required": true,
1709
+ "description": "Perp symbol, e.g. BTC",
1710
+ "aliases": [
1711
+ "token-symbol"
1712
+ ]
1713
+ },
1714
+ "filters": {
1715
+ "type": "string",
1716
+ "format": "json",
1717
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1718
+ },
1719
+ "sort": {
1720
+ "type": "string",
1721
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1722
+ },
1723
+ "order-by": {
1724
+ "type": "string",
1725
+ "format": "json",
1726
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1727
+ },
1728
+ "smart-money": {
1729
+ "type": "boolean",
1730
+ "description": "Only smart money wallets"
1032
1731
  }
1033
1732
  }
1034
1733
  },
@@ -1039,13 +1738,34 @@
1039
1738
  "symbol": {
1040
1739
  "type": "string",
1041
1740
  "required": true,
1042
- "description": "Perp symbol, e.g. BTC"
1741
+ "description": "Perp symbol, e.g. BTC",
1742
+ "aliases": [
1743
+ "token-symbol"
1744
+ ]
1043
1745
  },
1044
1746
  "days": {
1045
1747
  "type": "integer",
1046
1748
  "minimum": 0,
1047
1749
  "default": 30,
1048
1750
  "description": "Lookback window in days"
1751
+ },
1752
+ "filters": {
1753
+ "type": "string",
1754
+ "format": "json",
1755
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1756
+ },
1757
+ "sort": {
1758
+ "type": "string",
1759
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1760
+ },
1761
+ "order-by": {
1762
+ "type": "string",
1763
+ "format": "json",
1764
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1765
+ },
1766
+ "smart-money": {
1767
+ "type": "boolean",
1768
+ "description": "Only smart money wallets"
1049
1769
  }
1050
1770
  }
1051
1771
  },
@@ -1061,14 +1781,18 @@
1061
1781
  "token": {
1062
1782
  "type": "string",
1063
1783
  "required": true,
1064
- "description": "Token contract address (mint address on Solana)"
1784
+ "description": "Token contract address (mint address on Solana)",
1785
+ "aliases": [
1786
+ "token-address"
1787
+ ]
1065
1788
  },
1066
1789
  "timeframe": {
1067
1790
  "type": "string",
1068
1791
  "default": "1d",
1069
1792
  "description": "Time window for the flow metrics"
1070
1793
  }
1071
- }
1794
+ },
1795
+ "pagination": false
1072
1796
  },
1073
1797
  "info": {
1074
1798
  "endpoint": "/api/v1/tgm/token-information",
@@ -1082,14 +1806,18 @@
1082
1806
  "token": {
1083
1807
  "type": "string",
1084
1808
  "required": true,
1085
- "description": "Token contract address (mint address on Solana)"
1809
+ "description": "Token contract address (mint address on Solana)",
1810
+ "aliases": [
1811
+ "token-address"
1812
+ ]
1086
1813
  },
1087
1814
  "timeframe": {
1088
1815
  "type": "string",
1089
1816
  "default": "1d",
1090
1817
  "description": "Time window for the price-change and volume fields"
1091
1818
  }
1092
- }
1819
+ },
1820
+ "pagination": false
1093
1821
  },
1094
1822
  "indicators": {
1095
1823
  "endpoint": "/api/v1/tgm/indicators",
@@ -1103,9 +1831,13 @@
1103
1831
  "token": {
1104
1832
  "type": "string",
1105
1833
  "required": true,
1106
- "description": "Token contract address"
1834
+ "description": "Token contract address",
1835
+ "aliases": [
1836
+ "token-address"
1837
+ ]
1107
1838
  }
1108
- }
1839
+ },
1840
+ "pagination": false
1109
1841
  },
1110
1842
  "ohlcv": {
1111
1843
  "endpoint": "/api/v1/tgm/token-ohlcv",
@@ -1119,23 +1851,40 @@
1119
1851
  "token": {
1120
1852
  "type": "string",
1121
1853
  "required": true,
1122
- "description": "Token contract address (mint address on Solana)"
1854
+ "description": "Token contract address (mint address on Solana)",
1855
+ "aliases": [
1856
+ "token-address"
1857
+ ]
1123
1858
  },
1124
1859
  "timeframe": {
1125
1860
  "type": "string",
1126
1861
  "default": "1d",
1127
1862
  "description": "Candle interval"
1128
1863
  }
1129
- }
1864
+ },
1865
+ "pagination": false
1130
1866
  },
1131
1867
  "jup-dca": {
1132
1868
  "endpoint": "/api/v1/tgm/jup-dca",
1133
1869
  "description": "Jupiter DCA orders for token",
1870
+ "examples": ["nansen research token jup-dca --token So11111111111111111111111111111111111111112"],
1134
1871
  "options": {
1135
1872
  "token": {
1136
1873
  "type": "string",
1137
1874
  "required": true,
1138
- "description": "Token mint address"
1875
+ "description": "Token mint address",
1876
+ "aliases": [
1877
+ "token-address"
1878
+ ]
1879
+ },
1880
+ "filters": {
1881
+ "type": "string",
1882
+ "format": "json",
1883
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1884
+ },
1885
+ "smart-money": {
1886
+ "type": "boolean",
1887
+ "description": "Only smart money wallets"
1139
1888
  }
1140
1889
  }
1141
1890
  },
@@ -1155,11 +1904,35 @@
1155
1904
  },
1156
1905
  "include-stablecoins": {
1157
1906
  "description": "Whether to include stablecoins in screener results (default true on API side)",
1158
- "default": true
1907
+ "default": true,
1908
+ "type": "boolean"
1159
1909
  },
1160
1910
  "search": {
1161
1911
  "type": "string",
1162
1912
  "description": "Filter screener candidates client-side by token name, symbol, or exact address. Only the fetched candidate rows are searched (the first 500 by default, more with --limit/--page, every traversed page with --paginate/--all), so the response adds _meta.search: { query, searched, matched, complete }. complete: false means the API had more rows beyond that window and a missing token may simply rank below it; widen with --limit (max 1000) or --paginate, or narrow with --filters. A stderr note repeats this for --fields/--table/--csv/--stream output. With --paginate/--all, the fully traversed candidate pool is filtered after traversal; pagination metadata describes the upstream candidate-page traversal, not the number of matches after filtering."
1913
+ },
1914
+ "filters": {
1915
+ "type": "string",
1916
+ "format": "json",
1917
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
1918
+ },
1919
+ "sort": {
1920
+ "type": "string",
1921
+ "description": "Sort as field or field:asc|desc, sent as order_by"
1922
+ },
1923
+ "order-by": {
1924
+ "type": "string",
1925
+ "format": "json",
1926
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1927
+ },
1928
+ "smart-money": {
1929
+ "type": "boolean",
1930
+ "description": "Only smart money wallets"
1931
+ },
1932
+ "chains": {
1933
+ "type": "string",
1934
+ "description": "Comma-separated chains; overrides --chain",
1935
+ "repeatable": true
1163
1936
  }
1164
1937
  }
1165
1938
  },
@@ -1173,14 +1946,19 @@
1173
1946
  "lowcap",
1174
1947
  "midcap",
1175
1948
  "largecap"
1176
- ]
1949
+ ],
1950
+ "aliases": [
1951
+ "market-cap-group"
1952
+ ],
1953
+ "type": "string"
1177
1954
  },
1178
1955
  "limit": {
1179
1956
  "type": "number",
1180
1957
  "default": 25,
1181
1958
  "description": "Number of tokens to return"
1182
1959
  }
1183
- }
1960
+ },
1961
+ "pagination": false
1184
1962
  }
1185
1963
  },
1186
1964
  "description": "Token God Mode - deep analytics for any token"
@@ -1192,7 +1970,8 @@
1192
1970
  "query": {
1193
1971
  "type": "string",
1194
1972
  "required": true,
1195
- "description": "Token name, symbol, or address, or an entity name"
1973
+ "description": "Token name, symbol, or address, or an entity name",
1974
+ "positional": true
1196
1975
  },
1197
1976
  "type": {
1198
1977
  "type": "string",
@@ -1204,8 +1983,13 @@
1204
1983
  "type": "number",
1205
1984
  "default": 25,
1206
1985
  "description": "Maximum number of results"
1986
+ },
1987
+ "chain": {
1988
+ "type": "string",
1989
+ "description": "Only results on this chain"
1207
1990
  }
1208
- }
1991
+ },
1992
+ "pagination": false
1209
1993
  },
1210
1994
  "perp": {
1211
1995
  "subcommands": {
@@ -1227,16 +2011,37 @@
1227
2011
  "whale",
1228
2012
  "public_figure",
1229
2013
  "high_winrate_hl_perps_trader"
1230
- ]
2014
+ ],
2015
+ "type": "string"
1231
2016
  },
1232
2017
  "sectors-filter": {
1233
- "description": "Comma-separated sector:subcategory pairs to filter by, e.g. \"Crypto:AI,TradFi:Stocks\"."
2018
+ "description": "Comma-separated sector:subcategory pairs to filter by, e.g. \"Crypto:AI,TradFi:Stocks\".",
2019
+ "type": "string",
2020
+ "repeatable": true
1234
2021
  },
1235
2022
  "sm-label-filter": {
1236
- "description": "Comma-separated Nansen SM labels to filter by, e.g. \"30D Smart Trader\". Only applies when trader-type is all or sm."
2023
+ "description": "Comma-separated Nansen SM labels to filter by, e.g. \"30D Smart Trader\". Only applies when trader-type is all or sm.",
2024
+ "type": "string",
2025
+ "repeatable": true
1237
2026
  },
1238
2027
  "trader-label-filter": {
1239
- "description": "Comma-separated HL perps trader labels to filter by, e.g. \"HL Perps Whale\". Only applies when trader-type is all or sm."
2028
+ "description": "Comma-separated HL perps trader labels to filter by, e.g. \"HL Perps Whale\". Only applies when trader-type is all or sm.",
2029
+ "type": "string",
2030
+ "repeatable": true
2031
+ },
2032
+ "filters": {
2033
+ "type": "string",
2034
+ "format": "json",
2035
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
2036
+ },
2037
+ "sort": {
2038
+ "type": "string",
2039
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2040
+ },
2041
+ "order-by": {
2042
+ "type": "string",
2043
+ "format": "json",
2044
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1240
2045
  }
1241
2046
  }
1242
2047
  },
@@ -1253,6 +2058,20 @@
1253
2058
  "premium-labels": {
1254
2059
  "description": "Include premium Nansen labels in the response (true=premium, false=free-tier). When omitted, uses API default.",
1255
2060
  "type": "boolean"
2061
+ },
2062
+ "filters": {
2063
+ "type": "string",
2064
+ "format": "json",
2065
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
2066
+ },
2067
+ "sort": {
2068
+ "type": "string",
2069
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2070
+ },
2071
+ "order-by": {
2072
+ "type": "string",
2073
+ "format": "json",
2074
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1256
2075
  }
1257
2076
  }
1258
2077
  }
@@ -1269,6 +2088,15 @@
1269
2088
  "type": "string",
1270
2089
  "required": true,
1271
2090
  "description": "Polymarket market ID (numeric, from the screener)"
2091
+ },
2092
+ "sort": {
2093
+ "type": "string",
2094
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2095
+ },
2096
+ "order-by": {
2097
+ "type": "string",
2098
+ "format": "json",
2099
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1272
2100
  }
1273
2101
  }
1274
2102
  },
@@ -1291,6 +2119,15 @@
1291
2119
  "type": "string",
1292
2120
  "required": true,
1293
2121
  "description": "Polymarket market ID (numeric, from the screener)"
2122
+ },
2123
+ "sort": {
2124
+ "type": "string",
2125
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2126
+ },
2127
+ "order-by": {
2128
+ "type": "string",
2129
+ "format": "json",
2130
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1294
2131
  }
1295
2132
  }
1296
2133
  },
@@ -1302,6 +2139,15 @@
1302
2139
  "type": "string",
1303
2140
  "required": true,
1304
2141
  "description": "Polymarket market ID (numeric, from the screener)"
2142
+ },
2143
+ "sort": {
2144
+ "type": "string",
2145
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2146
+ },
2147
+ "order-by": {
2148
+ "type": "string",
2149
+ "format": "json",
2150
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1305
2151
  }
1306
2152
  }
1307
2153
  },
@@ -1315,11 +2161,13 @@
1315
2161
  "description": "Text filter on market titles"
1316
2162
  },
1317
2163
  "sort-by": {
1318
- "description": "Deprecated: use --sort field:dir instead"
2164
+ "description": "Deprecated: use --sort field:dir instead",
2165
+ "type": "string"
1319
2166
  },
1320
2167
  "tags": {
1321
2168
  "type": "string",
1322
- "description": "Comma-separated Polymarket tags to filter by"
2169
+ "description": "Comma-separated Polymarket tags to filter by",
2170
+ "repeatable": true
1323
2171
  },
1324
2172
  "min-liquidity": {
1325
2173
  "type": "number",
@@ -1329,10 +2177,6 @@
1329
2177
  "type": "number",
1330
2178
  "description": "Maximum liquidity in USD"
1331
2179
  },
1332
- "min-unique-traders-24h": {
1333
- "type": "number",
1334
- "description": "Minimum unique traders in the last 24 hours"
1335
- },
1336
2180
  "max-unique-traders-24h": {
1337
2181
  "type": "number",
1338
2182
  "description": "Maximum unique traders in the last 24 hours"
@@ -1341,10 +2185,6 @@
1341
2185
  "type": "number",
1342
2186
  "description": "Minimum 24-hour volume in USD"
1343
2187
  },
1344
- "max-volume-24hr": {
1345
- "type": "number",
1346
- "description": "Maximum 24-hour volume in USD"
1347
- },
1348
2188
  "neg-risk": {
1349
2189
  "type": "boolean",
1350
2190
  "enum": ["true", "false"],
@@ -1373,6 +2213,19 @@
1373
2213
  "max-price": {
1374
2214
  "type": "number",
1375
2215
  "description": "Maximum outcome price (0-1)"
2216
+ },
2217
+ "sort": {
2218
+ "type": "string",
2219
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2220
+ },
2221
+ "order-by": {
2222
+ "type": "string",
2223
+ "format": "json",
2224
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
2225
+ },
2226
+ "status": {
2227
+ "type": "string",
2228
+ "description": "Market status filter, e.g. active or closed"
1376
2229
  }
1377
2230
  }
1378
2231
  },
@@ -1386,11 +2239,13 @@
1386
2239
  "description": "Text filter on event titles"
1387
2240
  },
1388
2241
  "sort-by": {
1389
- "description": "Deprecated: use --sort field:dir instead"
2242
+ "description": "Deprecated: use --sort field:dir instead",
2243
+ "type": "string"
1390
2244
  },
1391
2245
  "tags": {
1392
2246
  "type": "string",
1393
- "description": "Comma-separated Polymarket tags to filter by"
2247
+ "description": "Comma-separated Polymarket tags to filter by",
2248
+ "repeatable": true
1394
2249
  },
1395
2250
  "min-liquidity": {
1396
2251
  "type": "number",
@@ -1400,10 +2255,6 @@
1400
2255
  "type": "number",
1401
2256
  "description": "Maximum liquidity in USD"
1402
2257
  },
1403
- "min-unique-traders-24h": {
1404
- "type": "number",
1405
- "description": "Minimum unique traders in the last 24 hours"
1406
- },
1407
2258
  "max-unique-traders-24h": {
1408
2259
  "type": "number",
1409
2260
  "description": "Maximum unique traders in the last 24 hours"
@@ -1412,10 +2263,6 @@
1412
2263
  "type": "number",
1413
2264
  "description": "Minimum 24-hour volume in USD"
1414
2265
  },
1415
- "max-volume-24hr": {
1416
- "type": "number",
1417
- "description": "Maximum 24-hour volume in USD"
1418
- },
1419
2266
  "neg-risk": {
1420
2267
  "type": "boolean",
1421
2268
  "enum": ["true", "false"],
@@ -1436,6 +2283,19 @@
1436
2283
  "end-date-after": {
1437
2284
  "type": "string",
1438
2285
  "description": "Only events ending after this date (ISO 8601)"
2286
+ },
2287
+ "sort": {
2288
+ "type": "string",
2289
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2290
+ },
2291
+ "order-by": {
2292
+ "type": "string",
2293
+ "format": "json",
2294
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
2295
+ },
2296
+ "status": {
2297
+ "type": "string",
2298
+ "description": "Market status filter, e.g. active or closed"
1439
2299
  }
1440
2300
  }
1441
2301
  },
@@ -1447,6 +2307,15 @@
1447
2307
  "type": "string",
1448
2308
  "required": true,
1449
2309
  "description": "Polymarket market ID (numeric, from the screener)"
2310
+ },
2311
+ "sort": {
2312
+ "type": "string",
2313
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2314
+ },
2315
+ "order-by": {
2316
+ "type": "string",
2317
+ "format": "json",
2318
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1450
2319
  }
1451
2320
  }
1452
2321
  },
@@ -1458,6 +2327,15 @@
1458
2327
  "type": "string",
1459
2328
  "required": true,
1460
2329
  "description": "Polymarket trader address"
2330
+ },
2331
+ "sort": {
2332
+ "type": "string",
2333
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2334
+ },
2335
+ "order-by": {
2336
+ "type": "string",
2337
+ "format": "json",
2338
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1461
2339
  }
1462
2340
  }
1463
2341
  },
@@ -1480,6 +2358,15 @@
1480
2358
  "type": "string",
1481
2359
  "required": true,
1482
2360
  "description": "Polymarket trader address"
2361
+ },
2362
+ "sort": {
2363
+ "type": "string",
2364
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2365
+ },
2366
+ "order-by": {
2367
+ "type": "string",
2368
+ "format": "json",
2369
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1483
2370
  }
1484
2371
  }
1485
2372
  },
@@ -1525,11 +2412,13 @@
1525
2412
  "default": "all",
1526
2413
  "description": "Include all chains or only EVM chains"
1527
2414
  }
1528
- }
2415
+ },
2416
+ "pagination": false
1529
2417
  },
1530
2418
  "token-sectors": {
1531
2419
  "endpoint": "/api/v1/search/token-sectors",
1532
- "description": "List token sectors available for filtering"
2420
+ "description": "List token sectors available for filtering",
2421
+ "pagination": false
1533
2422
  },
1534
2423
  "address-premium-labels": {
1535
2424
  "endpoint": "/api/v1/profiler/address/premium-labels",
@@ -1563,7 +2452,9 @@
1563
2452
  "options": {
1564
2453
  "chains": {
1565
2454
  "default": "solana",
1566
- "description": "Comma-separated chains"
2455
+ "description": "Comma-separated chains",
2456
+ "type": "string",
2457
+ "repeatable": true
1567
2458
  },
1568
2459
  "timeframe-days": {
1569
2460
  "type": "number",
@@ -1573,7 +2464,8 @@
1573
2464
  },
1574
2465
  "filters": {
1575
2466
  "type": "string",
1576
- "description": "Filters as JSON object"
2467
+ "description": "Filters as JSON object",
2468
+ "format": "json"
1577
2469
  },
1578
2470
  "sort": {
1579
2471
  "type": "string",
@@ -1587,6 +2479,15 @@
1587
2479
  "limit": {
1588
2480
  "type": "number",
1589
2481
  "description": "Max results per page; maps to pagination.per_page"
2482
+ },
2483
+ "order-by": {
2484
+ "type": "string",
2485
+ "format": "json",
2486
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
2487
+ },
2488
+ "chain": {
2489
+ "type": "string",
2490
+ "description": "Single chain; --chains takes precedence"
1590
2491
  }
1591
2492
  }
1592
2493
  },
@@ -1596,9 +2497,15 @@
1596
2497
  "options": {
1597
2498
  "symbol": {
1598
2499
  "required": true,
1599
- "description": "Hyperliquid asset symbol (--token-address is accepted as an alias)"
2500
+ "description": "Hyperliquid asset symbol (--token-address is accepted as an alias)",
2501
+ "type": "string",
2502
+ "aliases": [
2503
+ "token-address",
2504
+ "token"
2505
+ ]
1600
2506
  }
1601
- }
2507
+ },
2508
+ "pagination": false
1602
2509
  },
1603
2510
  "perp-pnl-summary": {
1604
2511
  "endpoint": "/api/v1/profiler/perp-pnl-summary",
@@ -1611,13 +2518,18 @@
1611
2518
  },
1612
2519
  "from-date": {
1613
2520
  "required": true,
1614
- "description": "Start of date range"
2521
+ "description": "Start of date range",
2522
+ "type": "string",
2523
+ "format": "date-time"
1615
2524
  },
1616
2525
  "to-date": {
1617
2526
  "required": true,
1618
- "description": "End of date range"
2527
+ "description": "End of date range",
2528
+ "type": "string",
2529
+ "format": "date-time"
1619
2530
  }
1620
- }
2531
+ },
2532
+ "pagination": false
1621
2533
  },
1622
2534
  "historical-token-ohlcv": {
1623
2535
  "endpoint": "/api/v1beta1/tgm/historical-token-ohlcv",
@@ -1625,35 +2537,50 @@
1625
2537
  "options": {
1626
2538
  "token-address": {
1627
2539
  "required": true,
1628
- "description": "Token address or Hyperliquid asset symbol"
2540
+ "description": "Token address or Hyperliquid asset symbol",
2541
+ "type": "string",
2542
+ "aliases": [
2543
+ "token"
2544
+ ]
1629
2545
  },
1630
2546
  "chain": {
1631
2547
  "type": "string",
1632
- "enum": ["base", "bnb", "ethereum", "hyperliquid", "solana"],
1633
2548
  "default": "solana",
1634
2549
  "description": "Chain the token lives on"
1635
2550
  },
1636
2551
  "from-date": {
1637
2552
  "required": true,
1638
- "description": "Start of data window"
2553
+ "description": "Start of data window",
2554
+ "type": "string"
1639
2555
  },
1640
2556
  "as-of-date": {
1641
- "description": "End of data window; exactly one of --as-of-date or --as-of-ts is required"
2557
+ "description": "End of data window; exactly one of --as-of-date or --as-of-ts is required",
2558
+ "type": "string"
1642
2559
  },
1643
2560
  "as-of-ts": {
1644
- "description": "Exact Hyperliquid cutoff timestamp; exactly one of --as-of-date or --as-of-ts is required"
2561
+ "description": "Exact Hyperliquid cutoff timestamp; exactly one of --as-of-date or --as-of-ts is required",
2562
+ "type": "string"
1645
2563
  },
1646
2564
  "timeframe": {
1647
2565
  "type": "string",
1648
2566
  "required": true,
1649
- "enum": ["5m", "15m", "30m", "1h", "1d", "1w"],
2567
+ "enum": [
2568
+ "5m",
2569
+ "15m",
2570
+ "30m",
2571
+ "1h",
2572
+ "4h",
2573
+ "1d",
2574
+ "1w"
2575
+ ],
1650
2576
  "description": "Candle interval"
1651
2577
  },
1652
2578
  "apply-blacklist-filter": {
1653
2579
  "type": "boolean",
1654
2580
  "description": "Apply blacklist filtering for 1d/1w non-Hyperliquid requests"
1655
2581
  }
1656
- }
2582
+ },
2583
+ "pagination": false
1657
2584
  },
1658
2585
  "transaction-with-token-transfer-lookup": {
1659
2586
  "endpoint": "/api/v1/transaction-with-token-transfer-lookup",
@@ -1666,154 +2593,277 @@
1666
2593
  },
1667
2594
  "chain": {
1668
2595
  "type": "string",
1669
- "enum": ["all", "arbitrum", "avalanche", "base", "bitcoin", "bnb", "ethereum", "hyperevm", "injective", "iotaevm", "linea", "mantle", "mantra", "monad", "near", "optimism", "plasma", "robinhood", "sei", "sonic", "starknet", "sui", "ton", "tron"],
1670
2596
  "default": "ethereum",
1671
2597
  "description": "Chain the transaction was made on"
1672
2598
  },
1673
2599
  "block-timestamp": {
1674
- "description": "Block timestamp (required for bitcoin, tron, ton, starknet, and sui)"
2600
+ "description": "Block timestamp (required for bitcoin, tron, ton, starknet, and sui)",
2601
+ "type": "string"
1675
2602
  }
1676
- }
2603
+ },
2604
+ "pagination": false
1677
2605
  },
1678
2606
  "historical-dex-trades": {
1679
- "endpoint": "/api/v1beta1/tgm/historical-dex-trades",
2607
+ "endpoint": "/api/v1/tgm/historical-dex-trades",
1680
2608
  "description": "Historical DEX trades for a token at a point in time",
1681
2609
  "options": {
1682
2610
  "token-address": {
1683
2611
  "required": true,
1684
- "description": "Token address"
2612
+ "description": "Token address",
2613
+ "type": "string",
2614
+ "aliases": [
2615
+ "token"
2616
+ ]
1685
2617
  },
1686
2618
  "from-date": {
1687
2619
  "required": true,
1688
- "description": "Start of date range (YYYY-MM-DD)"
2620
+ "description": "Start of date range (YYYY-MM-DD)",
2621
+ "type": "string",
2622
+ "format": "date-time"
1689
2623
  },
1690
2624
  "to-date": {
1691
2625
  "required": true,
1692
- "description": "End of date range (YYYY-MM-DD)"
2626
+ "description": "End of date range (YYYY-MM-DD)",
2627
+ "type": "string",
2628
+ "format": "date-time"
1693
2629
  },
1694
2630
  "chain": {
1695
2631
  "default": "solana",
1696
- "description": "Chain"
2632
+ "description": "Chain",
2633
+ "type": "string"
2634
+ },
2635
+ "filters": {
2636
+ "type": "string",
2637
+ "format": "json",
2638
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
2639
+ },
2640
+ "sort": {
2641
+ "type": "string",
2642
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2643
+ },
2644
+ "order-by": {
2645
+ "type": "string",
2646
+ "format": "json",
2647
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1697
2648
  }
1698
2649
  }
1699
2650
  },
1700
2651
  "historical-pnl-leaderboard": {
1701
- "endpoint": "/api/v1beta1/tgm/historical-pnl-leaderboard",
2652
+ "endpoint": "/api/v1/tgm/historical-pnl-leaderboard",
1702
2653
  "description": "Historical PnL leaderboard for a token",
1703
2654
  "options": {
1704
2655
  "token-address": {
1705
2656
  "required": true,
1706
- "description": "Token address"
2657
+ "description": "Token address",
2658
+ "type": "string",
2659
+ "aliases": [
2660
+ "token"
2661
+ ]
1707
2662
  },
1708
2663
  "from-date": {
1709
2664
  "required": true,
1710
- "description": "Start of date range (YYYY-MM-DD)"
2665
+ "description": "Start of date range (YYYY-MM-DD)",
2666
+ "type": "string",
2667
+ "format": "date-time"
1711
2668
  },
1712
2669
  "to-date": {
1713
2670
  "required": true,
1714
- "description": "End of date range (YYYY-MM-DD)"
2671
+ "description": "End of date range (YYYY-MM-DD)",
2672
+ "type": "string",
2673
+ "format": "date-time"
1715
2674
  },
1716
2675
  "chain": {
1717
2676
  "default": "solana",
1718
- "description": "Chain"
2677
+ "description": "Chain",
2678
+ "type": "string"
2679
+ },
2680
+ "filters": {
2681
+ "type": "string",
2682
+ "format": "json",
2683
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
2684
+ },
2685
+ "sort": {
2686
+ "type": "string",
2687
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2688
+ },
2689
+ "order-by": {
2690
+ "type": "string",
2691
+ "format": "json",
2692
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1719
2693
  }
1720
2694
  }
1721
2695
  },
1722
2696
  "historical-token-flow-summary": {
1723
- "endpoint": "/api/v1beta1/tgm/historical-token-flow-summary",
1724
- "description": "Historical token flow summary (no pagination)",
2697
+ "endpoint": "/api/v1/tgm/historical-token-flow-summary",
2698
+ "description": "Historical token flow summary (no pagination; whale, public figure, top PnL and exchange segments start 2025-03-11)",
1725
2699
  "options": {
1726
2700
  "token-address": {
1727
2701
  "required": true,
1728
- "description": "Token address"
2702
+ "description": "Token address",
2703
+ "type": "string",
2704
+ "aliases": [
2705
+ "token"
2706
+ ]
1729
2707
  },
1730
2708
  "from-date": {
1731
2709
  "required": true,
1732
- "description": "Start of date range (YYYY-MM-DD)"
2710
+ "description": "Start of date range (YYYY-MM-DD)",
2711
+ "type": "string",
2712
+ "format": "date-time"
1733
2713
  },
1734
2714
  "to-date": {
1735
2715
  "required": true,
1736
- "description": "End of date range (YYYY-MM-DD)"
2716
+ "description": "End of date range (YYYY-MM-DD). Whale, public figure, top PnL and exchange label history starts 2025-03-11, so those fields are null for an earlier date",
2717
+ "type": "string",
2718
+ "format": "date-time"
1737
2719
  },
1738
2720
  "chain": {
1739
2721
  "default": "solana",
1740
- "description": "Chain"
2722
+ "description": "Chain",
2723
+ "type": "string"
1741
2724
  }
1742
- }
2725
+ },
2726
+ "pagination": false
1743
2727
  },
1744
2728
  "historical-token-quant-scores": {
1745
- "endpoint": "/api/v1beta1/tgm/historical-token-quant-scores",
2729
+ "endpoint": "/api/v1/tgm/historical-token-quant-scores",
1746
2730
  "description": "Historical token quantitative scores at a snapshot date",
1747
2731
  "options": {
1748
2732
  "token-address": {
1749
2733
  "required": true,
1750
- "description": "Token address"
2734
+ "description": "Token address",
2735
+ "type": "string",
2736
+ "aliases": [
2737
+ "token"
2738
+ ]
1751
2739
  },
1752
2740
  "as-of-date": {
1753
2741
  "required": true,
1754
- "description": "Snapshot date (YYYY-MM-DD)"
2742
+ "description": "Snapshot date (YYYY-MM-DD)",
2743
+ "type": "string",
2744
+ "format": "date"
1755
2745
  },
1756
2746
  "chain": {
1757
2747
  "default": "solana",
1758
- "description": "Chain"
2748
+ "description": "Chain",
2749
+ "type": "string"
1759
2750
  }
1760
- }
2751
+ },
2752
+ "pagination": false
1761
2753
  },
1762
2754
  "historical-top-holders": {
1763
- "endpoint": "/api/v1beta1/tgm/historical-top-holders",
2755
+ "endpoint": "/api/v1/tgm/historical-top-holders",
1764
2756
  "description": "Historical top holders of a token at a snapshot date",
1765
2757
  "options": {
1766
2758
  "token-address": {
1767
2759
  "required": true,
1768
- "description": "Token address"
2760
+ "description": "Token address",
2761
+ "type": "string",
2762
+ "aliases": [
2763
+ "token"
2764
+ ]
1769
2765
  },
1770
2766
  "as-of-date": {
1771
2767
  "required": true,
1772
- "description": "Snapshot date (YYYY-MM-DD)"
2768
+ "description": "Snapshot date (YYYY-MM-DD)",
2769
+ "type": "string",
2770
+ "format": "date"
1773
2771
  },
1774
2772
  "chain": {
1775
2773
  "default": "solana",
1776
- "description": "Chain"
2774
+ "description": "Chain",
2775
+ "type": "string"
2776
+ },
2777
+ "filters": {
2778
+ "type": "string",
2779
+ "format": "json",
2780
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
2781
+ },
2782
+ "sort": {
2783
+ "type": "string",
2784
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2785
+ },
2786
+ "order-by": {
2787
+ "type": "string",
2788
+ "format": "json",
2789
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1777
2790
  }
1778
2791
  }
1779
2792
  },
1780
2793
  "historical-who-bought-sold": {
1781
- "endpoint": "/api/v1beta1/tgm/historical-who-bought-sold",
2794
+ "endpoint": "/api/v1/tgm/historical-who-bought-sold",
1782
2795
  "description": "Historical buyers/sellers of a token",
1783
2796
  "options": {
1784
2797
  "token-address": {
1785
2798
  "required": true,
1786
- "description": "Token address"
2799
+ "description": "Token address",
2800
+ "type": "string",
2801
+ "aliases": [
2802
+ "token"
2803
+ ]
1787
2804
  },
1788
2805
  "from-date": {
1789
2806
  "required": true,
1790
- "description": "Start of date range (YYYY-MM-DD)"
2807
+ "description": "Start of date range (YYYY-MM-DD)",
2808
+ "type": "string",
2809
+ "format": "date-time"
1791
2810
  },
1792
2811
  "to-date": {
1793
2812
  "required": true,
1794
- "description": "End of date range (YYYY-MM-DD)"
2813
+ "description": "End of date range (YYYY-MM-DD)",
2814
+ "type": "string",
2815
+ "format": "date-time"
1795
2816
  },
1796
2817
  "buy-or-sell": {
1797
2818
  "default": "BUY",
1798
- "description": "BUY or SELL"
2819
+ "description": "BUY or SELL",
2820
+ "type": "string"
1799
2821
  },
1800
2822
  "chain": {
1801
2823
  "default": "solana",
1802
- "description": "Chain"
2824
+ "description": "Chain",
2825
+ "type": "string"
2826
+ },
2827
+ "filters": {
2828
+ "type": "string",
2829
+ "format": "json",
2830
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
2831
+ },
2832
+ "sort": {
2833
+ "type": "string",
2834
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2835
+ },
2836
+ "order-by": {
2837
+ "type": "string",
2838
+ "format": "json",
2839
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
1803
2840
  }
1804
2841
  }
1805
2842
  },
1806
2843
  "historical-smart-money-balances": {
1807
- "endpoint": "/api/v1beta1/smart-money/historical-token-balances",
2844
+ "endpoint": "/api/v1/smart-money/historical-token-balances",
1808
2845
  "description": "Historical smart money token balances at a snapshot date (no order_by)",
1809
2846
  "options": {
1810
2847
  "as-of-date": {
1811
2848
  "required": true,
1812
- "description": "Snapshot date (YYYY-MM-DD)"
2849
+ "description": "Snapshot date (YYYY-MM-DD)",
2850
+ "type": "string",
2851
+ "format": "date"
1813
2852
  },
1814
2853
  "chains": {
1815
2854
  "default": "solana",
1816
- "description": "Comma-separated chains"
2855
+ "description": "Comma-separated chains",
2856
+ "type": "string",
2857
+ "repeatable": true
2858
+ },
2859
+ "filters": {
2860
+ "type": "string",
2861
+ "format": "json",
2862
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
2863
+ },
2864
+ "chain": {
2865
+ "type": "string",
2866
+ "description": "Single chain; --chains takes precedence"
1817
2867
  }
1818
2868
  }
1819
2869
  },
@@ -1828,68 +2878,104 @@
1828
2878
  },
1829
2879
  "to-date": {
1830
2880
  "required": true,
1831
- "description": "End date for the window (YYYY-MM-DD)"
2881
+ "description": "End date for the window (YYYY-MM-DD)",
2882
+ "type": "string",
2883
+ "format": "date"
1832
2884
  },
1833
2885
  "chains": {
1834
2886
  "default": "solana",
1835
- "description": "Comma-separated chains"
2887
+ "description": "Comma-separated chains",
2888
+ "type": "string",
2889
+ "repeatable": true
2890
+ },
2891
+ "filters": {
2892
+ "type": "string",
2893
+ "format": "json",
2894
+ "description": "Filters as a JSON object, sent as the request filters. EVM addresses (0x + 40 hex) are lowercased."
2895
+ },
2896
+ "sort": {
2897
+ "type": "string",
2898
+ "description": "Sort as field or field:asc|desc, sent as order_by"
2899
+ },
2900
+ "order-by": {
2901
+ "type": "string",
2902
+ "format": "json",
2903
+ "description": "Full order_by JSON array, e.g. [{\"field\":\"value_usd\",\"direction\":\"DESC\"}]; overrides --sort"
2904
+ },
2905
+ "chain": {
2906
+ "type": "string",
2907
+ "description": "Single chain; --chains takes precedence"
1836
2908
  }
1837
2909
  }
1838
2910
  },
1839
2911
  "historical-wallet-balances": {
1840
- "endpoint": "/api/v1beta1/profiler/address/historical-token-balances",
2912
+ "endpoint": "/api/v1/profiler/address/historical-token-balances",
1841
2913
  "description": "Historical token balances for a wallet at a snapshot date",
1842
2914
  "options": {
1843
2915
  "address": {
1844
2916
  "required": true,
1845
- "description": "Wallet address"
2917
+ "description": "Wallet address",
2918
+ "type": "string"
1846
2919
  },
1847
2920
  "as-of-date": {
1848
2921
  "required": true,
1849
- "description": "Snapshot date (YYYY-MM-DD)"
2922
+ "description": "Snapshot date (YYYY-MM-DD)",
2923
+ "type": "string",
2924
+ "format": "date"
1850
2925
  },
1851
2926
  "chain": {
1852
2927
  "default": "ethereum",
1853
- "description": "Chain"
2928
+ "description": "Chain",
2929
+ "type": "string"
1854
2930
  }
1855
2931
  }
1856
2932
  },
1857
2933
  "historical-tx-lookup": {
1858
- "endpoint": "/api/v1beta1/profiler/historical-transaction-lookup",
1859
- "description": "Lookup a historical transaction by hash",
2934
+ "endpoint": "/api/v1/profiler/historical-transaction-lookup",
2935
+ "description": "Lookup a historical transaction by hash (entity labels start 2025-03-11)",
1860
2936
  "options": {
1861
2937
  "transaction-hash": {
1862
2938
  "required": true,
1863
- "description": "Transaction hash (0x-prefixed, 66 chars)"
2939
+ "description": "Transaction hash (0x-prefixed, 66 chars)",
2940
+ "type": "string"
1864
2941
  },
1865
2942
  "as-of-date": {
1866
2943
  "required": true,
1867
- "description": "Reference date for label and pricing resolution (YYYY-MM-DD)"
2944
+ "description": "Reference date for label and pricing resolution (YYYY-MM-DD). Entity labels are available from 2025-03-11 onward",
2945
+ "type": "string",
2946
+ "format": "date"
1868
2947
  },
1869
2948
  "block-timestamp": {
1870
- "description": "Block timestamp (YYYY-MM-DD HH:MM:SS) — skips slow hash-resolution step if provided"
2949
+ "description": "Block timestamp (YYYY-MM-DD HH:MM:SS) — skips slow hash-resolution step if provided",
2950
+ "type": "string"
1871
2951
  },
1872
2952
  "chain": {
1873
2953
  "default": "ethereum",
1874
- "description": "Chain (ethereum, bnb, base)"
2954
+ "description": "Chain (ethereum, bnb, base)",
2955
+ "type": "string"
1875
2956
  }
1876
- }
2957
+ },
2958
+ "pagination": false
1877
2959
  },
1878
2960
  "historical-wallet-transactions": {
1879
- "endpoint": "/api/v1beta1/profiler/address/historical-transactions",
2961
+ "endpoint": "/api/v1/profiler/address/historical-transactions",
1880
2962
  "description": "Historical transactions for a wallet at a snapshot date",
1881
2963
  "options": {
1882
2964
  "address": {
1883
2965
  "required": true,
1884
- "description": "Wallet address"
2966
+ "description": "Wallet address",
2967
+ "type": "string"
1885
2968
  },
1886
2969
  "as-of-date": {
1887
2970
  "required": true,
1888
- "description": "Snapshot date (YYYY-MM-DD)"
2971
+ "description": "Snapshot date (YYYY-MM-DD)",
2972
+ "type": "string",
2973
+ "format": "date"
1889
2974
  },
1890
2975
  "chain": {
1891
2976
  "default": "ethereum",
1892
- "description": "Chain"
2977
+ "description": "Chain",
2978
+ "type": "string"
1893
2979
  }
1894
2980
  }
1895
2981
  }
@@ -1910,7 +2996,13 @@
1910
2996
  "channels",
1911
2997
  "data",
1912
2998
  "description"
1913
- ]
2999
+ ],
3000
+ "options": {
3001
+ "reveal": {
3002
+ "type": "boolean",
3003
+ "description": "Show full channel webhook URLs and webhook signing secrets (redacted by default)"
3004
+ }
3005
+ }
1914
3006
  },
1915
3007
  "create": {
1916
3008
  "endpoint": "/api/v1/smart-alert",
@@ -1962,6 +3054,10 @@
1962
3054
  "disabled": {
1963
3055
  "type": "boolean",
1964
3056
  "description": "Create alert in disabled state"
3057
+ },
3058
+ "reveal": {
3059
+ "type": "boolean",
3060
+ "description": "Show full channel webhook URLs and webhook signing secrets in the response (redacted by default)"
1965
3061
  }
1966
3062
  }
1967
3063
  },
@@ -2017,6 +3113,10 @@
2017
3113
  "disabled": {
2018
3114
  "type": "boolean",
2019
3115
  "description": "Disable alert"
3116
+ },
3117
+ "reveal": {
3118
+ "type": "boolean",
3119
+ "description": "Show full channel webhook URLs and webhook signing secrets in the response (redacted by default)"
2020
3120
  }
2021
3121
  }
2022
3122
  },
@@ -2031,13 +3131,22 @@
2031
3131
  "disabled": {
2032
3132
  "type": "boolean",
2033
3133
  "description": "Disable alert"
3134
+ },
3135
+ "reveal": {
3136
+ "type": "boolean",
3137
+ "description": "Show full channel webhook URLs and webhook signing secrets in the response (redacted by default)"
2034
3138
  }
2035
3139
  }
2036
3140
  },
2037
3141
  "delete": {
2038
3142
  "endpoint": "/api/v1/smart-alert/{alertId}",
2039
3143
  "description": "Delete an alert. Usage: nansen alerts delete <id>",
2040
- "options": {}
3144
+ "options": {
3145
+ "reveal": {
3146
+ "type": "boolean",
3147
+ "description": "Show full channel webhook URLs and webhook signing secrets in error messages (redacted by default)"
3148
+ }
3149
+ }
2041
3150
  }
2042
3151
  }
2043
3152
  },
@@ -2119,7 +3228,7 @@
2119
3228
  ]
2120
3229
  },
2121
3230
  "execute": {
2122
- "description": "Sign and broadcast a quoted trade. Explicitly blank --wallet values are rejected. Non-gasless swaps broadcast through the execution route that tracks the on-chain outcome server-side; NANSEN_TRADING_EXECUTION_ROUTE=legacy is an escape hatch back to the deprecated broadcast route, and any value other than standard or legacy is rejected rather than silently falling back. Gasless swaps and WalletConnect wallets never use the standard route.",
3231
+ "description": "Sign and broadcast a quoted trade. Explicitly blank --wallet values are rejected. Swaps broadcast through the execution route that tracks the on-chain outcome server-side; NANSEN_TRADING_EXECUTION_ROUTE=legacy is an escape hatch back to the deprecated broadcast route, and any value other than standard or legacy is rejected rather than silently falling back. A WalletConnect wallet that broadcasts the swap itself bypasses the standard route (no server-side tracking, and the CLI says so); one that only signs still goes through it. The removed --gasless flag is rejected with GASLESS_REMOVED.",
2123
3232
  "apiEndpoints": [
2124
3233
  "/api/v1/sanctions/screen"
2125
3234
  ],
@@ -2138,10 +3247,6 @@
2138
3247
  "type": "string",
2139
3248
  "description": "Wallet name, or \"walletconnect\"/\"wc\" for WalletConnect (EVM only)"
2140
3249
  },
2141
- "gasless": {
2142
- "type": "boolean",
2143
- "description": "Relay-only: have Relay's solver pay gas + broadcast (user signs only). Requires the selected quote's aggregator to be \"relay\". Not supported via WalletConnect."
2144
- },
2145
3250
  "quote-index": {
2146
3251
  "type": "string",
2147
3252
  "description": "Pin a specific quote by 0-based index when the cached quote returned several. Must be within range; there is no fallback to the other quotes."
@@ -2347,7 +3452,7 @@
2347
3452
  }
2348
3453
  },
2349
3454
  "wallet": {
2350
- "description": "Wallet management. x402 auto-payments are guarded by a client-side policy: per-payment USD cap via NANSEN_X402_MAX_AMOUNT (default 1.00; 'unlimited' to disable) and an optional recipient allowlist via NANSEN_X402_ALLOWED_PAYTO (comma-separated addresses).",
3455
+ "description": "Wallet management. x402 auto-payments are guarded by a client-side policy: per-payment USD cap via NANSEN_X402_MAX_AMOUNT (default 1.00; 'unlimited' to disable), an optional cumulative cap on what one CLI process signs via NANSEN_X402_SESSION_MAX_AMOUNT (environment only; unset or 'unlimited' = no limit, an invalid value refuses every payment; a payment the server cleanly rejects is not counted; it resets with every process), and an optional recipient allowlist via NANSEN_X402_ALLOWED_PAYTO (comma-separated addresses). Each auto-payment and its outcome are recorded in ~/.nansen/x402/payments.jsonl.",
2351
3456
  "subcommands": {
2352
3457
  "create": {
2353
3458
  "description": "Create a new wallet. Explicitly blank --name values are rejected for local and Privy wallets.",
@@ -2819,16 +3924,16 @@
2819
3924
  },
2820
3925
  "limit": {
2821
3926
  "type": "number",
2822
- "description": "Maximum results per page for list-returning research commands; maps to pagination.per_page. General endpoints default to 10 (max 1000), while profiler address endpoints default to 20 (max 100). Supported by smart-money, profiler, token, perp, points, prediction-market, and supported research historical-* commands. Commands that declare their own limit option (search, token top-tokens, trade limit-order list) use those command-specific semantics instead; token ohlcv, profiler perp-positions, and historical-token-flow-summary do not support pagination. profiler labels defaults to 100 when omitted."
3927
+ "description": "Maximum results per page for list-returning research commands; maps to pagination.per_page. General endpoints default to 10 (max 1000), while profiler address endpoints default to 20 (max 100). Commands that declare their own limit option (search, token top-tokens, trade limit-order list) use those command-specific semantics instead. Research commands marked \"pagination\": false in this schema (for example token ohlcv, profiler perp-positions, historical-token-flow-summary) reject it. profiler labels defaults to 100 when omitted."
2823
3928
  },
2824
3929
  "page": {
2825
3930
  "type": "number",
2826
3931
  "default": 1,
2827
- "description": "1-based page number for list-returning research commands; maps to pagination.page. Supported by smart-money, profiler, token, perp, points, prediction-market, and supported research historical-* commands. Trade, wallet, and operational commands ignore it; token ohlcv, profiler perp-positions, and historical-token-flow-summary do not support pagination. profiler labels defaults to page 1 when omitted."
3932
+ "description": "1-based page number (a positive integer) for list-returning research commands; maps to pagination.page. Research commands marked \"pagination\": false in this schema reject it. Trade, wallet, and operational commands ignore it. profiler labels defaults to page 1 when omitted."
2828
3933
  },
2829
3934
  "paginate": {
2830
3935
  "type": "boolean",
2831
- "description": "Fetch every page of a list-returning command and return one merged response (alias: --all). Starts at --page (default 1) and uses --limit as the page size; stops on a short or empty page, when server pagination metadata (total_pages, total, is_last_page, has_more, or next_page) says the traversal is complete, when a page repeats rows already seen, or after --max-pages requests. Server total metadata is trusted, so a live dataset that changes or reports inconsistent totals during traversal can omit later rows. The merged response keeps the first page's shape (a bare array is wrapped as { data: [...] }) with rows de-duplicated, plus pagination: { page, pages_fetched, next_page, complete } — next_page is null when complete, otherwise the page to resume from. Each page is a separate, separately billed API call. Works with --stream (NDJSON), --table, --format csv and --fields. Commands without pagination are unaffected."
3936
+ "description": "Fetch every page of a list-returning command and return one merged response (alias: --all). Starts at --page (default 1) and uses --limit as the page size; stops on a short or empty page, when server pagination metadata (total_pages, total, is_last_page, has_more, or next_page) says the traversal is complete, when a page repeats rows already seen, or after --max-pages requests. Server total metadata is trusted, so a live dataset that changes or reports inconsistent totals during traversal can omit later rows. The merged response keeps the first page's shape (a bare array is wrapped as { data: [...] }) with rows de-duplicated, plus pagination: { page, pages_fetched, next_page, complete } — next_page is null when complete, otherwise the page to resume from. Each page is a separate, separately billed API call. Works with --stream (NDJSON), --table, --format csv and --fields. Research commands marked \"pagination\": false reject it."
2832
3937
  },
2833
3938
  "max-pages": {
2834
3939
  "type": "integer",
@@ -2873,7 +3978,7 @@
2873
3978
  "json",
2874
3979
  "csv"
2875
3980
  ],
2876
- "description": "Output format (default: json)"
3981
+ "description": "Output format: json (default) or csv. Any other value is rejected."
2877
3982
  },
2878
3983
  "x402-payment-signature": {
2879
3984
  "type": "string",
@@ -2964,7 +4069,6 @@
2964
4069
  "viction"
2965
4070
  ],
2966
4071
  "smartMoneyLabels": [
2967
- "Fund",
2968
4072
  "Smart Trader",
2969
4073
  "30D Smart Trader",
2970
4074
  "90D Smart Trader",