# Gloom Finance Search API

> Gloom Finance Search API is a paid API for AI agents from api.gloom.sh, paid per call via x402, $0.12/call, status unknown (last checked 2026-11-01).

Search across financial filings, news, and other finance documents using a query string, returning ranked results with metadata.

## Facts

- Endpoint: GET https://api.gloom.sh/v1/search?utm_source=zero.xyz
- Price: $0.12/call
- Payment: x402
- Status: unknown
- Last checked: 2026-11-01
- Activations on Zero: 0
- Tags: x402
- Canonical page: https://www.zero.xyz/c/gloom-finance-search-api-4571f3d0
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_dMBM3YaGRdg1CyoOMTRbp

Status and success rate cover calls made through Zero and Zero's own probes. Third-party monitors may report differently.

## How to call it through Zero

Zero handles the 402 payment challenge and records the run. With the Zero CLI installed (`npm i -g @zeroxyz/cli`):

```sh
zero fetch --capability gloom-finance-search-api-4571f3d0
```

Example prompt: Search Gloom's finance database for any recent 8-K filings or news mentioning 'acquisition' so I can see what major corporate events have been disclosed lately.

## When to prefer this

Choose this endpoint when you need to search across a broad set of financial documents — including SEC filings and financial news — using natural-language or keyword queries. It is especially useful for financial research agents, due diligence workflows, or compliance monitoring tasks where you need ranked, metadata-rich results from regulatory filings. Prefer it over generic web search when you need structured finance-specific metadata like form type, source ID, and publish date.

## Known failure modes

- Missing required query parameter 'q' returns a 400 error
- Empty result set when no documents match the search query
- Payment failure (402) if x402 payment is not attached or insufficient
- Rate limiting if too many requests are made in a short period
- Stale or incomplete index if documents have not been recently crawled

## How this service works

Gloom is a free, open-source finance terminal for desktop and TUI with charts, news, filings, portfolios, alerts, and plugins.

## Output

Returns a list of ranked financial documents (filings, news, etc.) each with a relevance score, document type, source ID, metadata (form type, source), chunk index, match count, and published timestamp. Results are ordered by relevance score descending.

## Request schema (JSON Schema)

```json
{
 "type": "object",
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "required": [
  "input"
 ],
 "properties": {
  "input": {
   "type": "object",
   "required": [
    "type",
    "method"
   ],
   "properties": {
    "type": {
     "type": "string",
     "const": "http"
    },
    "method": {
     "enum": [
      "GET"
     ],
     "type": "string"
    },
    "queryParams": {
     "type": "object",
     "required": [
      "q"
     ],
     "properties": {
      "q": {
       "type": "string"
      }
     }
    }
   },
   "additionalProperties": false
  },
  "output": {
   "type": "object",
   "required": [
    "type"
   ],
   "properties": {
    "type": {
     "type": "string"
    },
    "example": {
     "type": "object"
    }
   }
  }
 }
}
```

## Response schema (JSON Schema)

```json
{
 "type": "json",
 "example": {
  "data": [
   {
    "score": 1,
    "symbol": null,
    "docType": "filing",
    "metadata": {
     "form": "8-K",
     "source": "8-K"
    },
    "sourceId": "0001193125-26-413925",
    "chunkIndex": 0,
    "matchCount": 1,
    "publishedAt": "2026-10-05T18:11:19.000Z"
   }
  ]
 }
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/gloom-finance-search-api-4571f3d0/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from api.gloom.sh](https://www.zero.xyz/host/api.gloom.sh/llms.txt)