Nebula CLI
Query global markets intelligence across equities, commodities, indices, crypto, and AI from your terminal, scripts, or CI.
Install
The CLI requires Node.js 18 or later.
npm install --global @hiddensystems/nebula-cli
Authentication
nebula auth login --key YOUR_API_KEY
The CLI stores the key in ~/.nebula/config.json with owner-only permissions. Set NEBULA_API_KEY instead for automation.
Examples
nebula api list_assets --asset-class equity --query NVIDIA
nebula api get_sentiment
nebula api get_mindshare --asset-id NVDA --asset-class equity
nebula api create_chat_completion --body '{"messages":[{"content":"What changed in NVIDIA sentiment this week?","role":"user"}],"stream":false,"thinking_mode":"auto"}'
Endpoints Overview
Each CLI command uses the same operation-level pricing and shared account balance as the REST API, MCP, CLI, and Nebula Agent.
- Fixed-cost operations spend the listed number of credits per request.
- Parameters do not change an operation's cost, except where its row names a price for one: a mindshare or sentiment forecast re-run with refresh=true costs 10 credits instead of 5. Sentiment always costs 1 credit, with or without cluster filters.
- A row can also name a lower price for a lesser answer: a forecast the asset cannot have (not_forecastable) is free, up to 30 such answers per account an hour; past that the endpoint answers 429 until the hour clears. A request that ends in an error costs nothing.
- Agent requests use variable pricing based on token volume, model cost, and tool calls. The completed response reports the credits used.
- Every operation is available on every plan. Plans differ by history window (Free: 90 days; Pro: each endpoint's maximum, a year for most time series), rate limit (Free: 60 requests a minute; Pro: 300), and included monthly credits; buying credits extends usage but does not change history or rate limits.
Discovery
| Command | Credits | Description |
|---|
nebula api screener |
2 |
Screener |
nebula api get_top_momentum |
2 |
Top momentum |
nebula api get_top_trending |
2 |
Top trending |
Lookup
| Command | Credits | Description |
|---|
nebula api list_assets |
1 |
Text to asset ID |
nebula api search |
1 |
Search |
nebula api list_subjects |
1 |
Text to subject ID |
Social & Sentiment
| Command | Credits | Description |
|---|
nebula api get_emotions |
1 |
Emotion distribution |
nebula api get_mindshare |
2 |
Mindshare |
nebula api get_related_subjects |
2 |
Related subjects |
nebula api get_sentiment |
1 |
Sentiment |
nebula api get_sentiment_timeframes |
1 |
Sentiment by timeframe |
nebula api get_social_momentum |
2 |
Social momentum |
Forecasts
| Command | Credits | Description |
|---|
nebula api list_forecast_assets |
1 |
Forecastable assets |
nebula api get_mindshare_forecast |
5 (10 with refresh=true; free if not_forecastable, 30 an hour) |
Mindshare forecast |
nebula api get_sentiment_forecast |
5 (10 with refresh=true; free if not_forecastable, 30 an hour) |
Sentiment forecast |
Market Sentiment
| Command | Credits | Description |
|---|
nebula api get_calls |
2 |
Long/short calls |
nebula api get_call_returns |
2 |
Calls outcome distribution |
nebula api get_conviction_index |
2 |
Conviction index |
nebula api get_fear_greed_index |
1 |
Fear and Greed index |
nebula api get_price_levels |
2 |
Socially mentioned price levels |
nebula api get_social_volume_index |
2 |
Social vs trading volume |
nebula api get_social_volume_profile |
2 |
Social volume profile |
Market Data
| Command | Credits | Description |
|---|
nebula api get_price_history |
1 |
Price history |
Intelligence
| Command | Credits | Description |
|---|
nebula api list_calendar_events |
5 |
Calendar events |
nebula api list_insights |
5 |
Intelligence |
nebula api get_insight_attention |
5 |
Insight attention |
Clusters
| Command | Credits | Description |
|---|
nebula api list_clusters |
2 |
Author clusters |
nebula api compare_clusters |
2 |
Cluster comparison |
nebula api get_divisive_assets |
2 |
Divisive assets |
nebula api compare_hype_cycles |
2 |
Hype cycle arrivals |
nebula api compare_cluster_traits |
2 |
Cluster trait comparison |
nebula api get_cluster_hype_cycles |
2 |
Cluster hype cycles |
nebula api get_cluster_overlap |
2 |
Cluster overlap |
nebula api get_cluster_profile |
2 |
Cluster profile |
nebula api get_cluster_rotation |
2 |
Cluster rotation |
nebula api get_cluster_stances |
2 |
Cluster stances |
Agent
| Command | Credits | Description |
|---|
nebula api create_chat_completion |
Variable |
Nebula Agent chat completions |
Account
| Command | Credits | Description |
|---|
nebula api get_account |
0 |
Account |
Generated Commands
Paths, methods, help text, defaults, selector constraints, request schemas, and validation come directly from OpenAPI.
nebula api compare_cluster_traits | Cluster trait comparison |
|---|
nebula api compare_clusters | Cluster comparison |
|---|
nebula api compare_hype_cycles | Hype cycle arrivals |
|---|
nebula api create_chat_completion | Nebula Agent chat completions |
|---|
nebula api get_account | Account |
|---|
nebula api get_call_returns | Calls outcome distribution |
|---|
nebula api get_calls | Long/short calls |
|---|
nebula api get_cluster_hype_cycles | Cluster hype cycles |
|---|
nebula api get_cluster_overlap | Cluster overlap |
|---|
nebula api get_cluster_profile | Cluster profile |
|---|
nebula api get_cluster_rotation | Cluster rotation |
|---|
nebula api get_cluster_stances | Cluster stances |
|---|
nebula api get_conviction_index | Conviction index |
|---|
nebula api get_divisive_assets | Divisive assets |
|---|
nebula api get_emotions | Emotion distribution |
|---|
nebula api get_fear_greed_index | Fear and Greed index |
|---|
nebula api get_insight_attention | Insight attention |
|---|
nebula api get_mindshare | Mindshare |
|---|
nebula api get_mindshare_forecast | Mindshare forecast |
|---|
nebula api get_price_history | Price history |
|---|
nebula api get_price_levels | Socially mentioned price levels |
|---|
nebula api get_related_subjects | Related subjects |
|---|
nebula api get_sentiment | Sentiment |
|---|
nebula api get_sentiment_forecast | Sentiment forecast |
|---|
nebula api get_sentiment_timeframes | Sentiment by timeframe |
|---|
nebula api get_social_momentum | Social momentum |
|---|
nebula api get_social_volume_index | Social vs trading volume |
|---|
nebula api get_social_volume_profile | Social volume profile |
|---|
nebula api get_top_momentum | Top momentum |
|---|
nebula api get_top_trending | Top trending |
|---|
nebula api list_assets | Text to asset ID |
|---|
nebula api list_calendar_events | Calendar events |
|---|
nebula api list_clusters | Author clusters |
|---|
nebula api list_forecast_assets | Forecastable assets |
|---|
nebula api list_insights | Intelligence |
|---|
nebula api list_subjects | Text to subject ID |
|---|
nebula api screener | Screener |
|---|
nebula api search | Search |
|---|
JSON and Coding Agents
Add --json for machine-readable output. Run nebula api <operation_id> --help to see generated parameters for any operation.
MCP Helper
Run nebula mcp to print MCP client configuration. See the MCP documentation for setup details.
CI and Automation
Set NEBULA_API_KEY in your secret manager and use --json for structured output. Use NEBULA_API_BASE_URL only for development or self-hosted APIs.