All docs Nebula docs All endpoints Interactive docs Markdown OpenAPI JSON

REST API
Lookup

Search

GET /search

One search across assets, people, accounts, and topics. Each result's kind says which it is: assets carry asset_id and asset_class, subjects carry subject_id. Send kind to search one side only.

Wallet payment available at https://nebula-api.hiddensystems.ai/api/v1/x402/search. No Nebula account or API key required; check the payment offer before signing. x402 payment guide.

Parameters

query string QUERY required

Text to search for: a ticker, a company or coin name, a person, an account, or a topic.

Example:NVIDIA

kind string QUERY

Restricts results to assets (stocks, commodities, indices, and crypto) or subjects (people, accounts, and topics). Omit it to search both.

Allowed values

assetsubject

Example:asset

limit integer QUERY

Maximum results returned.

Default:10

cURL Example

curl --get \
  --url 'https://nebula-api.hiddensystems.ai/api/v1/public/search' \
  --data-urlencode 'query=NVIDIA' \
  --header 'X-API-Key: YOUR_API_KEY'

Responses

200 OK

400 Bad Request

401 Unauthorized

402 Credits used up; response includes renewal timing and purchased credit balance

403 Forbidden

404 Not Found

405 Method not allowed; the Allow header lists the supported method

429 Too Many Requests

500 Internal Server Error

503 Service Unavailable

Media type application/json

query

string required

The free-text string that was resolved, echoed back.

results

array<object> required

Ranked results, best first.

results[].asset_class

string optional

The asset's class: equity (stocks and ETFs), commodity, index, or crypto. Send it with asset_id on every asset-scoped request.

results[].asset_id

string optional

Canonical public asset identifier: the ticker or market symbol for stocks, commodities, and indices, and the CoinGecko slug (or, without one, a numeric id) for crypto.

results[].kind

string required

What the result is: asset (query it with asset_id and asset_class) or subject (query it with subject_id).

Allowed values

assetsubject

results[].matched_alias

string optional

The name or alias that matched the query, so you can show why a search landed where it did.

results[].name

string required

Human-readable name.

results[].subject_id

string optional

Canonical identifier for a non-asset person, account, or topic.

results[].symbol

string optional

Display ticker or market symbol.

{
  "query": "nvidia",
  "results": [
    {
      "asset_class": "equity",
      "asset_id": "NVDA",
      "kind": "asset",
      "name": "NVIDIA Corporation",
      "symbol": "NVDA"
    },
    {
      "kind": "subject",
      "matched_alias": "NVIDIA AI",
      "name": "NVIDIA AI",
      "subject_id": "handle:nvidiaai"
    }
  ]
}