# Gloom KPIs API

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

Fetches key performance indicator (KPI) financial metrics for one or more stock symbols from the Gloom finance terminal.

## Facts

- Endpoint: GET https://api.gloom.sh/v1/kpis?utm_source=zero.xyz
- Price: $0.06/call
- Payment: x402
- Status: unknown
- Last checked: 2026-11-01
- Activations on Zero: 0
- Tags: x402
- Canonical page: https://www.zero.xyz/c/gloom-kpis-api-14b15082
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_l_myONCSv5gTKK_qgqNX_

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-kpis-api-14b15082
```

Example prompt: Pull the key financial KPIs for AAPL and TSLA from Gloom — things like revenue and other reported metrics — so I can compare their fundamentals.

## When to prefer this

Choose this endpoint when you need structured, machine-readable financial KPI data (like revenue) for one or more stock tickers and want low-cost per-call access via the x402 micropayment protocol. It is best suited for agents performing fundamental analysis, portfolio monitoring, or financial enrichment workflows. Prefer alternatives if you need real-time price quotes, options data, or news rather than reported KPI metrics.

## Known failure modes

- Missing or invalid 'symbols' query parameter returns an error
- Unknown or delisted ticker symbols may return empty data arrays
- Network timeout if the Gloom API is unavailable
- Payment failure if USDC balance is insufficient for the $0.06 per-call fee
- Malformed request schema (wrong method or type) returns a validation error

## 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 an array of KPI data objects, each containing the metric key (e.g. 'revenue'), unit, basis (e.g. 'reported'), a metric object with id, name, definition, sector, and aliases, the stock symbol, and currency.

## 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": [
      "symbols"
     ],
     "properties": {
      "symbols": {
       "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": [
   {
    "key": "revenue",
    "unit": "count",
    "basis": "reported",
    "metric": {
     "id": "revenue",
     "name": "Illustrative revenue",
     "unit": "count",
     "sector": "general",
     "aliases": {},
     "definition": "Illustrative metric"
    },
    "symbol": "AAPL",
    "currency": null
   }
  ]
 }
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/gloom-kpis-api-14b15082/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)