# Gloom Short Volume Data API

> Gloom Short Volume Data 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).

Returns short volume, total volume, and short ratio data for one or more stock symbols on a given date

## Facts

- Endpoint: GET https://api.gloom.sh/v1/short-volume?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-short-volume-data-api-66763e5b
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_kRfUsH3souHav0TLDLTkD

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-short-volume-data-api-66763e5b
```

Example prompt: Can you pull the latest short volume data for AAPL and TSLA from Gloom — I want to see the short volume, total volume, and what percentage was short?

## When to prefer this

Choose this endpoint when you need daily short volume statistics for specific US equities, especially short volume ratios and exempt volume breakdowns. Prefer this over general market data APIs when the specific metric needed is short selling activity or short interest pressure. It is particularly useful for quantitative strategies, short squeeze research, or monitoring unusual short selling patterns in individual stocks.

## Known failure modes

- Missing or invalid 'symbols' query parameter returns an error
- Symbol not found or unsupported ticker may return empty data array
- refreshFailed: true in response indicates upstream data fetch issue for that symbol
- Rate limiting or payment failure (x402) may block request
- Invalid date or no data available for requested date returns empty results

## 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 records per symbol, each containing: the date, stock symbol, market codes, short volume (shares), total volume (shares), short-to-total ratio as a percentage, short exempt volume, whether a refresh failed, and the timestamp when data was fetched. Example: AAPL with shortVolume ~5.4M out of totalVolume ~12.2M = 44.7% ratio.

## 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": [
   {
    "date": "2026-09-21",
    "symbol": "AAPL",
    "markets": [
     "B"
    ],
    "fetchedAt": "2026-09-22T00:00:00.000Z",
    "shortVolume": "5442428.346356",
    "totalVolume": "12178460.751537",
    "ratioPercent": 44.68896732,
    "refreshFailed": false,
    "shortExemptVolume": "23826",
    "unavailableReason": null
   }
  ]
 }
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/gloom-short-volume-data-api-66763e5b/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)