所有文件 Nebula 文件所有端點互動式文件 Markdown OpenAPI JSON

REST API
查詢

搜尋

GET /search

搜尋

一次搜尋即可涵蓋資產、人物、帳號與主題。每筆結果的 kind 會指出它是哪一種：資產帶有 asset_id 與 asset_class，主體則帶有 subject_id。若只想搜尋其中一邊，請傳送 kind。

可使用錢包於 https://nebula-api.hiddensystems.ai/api/v1/x402/search 付款。不需要 Nebula 帳號或 API 金鑰；簽署前請先確認付款條件。x402 付款指南。

參數

query string QUERY 必填

要搜尋的文字：股票代號、公司或加密貨幣名稱、人物、帳號或主題。

Example:NVIDIA

kind string QUERY

將結果限制為資產（股票、大宗商品、指數與加密貨幣）或主體（人物、帳號與主題）。省略此參數則兩者都搜尋。

允許的值

assetsubject

Example:asset

limit integer QUERY

傳回的結果數量上限。

Default:10

cURL 範例

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

回應

200 OK

400 錯誤的要求

401 未經授權

402 額度已用完；回應會包含續約時間與已購買的額度餘額

403 禁止

404 找不到

405 不允許的方法；Allow 標頭會列出支援的方法

429 要求過多

500 內部伺服器錯誤

503 服務無法使用

媒體類型 application/json

query

string 必填

解析後回傳的原始自由文字字串。

results

array<object> 必填

排名結果，最佳者在前。

results[].asset_class

string 選填

資產的類別：equity（股票與 ETF）、commodity、index 或 crypto。請在每個以資產為範圍的要求中，與 asset_id 一併送出。

results[].asset_id

string 選填

標準的公開資產識別碼：股票、商品與指數為 ticker 或市場代號，crypto 則為 CoinGecko slug（若無 slug，則為數字 id）。

results[].kind

string 必填

結果的類型：asset（以 asset_id 和 asset_class 查詢）或 subject（以 subject_id 查詢）。

允許的值

assetsubject

results[].matched_alias

string 選填

與查詢相符的名稱或別名，方便你說明某筆搜尋為何會落在該結果。

results[].name

string 必填

人類可讀的名稱。

results[].subject_id

string 選填

非資產的人物、帳號或主題的標準識別碼。

results[].symbol

string 選填

顯示用的 ticker 或市場代號。

{
  "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"
    }
  ]
}