nansen-cli 2.3.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.
- package/CHANGELOG.md +64 -0
- package/README.md +32 -32
- package/docs/auth.md +56 -0
- package/docs/browser-login.md +101 -7
- package/docs/error-codes.md +249 -0
- package/package.json +10 -4
- package/skills/nansen-agent-guide/SKILL.md +17 -1
- package/skills/nansen-alerts-webhook-listener/SKILL.md +1 -1
- package/skills/nansen-dca-tracker/SKILL.md +1 -1
- package/skills/nansen-defi-positions/SKILL.md +1 -1
- package/skills/nansen-exit-signals/SKILL.md +2 -2
- package/skills/nansen-fund-tracker/SKILL.md +1 -1
- package/skills/nansen-general-search/SKILL.md +1 -1
- package/skills/nansen-holder-analysis/SKILL.md +2 -2
- package/skills/nansen-limit-orders/SKILL.md +1 -1
- package/skills/nansen-mpp-payment/SKILL.md +2 -2
- package/skills/nansen-perp-screener/SKILL.md +1 -1
- package/skills/nansen-perp-trader-profile/SKILL.md +1 -1
- package/skills/nansen-polymarket-deep-dive/SKILL.md +1 -1
- package/skills/nansen-polymarket-insider-scan/SKILL.md +1 -1
- package/skills/nansen-polymarket-trader-profile/SKILL.md +1 -1
- package/skills/nansen-portfolio-tracker/SKILL.md +1 -1
- package/skills/nansen-prediction-markets/SKILL.md +1 -1
- package/skills/nansen-sm-cross-chain-flows/SKILL.md +1 -1
- package/skills/nansen-smart-alerts/SKILL.md +2 -1
- package/skills/nansen-smart-money-alpha/SKILL.md +1 -1
- package/skills/nansen-smart-money-tracker/SKILL.md +8 -7
- package/skills/nansen-smart-money-trend/SKILL.md +1 -1
- package/skills/nansen-token-research/SKILL.md +1 -1
- package/skills/nansen-token-screener/SKILL.md +1 -1
- package/skills/nansen-token-transfer-analysis/SKILL.md +1 -1
- package/skills/nansen-trading/SKILL.md +1 -1
- package/skills/nansen-wallet-batch/SKILL.md +1 -1
- package/skills/nansen-wallet-clustering/SKILL.md +1 -1
- package/skills/nansen-wallet-deep-dive/SKILL.md +1 -1
- package/skills/nansen-wallet-keychain-migration/SKILL.md +1 -1
- package/skills/nansen-wallet-manager/SKILL.md +1 -1
- package/skills/nansen-wallet-profiler/SKILL.md +1 -1
- package/skills/nansen-web-fetcher/SKILL.md +1 -1
- package/skills/nansen-web-searcher/SKILL.md +1 -1
- package/src/api-endpoints.json +1605 -0
- package/src/api.js +202 -97
- package/src/auth-credentials.js +1 -0
- package/src/auth-state.js +2 -2
- package/src/auth-store-native.js +6 -1
- package/src/auth-store-worker.js +1 -1
- package/src/auth-store.js +9 -4
- package/src/bridge.js +19 -10
- package/src/cli.js +188 -89
- package/src/commands/agent.js +2 -3
- package/src/commands/alerts.js +277 -9
- package/src/commands/feedback.js +98 -37
- package/src/commands/mcp.js +1 -1
- package/src/commands/research.js +14 -37
- package/src/cost-cache.js +33 -7
- package/src/doctor.js +14 -5
- package/src/error-codes.js +226 -0
- package/src/input-validation.js +551 -0
- package/src/limit-order.js +12 -3
- package/src/perp.js +2 -1
- package/src/privy.js +89 -11
- package/src/query-options.js +30 -7
- package/src/rpc-urls.js +3 -1
- package/src/schema.json +1137 -145
- package/src/solana-tx.js +4 -0
- package/src/trade-validation.js +167 -8
- package/src/trading.js +172 -12
- package/src/transfer.js +7 -1
- package/src/update-check.js +32 -5
- package/src/wallet.js +211 -57
- package/src/walletconnect-x402.js +14 -8
package/src/schema.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"commands": {
|
|
3
3
|
"feedback": {
|
|
4
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.
|
|
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
6
|
"subcommands": {
|
|
7
7
|
"submit": {
|
|
8
8
|
"description": "Submit a JSON report. Received means saved; human review may still be pending.",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"file": {
|
|
12
12
|
"type": "string",
|
|
13
13
|
"required": true,
|
|
14
|
-
"description": "JSON report file
|
|
14
|
+
"description": "JSON report file. Fields and categories are listed under report."
|
|
15
15
|
},
|
|
16
16
|
"submission-id": {
|
|
17
17
|
"type": "string",
|
|
@@ -41,13 +41,67 @@
|
|
|
41
41
|
"examples": [
|
|
42
42
|
"nansen feedback submit --file feedback.json --json",
|
|
43
43
|
"nansen feedback submit --file feedback.json --submission-id report-123 --json"
|
|
44
|
-
]
|
|
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
|
+
}
|
|
45
95
|
},
|
|
46
96
|
"get": {
|
|
47
97
|
"description": "Read the current receipt. Reviewed means triaged; closed means review complete. Neither promises a fix date.",
|
|
48
98
|
"endpoint": "/api/v1/feedback/{feedback_id}",
|
|
49
99
|
"args": [
|
|
50
|
-
|
|
100
|
+
{
|
|
101
|
+
"name": "feedback-id",
|
|
102
|
+
"required": true,
|
|
103
|
+
"description": "Feedback ID from a submit receipt, such as fb_01JA8Z6K2R7N4Q9V3T5W8X1Y2Z."
|
|
104
|
+
}
|
|
51
105
|
],
|
|
52
106
|
"options": {
|
|
53
107
|
"json": {
|
|
@@ -383,7 +437,7 @@
|
|
|
383
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)."
|
|
384
438
|
},
|
|
385
439
|
"bridge": {
|
|
386
|
-
"description": "Move funds between
|
|
440
|
+
"description": "Move funds between EVM chains and Hyperliquid",
|
|
387
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.",
|
|
388
442
|
"routes": [
|
|
389
443
|
{
|
|
@@ -554,9 +608,13 @@
|
|
|
554
608
|
"wallet": {
|
|
555
609
|
"type": "string",
|
|
556
610
|
"required": true,
|
|
557
|
-
"description": "Wallet address to fetch DeFi positions for"
|
|
611
|
+
"description": "Wallet address to fetch DeFi positions for",
|
|
612
|
+
"aliases": [
|
|
613
|
+
"address"
|
|
614
|
+
]
|
|
558
615
|
}
|
|
559
|
-
}
|
|
616
|
+
},
|
|
617
|
+
"pagination": false
|
|
560
618
|
}
|
|
561
619
|
},
|
|
562
620
|
"description": "Portfolio analytics"
|
|
@@ -571,6 +629,30 @@
|
|
|
571
629
|
"type": "string",
|
|
572
630
|
"default": "solana",
|
|
573
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
|
|
574
656
|
}
|
|
575
657
|
}
|
|
576
658
|
},
|
|
@@ -582,16 +664,86 @@
|
|
|
582
664
|
"type": "string",
|
|
583
665
|
"default": "solana",
|
|
584
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
|
|
585
691
|
}
|
|
586
692
|
}
|
|
587
693
|
},
|
|
588
694
|
"perp-trades": {
|
|
589
695
|
"endpoint": "/api/v1/smart-money/perp-trades",
|
|
590
|
-
"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
|
+
}
|
|
591
722
|
},
|
|
592
723
|
"dcas": {
|
|
593
724
|
"endpoint": "/api/v1/smart-money/dcas",
|
|
594
|
-
"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
|
+
}
|
|
595
747
|
},
|
|
596
748
|
"holdings": {
|
|
597
749
|
"endpoint": "/api/v1/smart-money/holdings",
|
|
@@ -601,6 +753,34 @@
|
|
|
601
753
|
"type": "string",
|
|
602
754
|
"default": "solana",
|
|
603
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"
|
|
604
784
|
}
|
|
605
785
|
}
|
|
606
786
|
},
|
|
@@ -618,6 +798,30 @@
|
|
|
618
798
|
"minimum": 0,
|
|
619
799
|
"default": 30,
|
|
620
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
|
|
621
825
|
}
|
|
622
826
|
}
|
|
623
827
|
}
|
|
@@ -645,6 +849,25 @@
|
|
|
645
849
|
"minimum": 0,
|
|
646
850
|
"default": 30,
|
|
647
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"
|
|
648
871
|
}
|
|
649
872
|
}
|
|
650
873
|
},
|
|
@@ -668,7 +891,8 @@
|
|
|
668
891
|
"default": 30,
|
|
669
892
|
"description": "Lookback window in days"
|
|
670
893
|
}
|
|
671
|
-
}
|
|
894
|
+
},
|
|
895
|
+
"pagination": false
|
|
672
896
|
},
|
|
673
897
|
"balance": {
|
|
674
898
|
"endpoint": "/api/v1/profiler/address/current-balance",
|
|
@@ -677,12 +901,36 @@
|
|
|
677
901
|
"address": {
|
|
678
902
|
"type": "string",
|
|
679
903
|
"required": true,
|
|
680
|
-
"description": "Wallet address to profile"
|
|
904
|
+
"description": "Wallet address to profile",
|
|
905
|
+
"requiredUnless": [
|
|
906
|
+
"entity"
|
|
907
|
+
]
|
|
681
908
|
},
|
|
682
909
|
"chain": {
|
|
683
910
|
"type": "string",
|
|
684
911
|
"default": "ethereum",
|
|
685
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"
|
|
686
934
|
}
|
|
687
935
|
}
|
|
688
936
|
},
|
|
@@ -705,6 +953,20 @@
|
|
|
705
953
|
"minimum": 0,
|
|
706
954
|
"default": 30,
|
|
707
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"
|
|
708
970
|
}
|
|
709
971
|
}
|
|
710
972
|
},
|
|
@@ -714,7 +976,12 @@
|
|
|
714
976
|
"options": {
|
|
715
977
|
"addresses": {
|
|
716
978
|
"type": "string",
|
|
717
|
-
"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
|
|
718
985
|
},
|
|
719
986
|
"file": {
|
|
720
987
|
"type": "string",
|
|
@@ -730,6 +997,20 @@
|
|
|
730
997
|
"minimum": 0,
|
|
731
998
|
"default": 30,
|
|
732
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"
|
|
733
1014
|
}
|
|
734
1015
|
}
|
|
735
1016
|
},
|
|
@@ -752,6 +1033,20 @@
|
|
|
752
1033
|
"minimum": 0,
|
|
753
1034
|
"default": 30,
|
|
754
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"
|
|
755
1050
|
}
|
|
756
1051
|
}
|
|
757
1052
|
},
|
|
@@ -768,6 +1063,15 @@
|
|
|
768
1063
|
"type": "string",
|
|
769
1064
|
"default": "ethereum",
|
|
770
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"
|
|
771
1075
|
}
|
|
772
1076
|
}
|
|
773
1077
|
},
|
|
@@ -780,7 +1084,8 @@
|
|
|
780
1084
|
"required": true,
|
|
781
1085
|
"description": "Address whose first funder to find"
|
|
782
1086
|
}
|
|
783
|
-
}
|
|
1087
|
+
},
|
|
1088
|
+
"pagination": false
|
|
784
1089
|
},
|
|
785
1090
|
"pnl": {
|
|
786
1091
|
"endpoint": "/api/v1/profiler/address/pnl",
|
|
@@ -801,6 +1106,25 @@
|
|
|
801
1106
|
"minimum": 0,
|
|
802
1107
|
"default": 30,
|
|
803
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"
|
|
804
1128
|
}
|
|
805
1129
|
}
|
|
806
1130
|
},
|
|
@@ -828,8 +1152,23 @@
|
|
|
828
1152
|
"type": "string",
|
|
829
1153
|
"required": true,
|
|
830
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"
|
|
831
1169
|
}
|
|
832
|
-
}
|
|
1170
|
+
},
|
|
1171
|
+
"pagination": false
|
|
833
1172
|
},
|
|
834
1173
|
"perp-trades": {
|
|
835
1174
|
"endpoint": "/api/v1/profiler/perp-trades",
|
|
@@ -845,6 +1184,20 @@
|
|
|
845
1184
|
"minimum": 0,
|
|
846
1185
|
"default": 30,
|
|
847
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"
|
|
848
1201
|
}
|
|
849
1202
|
}
|
|
850
1203
|
},
|
|
@@ -867,6 +1220,25 @@
|
|
|
867
1220
|
"minimum": 0,
|
|
868
1221
|
"default": 30,
|
|
869
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"
|
|
870
1242
|
}
|
|
871
1243
|
}
|
|
872
1244
|
},
|
|
@@ -879,7 +1251,8 @@
|
|
|
879
1251
|
"required": true,
|
|
880
1252
|
"description": "Entity or label name to search for"
|
|
881
1253
|
}
|
|
882
|
-
}
|
|
1254
|
+
},
|
|
1255
|
+
"pagination": false
|
|
883
1256
|
},
|
|
884
1257
|
"batch": {
|
|
885
1258
|
"description": "Batch profile multiple addresses",
|
|
@@ -892,14 +1265,29 @@
|
|
|
892
1265
|
"include": {
|
|
893
1266
|
"type": "string",
|
|
894
1267
|
"default": "labels,balance",
|
|
895
|
-
"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
|
|
896
1270
|
},
|
|
897
1271
|
"delay": {
|
|
898
1272
|
"type": "number",
|
|
899
1273
|
"default": 1000,
|
|
900
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"
|
|
901
1288
|
}
|
|
902
|
-
}
|
|
1289
|
+
},
|
|
1290
|
+
"pagination": false
|
|
903
1291
|
},
|
|
904
1292
|
"trace": {
|
|
905
1293
|
"description": "Multi-hop counterparty trace (BFS)",
|
|
@@ -935,7 +1323,8 @@
|
|
|
935
1323
|
"default": 1000,
|
|
936
1324
|
"description": "Delay in milliseconds between API calls"
|
|
937
1325
|
}
|
|
938
|
-
}
|
|
1326
|
+
},
|
|
1327
|
+
"pagination": false
|
|
939
1328
|
},
|
|
940
1329
|
"compare": {
|
|
941
1330
|
"description": "Compare two wallets (shared counterparties, tokens)",
|
|
@@ -943,7 +1332,8 @@
|
|
|
943
1332
|
"addresses": {
|
|
944
1333
|
"type": "string",
|
|
945
1334
|
"required": true,
|
|
946
|
-
"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
|
|
947
1337
|
},
|
|
948
1338
|
"chain": {
|
|
949
1339
|
"type": "string",
|
|
@@ -956,7 +1346,8 @@
|
|
|
956
1346
|
"default": 30,
|
|
957
1347
|
"description": "Lookback window in days"
|
|
958
1348
|
}
|
|
959
|
-
}
|
|
1349
|
+
},
|
|
1350
|
+
"pagination": false
|
|
960
1351
|
}
|
|
961
1352
|
},
|
|
962
1353
|
"description": "Wallet profiling - detailed information about any blockchain address"
|
|
@@ -975,7 +1366,10 @@
|
|
|
975
1366
|
"token": {
|
|
976
1367
|
"type": "string",
|
|
977
1368
|
"required": true,
|
|
978
|
-
"description": "Token contract address (mint address on Solana)"
|
|
1369
|
+
"description": "Token contract address (mint address on Solana)",
|
|
1370
|
+
"aliases": [
|
|
1371
|
+
"token-address"
|
|
1372
|
+
]
|
|
979
1373
|
},
|
|
980
1374
|
"days": {
|
|
981
1375
|
"type": "integer",
|
|
@@ -992,7 +1386,31 @@
|
|
|
992
1386
|
"whale",
|
|
993
1387
|
"exchange"
|
|
994
1388
|
],
|
|
995
|
-
"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"
|
|
996
1414
|
}
|
|
997
1415
|
}
|
|
998
1416
|
},
|
|
@@ -1008,7 +1426,10 @@
|
|
|
1008
1426
|
"token": {
|
|
1009
1427
|
"type": "string",
|
|
1010
1428
|
"required": true,
|
|
1011
|
-
"description": "Token contract address (mint address on Solana)"
|
|
1429
|
+
"description": "Token contract address (mint address on Solana)",
|
|
1430
|
+
"aliases": [
|
|
1431
|
+
"token-address"
|
|
1432
|
+
]
|
|
1012
1433
|
},
|
|
1013
1434
|
"days": {
|
|
1014
1435
|
"type": "integer",
|
|
@@ -1022,7 +1443,31 @@
|
|
|
1022
1443
|
"BUY",
|
|
1023
1444
|
"SELL"
|
|
1024
1445
|
],
|
|
1025
|
-
"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"
|
|
1026
1471
|
}
|
|
1027
1472
|
}
|
|
1028
1473
|
},
|
|
@@ -1038,13 +1483,34 @@
|
|
|
1038
1483
|
"token": {
|
|
1039
1484
|
"type": "string",
|
|
1040
1485
|
"required": true,
|
|
1041
|
-
"description": "Token contract address (mint address on Solana)"
|
|
1486
|
+
"description": "Token contract address (mint address on Solana)",
|
|
1487
|
+
"aliases": [
|
|
1488
|
+
"token-address"
|
|
1489
|
+
]
|
|
1042
1490
|
},
|
|
1043
1491
|
"days": {
|
|
1044
1492
|
"type": "integer",
|
|
1045
1493
|
"minimum": 0,
|
|
1046
1494
|
"default": 30,
|
|
1047
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"
|
|
1048
1514
|
}
|
|
1049
1515
|
}
|
|
1050
1516
|
},
|
|
@@ -1060,13 +1526,46 @@
|
|
|
1060
1526
|
"token": {
|
|
1061
1527
|
"type": "string",
|
|
1062
1528
|
"required": true,
|
|
1063
|
-
"description": "Token contract address (mint address on Solana)"
|
|
1529
|
+
"description": "Token contract address (mint address on Solana)",
|
|
1530
|
+
"aliases": [
|
|
1531
|
+
"token-address"
|
|
1532
|
+
]
|
|
1064
1533
|
},
|
|
1065
1534
|
"days": {
|
|
1066
1535
|
"type": "integer",
|
|
1067
1536
|
"minimum": 0,
|
|
1068
1537
|
"default": 30,
|
|
1069
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"
|
|
1070
1569
|
}
|
|
1071
1570
|
}
|
|
1072
1571
|
},
|
|
@@ -1082,19 +1581,40 @@
|
|
|
1082
1581
|
"token": {
|
|
1083
1582
|
"type": "string",
|
|
1084
1583
|
"required": true,
|
|
1085
|
-
"description": "Token contract address (mint address on Solana)"
|
|
1584
|
+
"description": "Token contract address (mint address on Solana)",
|
|
1585
|
+
"aliases": [
|
|
1586
|
+
"token-address"
|
|
1587
|
+
]
|
|
1086
1588
|
},
|
|
1087
1589
|
"premium-labels": {
|
|
1088
1590
|
"description": "Include premium Nansen labels in the response (true=premium, false=free-tier). When omitted, uses API default.",
|
|
1089
1591
|
"type": "boolean"
|
|
1090
|
-
}
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
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"
|
|
1610
|
+
}
|
|
1611
|
+
}
|
|
1612
|
+
},
|
|
1613
|
+
"pnl": {
|
|
1614
|
+
"endpoint": "/api/v1/tgm/pnl-leaderboard",
|
|
1615
|
+
"description": "PnL leaderboard",
|
|
1616
|
+
"options": {
|
|
1617
|
+
"chain": {
|
|
1098
1618
|
"type": "string",
|
|
1099
1619
|
"default": "solana",
|
|
1100
1620
|
"description": "Chain the token lives on"
|
|
@@ -1102,7 +1622,10 @@
|
|
|
1102
1622
|
"token": {
|
|
1103
1623
|
"type": "string",
|
|
1104
1624
|
"required": true,
|
|
1105
|
-
"description": "Token contract address (mint address on Solana)"
|
|
1625
|
+
"description": "Token contract address (mint address on Solana)",
|
|
1626
|
+
"aliases": [
|
|
1627
|
+
"token-address"
|
|
1628
|
+
]
|
|
1106
1629
|
},
|
|
1107
1630
|
"days": {
|
|
1108
1631
|
"type": "integer",
|
|
@@ -1113,6 +1636,24 @@
|
|
|
1113
1636
|
"premium-labels": {
|
|
1114
1637
|
"description": "Include premium Nansen labels in the response (true=premium, false=free-tier). When omitted, uses API default.",
|
|
1115
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"
|
|
1116
1657
|
}
|
|
1117
1658
|
}
|
|
1118
1659
|
},
|
|
@@ -1123,7 +1664,10 @@
|
|
|
1123
1664
|
"symbol": {
|
|
1124
1665
|
"type": "string",
|
|
1125
1666
|
"required": true,
|
|
1126
|
-
"description": "Perp symbol, e.g. BTC"
|
|
1667
|
+
"description": "Perp symbol, e.g. BTC",
|
|
1668
|
+
"aliases": [
|
|
1669
|
+
"token-symbol"
|
|
1670
|
+
]
|
|
1127
1671
|
},
|
|
1128
1672
|
"days": {
|
|
1129
1673
|
"type": "integer",
|
|
@@ -1134,6 +1678,24 @@
|
|
|
1134
1678
|
"premium-labels": {
|
|
1135
1679
|
"description": "Include premium Nansen labels in the response (true=premium, false=free-tier). When omitted, uses API default.",
|
|
1136
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"
|
|
1137
1699
|
}
|
|
1138
1700
|
}
|
|
1139
1701
|
},
|
|
@@ -1144,7 +1706,28 @@
|
|
|
1144
1706
|
"symbol": {
|
|
1145
1707
|
"type": "string",
|
|
1146
1708
|
"required": true,
|
|
1147
|
-
"description": "Perp symbol, e.g. BTC"
|
|
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"
|
|
1148
1731
|
}
|
|
1149
1732
|
}
|
|
1150
1733
|
},
|
|
@@ -1155,13 +1738,34 @@
|
|
|
1155
1738
|
"symbol": {
|
|
1156
1739
|
"type": "string",
|
|
1157
1740
|
"required": true,
|
|
1158
|
-
"description": "Perp symbol, e.g. BTC"
|
|
1741
|
+
"description": "Perp symbol, e.g. BTC",
|
|
1742
|
+
"aliases": [
|
|
1743
|
+
"token-symbol"
|
|
1744
|
+
]
|
|
1159
1745
|
},
|
|
1160
1746
|
"days": {
|
|
1161
1747
|
"type": "integer",
|
|
1162
1748
|
"minimum": 0,
|
|
1163
1749
|
"default": 30,
|
|
1164
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"
|
|
1165
1769
|
}
|
|
1166
1770
|
}
|
|
1167
1771
|
},
|
|
@@ -1177,14 +1781,18 @@
|
|
|
1177
1781
|
"token": {
|
|
1178
1782
|
"type": "string",
|
|
1179
1783
|
"required": true,
|
|
1180
|
-
"description": "Token contract address (mint address on Solana)"
|
|
1784
|
+
"description": "Token contract address (mint address on Solana)",
|
|
1785
|
+
"aliases": [
|
|
1786
|
+
"token-address"
|
|
1787
|
+
]
|
|
1181
1788
|
},
|
|
1182
1789
|
"timeframe": {
|
|
1183
1790
|
"type": "string",
|
|
1184
1791
|
"default": "1d",
|
|
1185
1792
|
"description": "Time window for the flow metrics"
|
|
1186
1793
|
}
|
|
1187
|
-
}
|
|
1794
|
+
},
|
|
1795
|
+
"pagination": false
|
|
1188
1796
|
},
|
|
1189
1797
|
"info": {
|
|
1190
1798
|
"endpoint": "/api/v1/tgm/token-information",
|
|
@@ -1198,14 +1806,18 @@
|
|
|
1198
1806
|
"token": {
|
|
1199
1807
|
"type": "string",
|
|
1200
1808
|
"required": true,
|
|
1201
|
-
"description": "Token contract address (mint address on Solana)"
|
|
1809
|
+
"description": "Token contract address (mint address on Solana)",
|
|
1810
|
+
"aliases": [
|
|
1811
|
+
"token-address"
|
|
1812
|
+
]
|
|
1202
1813
|
},
|
|
1203
1814
|
"timeframe": {
|
|
1204
1815
|
"type": "string",
|
|
1205
1816
|
"default": "1d",
|
|
1206
1817
|
"description": "Time window for the price-change and volume fields"
|
|
1207
1818
|
}
|
|
1208
|
-
}
|
|
1819
|
+
},
|
|
1820
|
+
"pagination": false
|
|
1209
1821
|
},
|
|
1210
1822
|
"indicators": {
|
|
1211
1823
|
"endpoint": "/api/v1/tgm/indicators",
|
|
@@ -1219,9 +1831,13 @@
|
|
|
1219
1831
|
"token": {
|
|
1220
1832
|
"type": "string",
|
|
1221
1833
|
"required": true,
|
|
1222
|
-
"description": "Token contract address"
|
|
1834
|
+
"description": "Token contract address",
|
|
1835
|
+
"aliases": [
|
|
1836
|
+
"token-address"
|
|
1837
|
+
]
|
|
1223
1838
|
}
|
|
1224
|
-
}
|
|
1839
|
+
},
|
|
1840
|
+
"pagination": false
|
|
1225
1841
|
},
|
|
1226
1842
|
"ohlcv": {
|
|
1227
1843
|
"endpoint": "/api/v1/tgm/token-ohlcv",
|
|
@@ -1235,23 +1851,40 @@
|
|
|
1235
1851
|
"token": {
|
|
1236
1852
|
"type": "string",
|
|
1237
1853
|
"required": true,
|
|
1238
|
-
"description": "Token contract address (mint address on Solana)"
|
|
1854
|
+
"description": "Token contract address (mint address on Solana)",
|
|
1855
|
+
"aliases": [
|
|
1856
|
+
"token-address"
|
|
1857
|
+
]
|
|
1239
1858
|
},
|
|
1240
1859
|
"timeframe": {
|
|
1241
1860
|
"type": "string",
|
|
1242
1861
|
"default": "1d",
|
|
1243
1862
|
"description": "Candle interval"
|
|
1244
1863
|
}
|
|
1245
|
-
}
|
|
1864
|
+
},
|
|
1865
|
+
"pagination": false
|
|
1246
1866
|
},
|
|
1247
1867
|
"jup-dca": {
|
|
1248
1868
|
"endpoint": "/api/v1/tgm/jup-dca",
|
|
1249
1869
|
"description": "Jupiter DCA orders for token",
|
|
1870
|
+
"examples": ["nansen research token jup-dca --token So11111111111111111111111111111111111111112"],
|
|
1250
1871
|
"options": {
|
|
1251
1872
|
"token": {
|
|
1252
1873
|
"type": "string",
|
|
1253
1874
|
"required": true,
|
|
1254
|
-
"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"
|
|
1255
1888
|
}
|
|
1256
1889
|
}
|
|
1257
1890
|
},
|
|
@@ -1271,11 +1904,35 @@
|
|
|
1271
1904
|
},
|
|
1272
1905
|
"include-stablecoins": {
|
|
1273
1906
|
"description": "Whether to include stablecoins in screener results (default true on API side)",
|
|
1274
|
-
"default": true
|
|
1907
|
+
"default": true,
|
|
1908
|
+
"type": "boolean"
|
|
1275
1909
|
},
|
|
1276
1910
|
"search": {
|
|
1277
1911
|
"type": "string",
|
|
1278
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
|
|
1279
1936
|
}
|
|
1280
1937
|
}
|
|
1281
1938
|
},
|
|
@@ -1289,14 +1946,19 @@
|
|
|
1289
1946
|
"lowcap",
|
|
1290
1947
|
"midcap",
|
|
1291
1948
|
"largecap"
|
|
1292
|
-
]
|
|
1949
|
+
],
|
|
1950
|
+
"aliases": [
|
|
1951
|
+
"market-cap-group"
|
|
1952
|
+
],
|
|
1953
|
+
"type": "string"
|
|
1293
1954
|
},
|
|
1294
1955
|
"limit": {
|
|
1295
1956
|
"type": "number",
|
|
1296
1957
|
"default": 25,
|
|
1297
1958
|
"description": "Number of tokens to return"
|
|
1298
1959
|
}
|
|
1299
|
-
}
|
|
1960
|
+
},
|
|
1961
|
+
"pagination": false
|
|
1300
1962
|
}
|
|
1301
1963
|
},
|
|
1302
1964
|
"description": "Token God Mode - deep analytics for any token"
|
|
@@ -1308,7 +1970,8 @@
|
|
|
1308
1970
|
"query": {
|
|
1309
1971
|
"type": "string",
|
|
1310
1972
|
"required": true,
|
|
1311
|
-
"description": "Token name, symbol, or address, or an entity name"
|
|
1973
|
+
"description": "Token name, symbol, or address, or an entity name",
|
|
1974
|
+
"positional": true
|
|
1312
1975
|
},
|
|
1313
1976
|
"type": {
|
|
1314
1977
|
"type": "string",
|
|
@@ -1320,8 +1983,13 @@
|
|
|
1320
1983
|
"type": "number",
|
|
1321
1984
|
"default": 25,
|
|
1322
1985
|
"description": "Maximum number of results"
|
|
1986
|
+
},
|
|
1987
|
+
"chain": {
|
|
1988
|
+
"type": "string",
|
|
1989
|
+
"description": "Only results on this chain"
|
|
1323
1990
|
}
|
|
1324
|
-
}
|
|
1991
|
+
},
|
|
1992
|
+
"pagination": false
|
|
1325
1993
|
},
|
|
1326
1994
|
"perp": {
|
|
1327
1995
|
"subcommands": {
|
|
@@ -1343,16 +2011,37 @@
|
|
|
1343
2011
|
"whale",
|
|
1344
2012
|
"public_figure",
|
|
1345
2013
|
"high_winrate_hl_perps_trader"
|
|
1346
|
-
]
|
|
2014
|
+
],
|
|
2015
|
+
"type": "string"
|
|
1347
2016
|
},
|
|
1348
2017
|
"sectors-filter": {
|
|
1349
|
-
"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
|
|
1350
2021
|
},
|
|
1351
2022
|
"sm-label-filter": {
|
|
1352
|
-
"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
|
|
1353
2026
|
},
|
|
1354
2027
|
"trader-label-filter": {
|
|
1355
|
-
"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"
|
|
1356
2045
|
}
|
|
1357
2046
|
}
|
|
1358
2047
|
},
|
|
@@ -1369,6 +2058,20 @@
|
|
|
1369
2058
|
"premium-labels": {
|
|
1370
2059
|
"description": "Include premium Nansen labels in the response (true=premium, false=free-tier). When omitted, uses API default.",
|
|
1371
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"
|
|
1372
2075
|
}
|
|
1373
2076
|
}
|
|
1374
2077
|
}
|
|
@@ -1385,6 +2088,15 @@
|
|
|
1385
2088
|
"type": "string",
|
|
1386
2089
|
"required": true,
|
|
1387
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"
|
|
1388
2100
|
}
|
|
1389
2101
|
}
|
|
1390
2102
|
},
|
|
@@ -1407,6 +2119,15 @@
|
|
|
1407
2119
|
"type": "string",
|
|
1408
2120
|
"required": true,
|
|
1409
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"
|
|
1410
2131
|
}
|
|
1411
2132
|
}
|
|
1412
2133
|
},
|
|
@@ -1418,6 +2139,15 @@
|
|
|
1418
2139
|
"type": "string",
|
|
1419
2140
|
"required": true,
|
|
1420
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"
|
|
1421
2151
|
}
|
|
1422
2152
|
}
|
|
1423
2153
|
},
|
|
@@ -1431,11 +2161,13 @@
|
|
|
1431
2161
|
"description": "Text filter on market titles"
|
|
1432
2162
|
},
|
|
1433
2163
|
"sort-by": {
|
|
1434
|
-
"description": "Deprecated: use --sort field:dir instead"
|
|
2164
|
+
"description": "Deprecated: use --sort field:dir instead",
|
|
2165
|
+
"type": "string"
|
|
1435
2166
|
},
|
|
1436
2167
|
"tags": {
|
|
1437
2168
|
"type": "string",
|
|
1438
|
-
"description": "Comma-separated Polymarket tags to filter by"
|
|
2169
|
+
"description": "Comma-separated Polymarket tags to filter by",
|
|
2170
|
+
"repeatable": true
|
|
1439
2171
|
},
|
|
1440
2172
|
"min-liquidity": {
|
|
1441
2173
|
"type": "number",
|
|
@@ -1445,10 +2177,6 @@
|
|
|
1445
2177
|
"type": "number",
|
|
1446
2178
|
"description": "Maximum liquidity in USD"
|
|
1447
2179
|
},
|
|
1448
|
-
"min-unique-traders-24h": {
|
|
1449
|
-
"type": "number",
|
|
1450
|
-
"description": "Minimum unique traders in the last 24 hours"
|
|
1451
|
-
},
|
|
1452
2180
|
"max-unique-traders-24h": {
|
|
1453
2181
|
"type": "number",
|
|
1454
2182
|
"description": "Maximum unique traders in the last 24 hours"
|
|
@@ -1457,10 +2185,6 @@
|
|
|
1457
2185
|
"type": "number",
|
|
1458
2186
|
"description": "Minimum 24-hour volume in USD"
|
|
1459
2187
|
},
|
|
1460
|
-
"max-volume-24hr": {
|
|
1461
|
-
"type": "number",
|
|
1462
|
-
"description": "Maximum 24-hour volume in USD"
|
|
1463
|
-
},
|
|
1464
2188
|
"neg-risk": {
|
|
1465
2189
|
"type": "boolean",
|
|
1466
2190
|
"enum": ["true", "false"],
|
|
@@ -1489,6 +2213,19 @@
|
|
|
1489
2213
|
"max-price": {
|
|
1490
2214
|
"type": "number",
|
|
1491
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"
|
|
1492
2229
|
}
|
|
1493
2230
|
}
|
|
1494
2231
|
},
|
|
@@ -1502,11 +2239,13 @@
|
|
|
1502
2239
|
"description": "Text filter on event titles"
|
|
1503
2240
|
},
|
|
1504
2241
|
"sort-by": {
|
|
1505
|
-
"description": "Deprecated: use --sort field:dir instead"
|
|
2242
|
+
"description": "Deprecated: use --sort field:dir instead",
|
|
2243
|
+
"type": "string"
|
|
1506
2244
|
},
|
|
1507
2245
|
"tags": {
|
|
1508
2246
|
"type": "string",
|
|
1509
|
-
"description": "Comma-separated Polymarket tags to filter by"
|
|
2247
|
+
"description": "Comma-separated Polymarket tags to filter by",
|
|
2248
|
+
"repeatable": true
|
|
1510
2249
|
},
|
|
1511
2250
|
"min-liquidity": {
|
|
1512
2251
|
"type": "number",
|
|
@@ -1516,10 +2255,6 @@
|
|
|
1516
2255
|
"type": "number",
|
|
1517
2256
|
"description": "Maximum liquidity in USD"
|
|
1518
2257
|
},
|
|
1519
|
-
"min-unique-traders-24h": {
|
|
1520
|
-
"type": "number",
|
|
1521
|
-
"description": "Minimum unique traders in the last 24 hours"
|
|
1522
|
-
},
|
|
1523
2258
|
"max-unique-traders-24h": {
|
|
1524
2259
|
"type": "number",
|
|
1525
2260
|
"description": "Maximum unique traders in the last 24 hours"
|
|
@@ -1528,10 +2263,6 @@
|
|
|
1528
2263
|
"type": "number",
|
|
1529
2264
|
"description": "Minimum 24-hour volume in USD"
|
|
1530
2265
|
},
|
|
1531
|
-
"max-volume-24hr": {
|
|
1532
|
-
"type": "number",
|
|
1533
|
-
"description": "Maximum 24-hour volume in USD"
|
|
1534
|
-
},
|
|
1535
2266
|
"neg-risk": {
|
|
1536
2267
|
"type": "boolean",
|
|
1537
2268
|
"enum": ["true", "false"],
|
|
@@ -1552,6 +2283,19 @@
|
|
|
1552
2283
|
"end-date-after": {
|
|
1553
2284
|
"type": "string",
|
|
1554
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"
|
|
1555
2299
|
}
|
|
1556
2300
|
}
|
|
1557
2301
|
},
|
|
@@ -1563,6 +2307,15 @@
|
|
|
1563
2307
|
"type": "string",
|
|
1564
2308
|
"required": true,
|
|
1565
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"
|
|
1566
2319
|
}
|
|
1567
2320
|
}
|
|
1568
2321
|
},
|
|
@@ -1574,6 +2327,15 @@
|
|
|
1574
2327
|
"type": "string",
|
|
1575
2328
|
"required": true,
|
|
1576
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"
|
|
1577
2339
|
}
|
|
1578
2340
|
}
|
|
1579
2341
|
},
|
|
@@ -1596,6 +2358,15 @@
|
|
|
1596
2358
|
"type": "string",
|
|
1597
2359
|
"required": true,
|
|
1598
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"
|
|
1599
2370
|
}
|
|
1600
2371
|
}
|
|
1601
2372
|
},
|
|
@@ -1641,11 +2412,13 @@
|
|
|
1641
2412
|
"default": "all",
|
|
1642
2413
|
"description": "Include all chains or only EVM chains"
|
|
1643
2414
|
}
|
|
1644
|
-
}
|
|
2415
|
+
},
|
|
2416
|
+
"pagination": false
|
|
1645
2417
|
},
|
|
1646
2418
|
"token-sectors": {
|
|
1647
2419
|
"endpoint": "/api/v1/search/token-sectors",
|
|
1648
|
-
"description": "List token sectors available for filtering"
|
|
2420
|
+
"description": "List token sectors available for filtering",
|
|
2421
|
+
"pagination": false
|
|
1649
2422
|
},
|
|
1650
2423
|
"address-premium-labels": {
|
|
1651
2424
|
"endpoint": "/api/v1/profiler/address/premium-labels",
|
|
@@ -1679,7 +2452,9 @@
|
|
|
1679
2452
|
"options": {
|
|
1680
2453
|
"chains": {
|
|
1681
2454
|
"default": "solana",
|
|
1682
|
-
"description": "Comma-separated chains"
|
|
2455
|
+
"description": "Comma-separated chains",
|
|
2456
|
+
"type": "string",
|
|
2457
|
+
"repeatable": true
|
|
1683
2458
|
},
|
|
1684
2459
|
"timeframe-days": {
|
|
1685
2460
|
"type": "number",
|
|
@@ -1689,7 +2464,8 @@
|
|
|
1689
2464
|
},
|
|
1690
2465
|
"filters": {
|
|
1691
2466
|
"type": "string",
|
|
1692
|
-
"description": "Filters as JSON object"
|
|
2467
|
+
"description": "Filters as JSON object",
|
|
2468
|
+
"format": "json"
|
|
1693
2469
|
},
|
|
1694
2470
|
"sort": {
|
|
1695
2471
|
"type": "string",
|
|
@@ -1703,6 +2479,15 @@
|
|
|
1703
2479
|
"limit": {
|
|
1704
2480
|
"type": "number",
|
|
1705
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"
|
|
1706
2491
|
}
|
|
1707
2492
|
}
|
|
1708
2493
|
},
|
|
@@ -1712,9 +2497,15 @@
|
|
|
1712
2497
|
"options": {
|
|
1713
2498
|
"symbol": {
|
|
1714
2499
|
"required": true,
|
|
1715
|
-
"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
|
+
]
|
|
1716
2506
|
}
|
|
1717
|
-
}
|
|
2507
|
+
},
|
|
2508
|
+
"pagination": false
|
|
1718
2509
|
},
|
|
1719
2510
|
"perp-pnl-summary": {
|
|
1720
2511
|
"endpoint": "/api/v1/profiler/perp-pnl-summary",
|
|
@@ -1727,13 +2518,18 @@
|
|
|
1727
2518
|
},
|
|
1728
2519
|
"from-date": {
|
|
1729
2520
|
"required": true,
|
|
1730
|
-
"description": "Start of date range"
|
|
2521
|
+
"description": "Start of date range",
|
|
2522
|
+
"type": "string",
|
|
2523
|
+
"format": "date-time"
|
|
1731
2524
|
},
|
|
1732
2525
|
"to-date": {
|
|
1733
2526
|
"required": true,
|
|
1734
|
-
"description": "End of date range"
|
|
2527
|
+
"description": "End of date range",
|
|
2528
|
+
"type": "string",
|
|
2529
|
+
"format": "date-time"
|
|
1735
2530
|
}
|
|
1736
|
-
}
|
|
2531
|
+
},
|
|
2532
|
+
"pagination": false
|
|
1737
2533
|
},
|
|
1738
2534
|
"historical-token-ohlcv": {
|
|
1739
2535
|
"endpoint": "/api/v1beta1/tgm/historical-token-ohlcv",
|
|
@@ -1741,35 +2537,50 @@
|
|
|
1741
2537
|
"options": {
|
|
1742
2538
|
"token-address": {
|
|
1743
2539
|
"required": true,
|
|
1744
|
-
"description": "Token address or Hyperliquid asset symbol"
|
|
2540
|
+
"description": "Token address or Hyperliquid asset symbol",
|
|
2541
|
+
"type": "string",
|
|
2542
|
+
"aliases": [
|
|
2543
|
+
"token"
|
|
2544
|
+
]
|
|
1745
2545
|
},
|
|
1746
2546
|
"chain": {
|
|
1747
2547
|
"type": "string",
|
|
1748
|
-
"enum": ["base", "bnb", "ethereum", "hyperliquid", "solana"],
|
|
1749
2548
|
"default": "solana",
|
|
1750
2549
|
"description": "Chain the token lives on"
|
|
1751
2550
|
},
|
|
1752
2551
|
"from-date": {
|
|
1753
2552
|
"required": true,
|
|
1754
|
-
"description": "Start of data window"
|
|
2553
|
+
"description": "Start of data window",
|
|
2554
|
+
"type": "string"
|
|
1755
2555
|
},
|
|
1756
2556
|
"as-of-date": {
|
|
1757
|
-
"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"
|
|
1758
2559
|
},
|
|
1759
2560
|
"as-of-ts": {
|
|
1760
|
-
"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"
|
|
1761
2563
|
},
|
|
1762
2564
|
"timeframe": {
|
|
1763
2565
|
"type": "string",
|
|
1764
2566
|
"required": true,
|
|
1765
|
-
"enum": [
|
|
2567
|
+
"enum": [
|
|
2568
|
+
"5m",
|
|
2569
|
+
"15m",
|
|
2570
|
+
"30m",
|
|
2571
|
+
"1h",
|
|
2572
|
+
"4h",
|
|
2573
|
+
"1d",
|
|
2574
|
+
"1w"
|
|
2575
|
+
],
|
|
1766
2576
|
"description": "Candle interval"
|
|
1767
2577
|
},
|
|
1768
2578
|
"apply-blacklist-filter": {
|
|
1769
2579
|
"type": "boolean",
|
|
1770
2580
|
"description": "Apply blacklist filtering for 1d/1w non-Hyperliquid requests"
|
|
1771
2581
|
}
|
|
1772
|
-
}
|
|
2582
|
+
},
|
|
2583
|
+
"pagination": false
|
|
1773
2584
|
},
|
|
1774
2585
|
"transaction-with-token-transfer-lookup": {
|
|
1775
2586
|
"endpoint": "/api/v1/transaction-with-token-transfer-lookup",
|
|
@@ -1782,14 +2593,15 @@
|
|
|
1782
2593
|
},
|
|
1783
2594
|
"chain": {
|
|
1784
2595
|
"type": "string",
|
|
1785
|
-
"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"],
|
|
1786
2596
|
"default": "ethereum",
|
|
1787
2597
|
"description": "Chain the transaction was made on"
|
|
1788
2598
|
},
|
|
1789
2599
|
"block-timestamp": {
|
|
1790
|
-
"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"
|
|
1791
2602
|
}
|
|
1792
|
-
}
|
|
2603
|
+
},
|
|
2604
|
+
"pagination": false
|
|
1793
2605
|
},
|
|
1794
2606
|
"historical-dex-trades": {
|
|
1795
2607
|
"endpoint": "/api/v1/tgm/historical-dex-trades",
|
|
@@ -1797,19 +2609,42 @@
|
|
|
1797
2609
|
"options": {
|
|
1798
2610
|
"token-address": {
|
|
1799
2611
|
"required": true,
|
|
1800
|
-
"description": "Token address"
|
|
2612
|
+
"description": "Token address",
|
|
2613
|
+
"type": "string",
|
|
2614
|
+
"aliases": [
|
|
2615
|
+
"token"
|
|
2616
|
+
]
|
|
1801
2617
|
},
|
|
1802
2618
|
"from-date": {
|
|
1803
2619
|
"required": true,
|
|
1804
|
-
"description": "Start of date range (YYYY-MM-DD)"
|
|
2620
|
+
"description": "Start of date range (YYYY-MM-DD)",
|
|
2621
|
+
"type": "string",
|
|
2622
|
+
"format": "date-time"
|
|
1805
2623
|
},
|
|
1806
2624
|
"to-date": {
|
|
1807
2625
|
"required": true,
|
|
1808
|
-
"description": "End of date range (YYYY-MM-DD)"
|
|
2626
|
+
"description": "End of date range (YYYY-MM-DD)",
|
|
2627
|
+
"type": "string",
|
|
2628
|
+
"format": "date-time"
|
|
1809
2629
|
},
|
|
1810
2630
|
"chain": {
|
|
1811
2631
|
"default": "solana",
|
|
1812
|
-
"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"
|
|
1813
2648
|
}
|
|
1814
2649
|
}
|
|
1815
2650
|
},
|
|
@@ -1819,43 +2654,76 @@
|
|
|
1819
2654
|
"options": {
|
|
1820
2655
|
"token-address": {
|
|
1821
2656
|
"required": true,
|
|
1822
|
-
"description": "Token address"
|
|
2657
|
+
"description": "Token address",
|
|
2658
|
+
"type": "string",
|
|
2659
|
+
"aliases": [
|
|
2660
|
+
"token"
|
|
2661
|
+
]
|
|
1823
2662
|
},
|
|
1824
2663
|
"from-date": {
|
|
1825
2664
|
"required": true,
|
|
1826
|
-
"description": "Start of date range (YYYY-MM-DD)"
|
|
2665
|
+
"description": "Start of date range (YYYY-MM-DD)",
|
|
2666
|
+
"type": "string",
|
|
2667
|
+
"format": "date-time"
|
|
1827
2668
|
},
|
|
1828
2669
|
"to-date": {
|
|
1829
2670
|
"required": true,
|
|
1830
|
-
"description": "End of date range (YYYY-MM-DD)"
|
|
2671
|
+
"description": "End of date range (YYYY-MM-DD)",
|
|
2672
|
+
"type": "string",
|
|
2673
|
+
"format": "date-time"
|
|
1831
2674
|
},
|
|
1832
2675
|
"chain": {
|
|
1833
2676
|
"default": "solana",
|
|
1834
|
-
"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"
|
|
1835
2693
|
}
|
|
1836
2694
|
}
|
|
1837
2695
|
},
|
|
1838
2696
|
"historical-token-flow-summary": {
|
|
1839
2697
|
"endpoint": "/api/v1/tgm/historical-token-flow-summary",
|
|
1840
|
-
"description": "Historical token flow summary (no pagination)",
|
|
2698
|
+
"description": "Historical token flow summary (no pagination; whale, public figure, top PnL and exchange segments start 2025-03-11)",
|
|
1841
2699
|
"options": {
|
|
1842
2700
|
"token-address": {
|
|
1843
2701
|
"required": true,
|
|
1844
|
-
"description": "Token address"
|
|
2702
|
+
"description": "Token address",
|
|
2703
|
+
"type": "string",
|
|
2704
|
+
"aliases": [
|
|
2705
|
+
"token"
|
|
2706
|
+
]
|
|
1845
2707
|
},
|
|
1846
2708
|
"from-date": {
|
|
1847
2709
|
"required": true,
|
|
1848
|
-
"description": "Start of date range (YYYY-MM-DD)"
|
|
2710
|
+
"description": "Start of date range (YYYY-MM-DD)",
|
|
2711
|
+
"type": "string",
|
|
2712
|
+
"format": "date-time"
|
|
1849
2713
|
},
|
|
1850
2714
|
"to-date": {
|
|
1851
2715
|
"required": true,
|
|
1852
|
-
"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"
|
|
1853
2719
|
},
|
|
1854
2720
|
"chain": {
|
|
1855
2721
|
"default": "solana",
|
|
1856
|
-
"description": "Chain"
|
|
2722
|
+
"description": "Chain",
|
|
2723
|
+
"type": "string"
|
|
1857
2724
|
}
|
|
1858
|
-
}
|
|
2725
|
+
},
|
|
2726
|
+
"pagination": false
|
|
1859
2727
|
},
|
|
1860
2728
|
"historical-token-quant-scores": {
|
|
1861
2729
|
"endpoint": "/api/v1/tgm/historical-token-quant-scores",
|
|
@@ -1863,17 +2731,25 @@
|
|
|
1863
2731
|
"options": {
|
|
1864
2732
|
"token-address": {
|
|
1865
2733
|
"required": true,
|
|
1866
|
-
"description": "Token address"
|
|
2734
|
+
"description": "Token address",
|
|
2735
|
+
"type": "string",
|
|
2736
|
+
"aliases": [
|
|
2737
|
+
"token"
|
|
2738
|
+
]
|
|
1867
2739
|
},
|
|
1868
2740
|
"as-of-date": {
|
|
1869
2741
|
"required": true,
|
|
1870
|
-
"description": "Snapshot date (YYYY-MM-DD)"
|
|
2742
|
+
"description": "Snapshot date (YYYY-MM-DD)",
|
|
2743
|
+
"type": "string",
|
|
2744
|
+
"format": "date"
|
|
1871
2745
|
},
|
|
1872
2746
|
"chain": {
|
|
1873
2747
|
"default": "solana",
|
|
1874
|
-
"description": "Chain"
|
|
2748
|
+
"description": "Chain",
|
|
2749
|
+
"type": "string"
|
|
1875
2750
|
}
|
|
1876
|
-
}
|
|
2751
|
+
},
|
|
2752
|
+
"pagination": false
|
|
1877
2753
|
},
|
|
1878
2754
|
"historical-top-holders": {
|
|
1879
2755
|
"endpoint": "/api/v1/tgm/historical-top-holders",
|
|
@@ -1881,15 +2757,36 @@
|
|
|
1881
2757
|
"options": {
|
|
1882
2758
|
"token-address": {
|
|
1883
2759
|
"required": true,
|
|
1884
|
-
"description": "Token address"
|
|
2760
|
+
"description": "Token address",
|
|
2761
|
+
"type": "string",
|
|
2762
|
+
"aliases": [
|
|
2763
|
+
"token"
|
|
2764
|
+
]
|
|
1885
2765
|
},
|
|
1886
2766
|
"as-of-date": {
|
|
1887
2767
|
"required": true,
|
|
1888
|
-
"description": "Snapshot date (YYYY-MM-DD)"
|
|
2768
|
+
"description": "Snapshot date (YYYY-MM-DD)",
|
|
2769
|
+
"type": "string",
|
|
2770
|
+
"format": "date"
|
|
1889
2771
|
},
|
|
1890
2772
|
"chain": {
|
|
1891
2773
|
"default": "solana",
|
|
1892
|
-
"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"
|
|
1893
2790
|
}
|
|
1894
2791
|
}
|
|
1895
2792
|
},
|
|
@@ -1899,23 +2796,47 @@
|
|
|
1899
2796
|
"options": {
|
|
1900
2797
|
"token-address": {
|
|
1901
2798
|
"required": true,
|
|
1902
|
-
"description": "Token address"
|
|
2799
|
+
"description": "Token address",
|
|
2800
|
+
"type": "string",
|
|
2801
|
+
"aliases": [
|
|
2802
|
+
"token"
|
|
2803
|
+
]
|
|
1903
2804
|
},
|
|
1904
2805
|
"from-date": {
|
|
1905
2806
|
"required": true,
|
|
1906
|
-
"description": "Start of date range (YYYY-MM-DD)"
|
|
2807
|
+
"description": "Start of date range (YYYY-MM-DD)",
|
|
2808
|
+
"type": "string",
|
|
2809
|
+
"format": "date-time"
|
|
1907
2810
|
},
|
|
1908
2811
|
"to-date": {
|
|
1909
2812
|
"required": true,
|
|
1910
|
-
"description": "End of date range (YYYY-MM-DD)"
|
|
2813
|
+
"description": "End of date range (YYYY-MM-DD)",
|
|
2814
|
+
"type": "string",
|
|
2815
|
+
"format": "date-time"
|
|
1911
2816
|
},
|
|
1912
2817
|
"buy-or-sell": {
|
|
1913
2818
|
"default": "BUY",
|
|
1914
|
-
"description": "BUY or SELL"
|
|
2819
|
+
"description": "BUY or SELL",
|
|
2820
|
+
"type": "string"
|
|
1915
2821
|
},
|
|
1916
2822
|
"chain": {
|
|
1917
2823
|
"default": "solana",
|
|
1918
|
-
"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"
|
|
1919
2840
|
}
|
|
1920
2841
|
}
|
|
1921
2842
|
},
|
|
@@ -1925,11 +2846,24 @@
|
|
|
1925
2846
|
"options": {
|
|
1926
2847
|
"as-of-date": {
|
|
1927
2848
|
"required": true,
|
|
1928
|
-
"description": "Snapshot date (YYYY-MM-DD)"
|
|
2849
|
+
"description": "Snapshot date (YYYY-MM-DD)",
|
|
2850
|
+
"type": "string",
|
|
2851
|
+
"format": "date"
|
|
1929
2852
|
},
|
|
1930
2853
|
"chains": {
|
|
1931
2854
|
"default": "solana",
|
|
1932
|
-
"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"
|
|
1933
2867
|
}
|
|
1934
2868
|
}
|
|
1935
2869
|
},
|
|
@@ -1944,11 +2878,33 @@
|
|
|
1944
2878
|
},
|
|
1945
2879
|
"to-date": {
|
|
1946
2880
|
"required": true,
|
|
1947
|
-
"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"
|
|
1948
2884
|
},
|
|
1949
2885
|
"chains": {
|
|
1950
2886
|
"default": "solana",
|
|
1951
|
-
"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"
|
|
1952
2908
|
}
|
|
1953
2909
|
}
|
|
1954
2910
|
},
|
|
@@ -1958,38 +2914,48 @@
|
|
|
1958
2914
|
"options": {
|
|
1959
2915
|
"address": {
|
|
1960
2916
|
"required": true,
|
|
1961
|
-
"description": "Wallet address"
|
|
2917
|
+
"description": "Wallet address",
|
|
2918
|
+
"type": "string"
|
|
1962
2919
|
},
|
|
1963
2920
|
"as-of-date": {
|
|
1964
2921
|
"required": true,
|
|
1965
|
-
"description": "Snapshot date (YYYY-MM-DD)"
|
|
2922
|
+
"description": "Snapshot date (YYYY-MM-DD)",
|
|
2923
|
+
"type": "string",
|
|
2924
|
+
"format": "date"
|
|
1966
2925
|
},
|
|
1967
2926
|
"chain": {
|
|
1968
2927
|
"default": "ethereum",
|
|
1969
|
-
"description": "Chain"
|
|
2928
|
+
"description": "Chain",
|
|
2929
|
+
"type": "string"
|
|
1970
2930
|
}
|
|
1971
2931
|
}
|
|
1972
2932
|
},
|
|
1973
2933
|
"historical-tx-lookup": {
|
|
1974
2934
|
"endpoint": "/api/v1/profiler/historical-transaction-lookup",
|
|
1975
|
-
"description": "Lookup a historical transaction by hash",
|
|
2935
|
+
"description": "Lookup a historical transaction by hash (entity labels start 2025-03-11)",
|
|
1976
2936
|
"options": {
|
|
1977
2937
|
"transaction-hash": {
|
|
1978
2938
|
"required": true,
|
|
1979
|
-
"description": "Transaction hash (0x-prefixed, 66 chars)"
|
|
2939
|
+
"description": "Transaction hash (0x-prefixed, 66 chars)",
|
|
2940
|
+
"type": "string"
|
|
1980
2941
|
},
|
|
1981
2942
|
"as-of-date": {
|
|
1982
2943
|
"required": true,
|
|
1983
|
-
"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"
|
|
1984
2947
|
},
|
|
1985
2948
|
"block-timestamp": {
|
|
1986
|
-
"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"
|
|
1987
2951
|
},
|
|
1988
2952
|
"chain": {
|
|
1989
2953
|
"default": "ethereum",
|
|
1990
|
-
"description": "Chain (ethereum, bnb, base)"
|
|
2954
|
+
"description": "Chain (ethereum, bnb, base)",
|
|
2955
|
+
"type": "string"
|
|
1991
2956
|
}
|
|
1992
|
-
}
|
|
2957
|
+
},
|
|
2958
|
+
"pagination": false
|
|
1993
2959
|
},
|
|
1994
2960
|
"historical-wallet-transactions": {
|
|
1995
2961
|
"endpoint": "/api/v1/profiler/address/historical-transactions",
|
|
@@ -1997,15 +2963,19 @@
|
|
|
1997
2963
|
"options": {
|
|
1998
2964
|
"address": {
|
|
1999
2965
|
"required": true,
|
|
2000
|
-
"description": "Wallet address"
|
|
2966
|
+
"description": "Wallet address",
|
|
2967
|
+
"type": "string"
|
|
2001
2968
|
},
|
|
2002
2969
|
"as-of-date": {
|
|
2003
2970
|
"required": true,
|
|
2004
|
-
"description": "Snapshot date (YYYY-MM-DD)"
|
|
2971
|
+
"description": "Snapshot date (YYYY-MM-DD)",
|
|
2972
|
+
"type": "string",
|
|
2973
|
+
"format": "date"
|
|
2005
2974
|
},
|
|
2006
2975
|
"chain": {
|
|
2007
2976
|
"default": "ethereum",
|
|
2008
|
-
"description": "Chain"
|
|
2977
|
+
"description": "Chain",
|
|
2978
|
+
"type": "string"
|
|
2009
2979
|
}
|
|
2010
2980
|
}
|
|
2011
2981
|
}
|
|
@@ -2026,7 +2996,13 @@
|
|
|
2026
2996
|
"channels",
|
|
2027
2997
|
"data",
|
|
2028
2998
|
"description"
|
|
2029
|
-
]
|
|
2999
|
+
],
|
|
3000
|
+
"options": {
|
|
3001
|
+
"reveal": {
|
|
3002
|
+
"type": "boolean",
|
|
3003
|
+
"description": "Show full channel webhook URLs and webhook signing secrets (redacted by default)"
|
|
3004
|
+
}
|
|
3005
|
+
}
|
|
2030
3006
|
},
|
|
2031
3007
|
"create": {
|
|
2032
3008
|
"endpoint": "/api/v1/smart-alert",
|
|
@@ -2078,6 +3054,10 @@
|
|
|
2078
3054
|
"disabled": {
|
|
2079
3055
|
"type": "boolean",
|
|
2080
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)"
|
|
2081
3061
|
}
|
|
2082
3062
|
}
|
|
2083
3063
|
},
|
|
@@ -2133,6 +3113,10 @@
|
|
|
2133
3113
|
"disabled": {
|
|
2134
3114
|
"type": "boolean",
|
|
2135
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)"
|
|
2136
3120
|
}
|
|
2137
3121
|
}
|
|
2138
3122
|
},
|
|
@@ -2147,13 +3131,22 @@
|
|
|
2147
3131
|
"disabled": {
|
|
2148
3132
|
"type": "boolean",
|
|
2149
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)"
|
|
2150
3138
|
}
|
|
2151
3139
|
}
|
|
2152
3140
|
},
|
|
2153
3141
|
"delete": {
|
|
2154
3142
|
"endpoint": "/api/v1/smart-alert/{alertId}",
|
|
2155
3143
|
"description": "Delete an alert. Usage: nansen alerts delete <id>",
|
|
2156
|
-
"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
|
+
}
|
|
2157
3150
|
}
|
|
2158
3151
|
}
|
|
2159
3152
|
},
|
|
@@ -2931,16 +3924,16 @@
|
|
|
2931
3924
|
},
|
|
2932
3925
|
"limit": {
|
|
2933
3926
|
"type": "number",
|
|
2934
|
-
"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).
|
|
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."
|
|
2935
3928
|
},
|
|
2936
3929
|
"page": {
|
|
2937
3930
|
"type": "number",
|
|
2938
3931
|
"default": 1,
|
|
2939
|
-
"description": "1-based page number for list-returning research commands; maps to pagination.page.
|
|
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."
|
|
2940
3933
|
},
|
|
2941
3934
|
"paginate": {
|
|
2942
3935
|
"type": "boolean",
|
|
2943
|
-
"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.
|
|
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."
|
|
2944
3937
|
},
|
|
2945
3938
|
"max-pages": {
|
|
2946
3939
|
"type": "integer",
|
|
@@ -2985,7 +3978,7 @@
|
|
|
2985
3978
|
"json",
|
|
2986
3979
|
"csv"
|
|
2987
3980
|
],
|
|
2988
|
-
"description": "Output format (default
|
|
3981
|
+
"description": "Output format: json (default) or csv. Any other value is rejected."
|
|
2989
3982
|
},
|
|
2990
3983
|
"x402-payment-signature": {
|
|
2991
3984
|
"type": "string",
|
|
@@ -3076,7 +4069,6 @@
|
|
|
3076
4069
|
"viction"
|
|
3077
4070
|
],
|
|
3078
4071
|
"smartMoneyLabels": [
|
|
3079
|
-
"Fund",
|
|
3080
4072
|
"Smart Trader",
|
|
3081
4073
|
"30D Smart Trader",
|
|
3082
4074
|
"90D Smart Trader",
|