---
title: "Source Health"
method: GET
path: "/api/screen-bulk/source-health"
tags: ["screening"]
---

# Source Health

`GET /api/screen-bulk/source-health`

## Request

- Base URL: `https://api.halalterminal.com`
- URL: `https://api.halalterminal.com/api/screen-bulk/source-health`
- Auth: API key in header `X-API-Key`

Health of every index constituent source.

Resolves each index's upstream source and flags any whose count collapsed
below its healthy floor (the failure mode behind the 2026-06 S&P 500 outage).
Cached server-side; pass `force=true` to recompute immediately.

## Query parameters

- `force` boolean: Force recomputation instead of returning the cached health snapshot.

## Response `200`

Health of each index constituent source

- SourceHealthResponse
  - `checked_at` string, required: ISO timestamp of the underlying check
  - `ttl_seconds` integer, required: How long this result is cached server-side
  - `cached` boolean, required: True if served from cache rather than freshly computed
  - `summary` SourceHealthSummary, required
    - `total` integer, required: Number of index sources checked
    - `healthy` integer, required: Sources at or above their floor
    - `degraded` integer, required: Sources below their floor but non-empty
    - `failed` integer, required: Sources that returned nothing
    - `status` 'ok' | 'alert', required: alert if any source is degraded or failed, else ok
  - `indices` SourceHealthItem[], required: Per-index health, broken sources first
    - `name` string, required: Index name, e.g. 'S&P 500'
    - `count` integer, required: Constituents the source returned on the last check
    - `floor` integer, required: Minimum healthy constituent count for this index
    - `status` 'ok' | 'degraded' | 'failed', required: ok = at/above floor, degraded = below floor, failed = empty

## Other responses

- `401`: API key required or invalid
- `422`: Validation Error

---

[API](https://skmtc.dev/halalterminal/apis/halal-terminal-api.md) · [All operations](https://skmtc.dev/halalterminal/apis/halal-terminal-api/llms.txt) · [OpenAPI document](https://skmtc.dev/halalterminal/apis/halal-terminal-api/revisions/78768b250943?raw)