# Halal Terminal API — full endpoint inventory

> Flattened inventory of every public endpoint exposed by https://api.halalterminal.com with HTTP method, path, and one-line description. Auto-generated from the live OpenAPI spec at https://api.halalterminal.com/openapi.json. Pair this file with https://api.halalterminal.com/llms.txt for product context and pricing.

All endpoints require an `X-API-Key: ht_…` header unless explicitly noted. Path parameters are written `{name}`; consult the OpenAPI spec for query parameters, request bodies, and response schemas.

## Screening

All five Shariah methodologies (AAOIFI, DJIM, FTSE, MSCI, S&P) are audited end-to-end against their published specs. AAOIFI / FTSE / MSCI use a total-assets basis; DJIM uses the prescribed 24-month trailing-average market cap and S&P uses 36-month. Every per-methodology entry in the response carries `verified: true`.

- `GET /api/result/{symbol}` — Get the cached screening result for a single symbol
- `GET /api/results` — Get all cached screening results
- `GET /api/results/updates` — Get screening results updated since a given timestamp
- `GET /api/screen-bulk/compare` — Compare the results of two bulk screening runs
- `GET /api/screen-bulk/indices` — List available stock indices for bulk screening
- `GET /api/screen-bulk/runs` — List historical bulk screening runs
- `GET /api/screen-bulk/status` — Get the status of a bulk screening run
- `GET /api/screen-bulk/{run_id}/export/csv` — Export screening results as a CSV file
- `GET /api/screen-bulk/{run_id}/export/json` — Export screening results as JSON
- `GET /api/screen-bulk/{run_id}/results` — Retrieve filtered, paginated results for a bulk screening run
- `GET /api/screen-bulk/{run_id}/summary` — Get an aggregated summary of a bulk screening run
- `GET /api/screen/{symbol}` — Screen a single symbol for Shariah compliance
- `POST /api/screen-bulk` — Trigger a new bulk Shariah screening run
- `POST /api/screen-bulk/{run_id}/cancel` — Cancel a running bulk screening job
- `POST /api/screen/{symbol}` — Screen a single symbol for Shariah compliance
- `DELETE /api/screen-bulk/{run_id}` — Delete a bulk screening run and its results

## Market data

- `GET /api/asset/{symbol}/full` — Get a comprehensive view of an asset combining multiple data sources
- `GET /api/ohlc/{symbol}` — Retrieve OHLC candlestick data for a given symbol
- `GET /api/quote/{symbol}` — Get a real-time quote for a single symbol
- `GET /api/trending` — List currently trending assets
- `POST /api/quotes/batch` — Fetch quotes for multiple symbols in a single request

## Comparison

- `POST /api/compare` — Compare Shariah compliance across multiple symbols

## ETF analysis

- `GET /api/etf/{symbol}/holdings` — Retrieve the full list of holdings for an ETF
- `GET /api/etf/{symbol}/info` — Retrieve general fund information for an ETF
- `GET /api/etf/{symbol}/screening` — Retrieve a previously cached Shariah screening result for an ETF
- `POST /api/etf/compare` — Compare two to five ETFs side by side
- `POST /api/etf/screen-bulk` — Screen multiple ETFs for Shariah compliance in a single request
- `POST /api/etf/{symbol}/purification` — Calculate the purification amount for an ETF investment
- `POST /api/etf/{symbol}/screen` — Run a Shariah compliance screening on an ETF

## Sukuk (Islamic fixed income)

Halal Terminal screens sukuk, not only equities and ETFs. The structural sukuk registry is searchable by issuer, country, structure (ijarah, murabaha, wakala, mudarabah, asset-backed), documentation basis, currency, and maturity window. Each instrument resolves to an AAOIFI pre- and post-Standard 62 disposition and a per-methodology grid; a portfolio-impact endpoint aggregates the sukuk sleeve of a portfolio. Guide: https://www.halalterminal.com/research/sukuk-screening

- `GET /api/sukuk/search` — Search the structural sukuk registry by issuer, country, structure, documentation basis, currency, and maturity
- `GET /api/sukuk/{isin}` — Resolve a single sukuk by ISIN with its AAOIFI pre/post-Standard 62 disposition and per-methodology grid
- `GET /api/sukuk/issuer/{lei}` — List all sukuk instruments for an issuer LEI
- `POST /api/sukuk/portfolio-impact` — Score the sukuk sleeve of a portfolio under both pre- and post-Standard 62 views

## News

- `GET /api/news` — Retrieve a paginated list of Islamic finance and market news articles
- `GET /api/news/sources` — List all configured news sources
- `GET /api/news/{symbol}` — Retrieve recent news articles for a specific stock symbol

## SEC filings

- `GET /api/filings/{symbol}` — Retrieve SEC EDGAR filings for a company by ticker symbol
- `GET /api/filings/{symbol}/facts` — Retrieve XBRL company facts for a ticker symbol

## Dividends

- `GET /api/dividends/{symbol}` — Retrieve the dividend payment history for a stock
- `GET /api/dividends/{symbol}/purification` — Calculate dividend purification amounts for a stock

## Zakat & purification

- `POST /api/purification/calculate` — Calculate dividend purification amounts for multiple holdings at once
- `POST /api/zakat/calculate` — Calculate zakat owed on a portfolio of stock holdings

## Portfolio

- `POST /api/portfolio/scan` — Scan a portfolio of stocks for Shariah compliance

## Watchlists

- `GET /api/watchlists` — List Watchlists
- `GET /api/watchlists/{watchlist_id}` — Get a single watchlist by ID
- `POST /api/watchlists` — Create a new watchlist
- `POST /api/watchlists/{watchlist_id}/symbols` — Add a symbol to an existing watchlist
- `DELETE /api/watchlists/{watchlist_id}` — Delete Watchlist
- `DELETE /api/watchlists/{watchlist_id}/symbols/{symbol}` — Remove Symbol From Watchlist

## Reports

- `GET /api/reports/export/csv` — Export all cached screening results as a downloadable CSV file
- `GET /api/reports/screening/{symbol}` — Generate a Shariah compliance screening report for a single stock
- `POST /api/reports/portfolio` — Generate a Shariah compliance report for a portfolio of stocks

## Insights

- `GET /api/insights/{symbol}/alternatives` — For any non-compliant or unscreened ticker, surface up to N Shariah-compliant alternatives in the same sector ranked by how close their market cap sits to the…
- `GET /api/insights/{symbol}/staleness` — Cross-reference the symbol's last screening timestamp with its SEC filing history
- `GET /api/insights/{symbol}/trajectory` — Build a time series of the four ratios that drive Shariah compliance — debt/assets, cash/assets, liquidity/assets, interest/revenue — from the SEC XBRL company…

## Symbol database & search

- `GET /api/database/search` — Search the local database of assets with filtering and pagination
- `GET /api/database/stats` — Get aggregate statistics about the database contents
- `GET /api/database/stock/{symbol}` — Retrieve the database record for a single stock by symbol
- `GET /api/suggest` — Auto-complete symbol suggestions for a search query

## Education & methodology

- `GET /api/education/glossary` — Retrieve the Islamic finance glossary, optionally filtered by search query
- `GET /api/education/methodologies` — List all supported Shariah screening methodologies
- `GET /api/education/methodologies/{name}` — Retrieve detailed information about a specific Shariah screening methodology
- `GET /api/education/purification` — Retrieve the dividend purification and zakat guide
- `GET /api/education/screening-criteria` — Retrieve the Shariah compliance screening criteria

## Account & usage

- `GET /api/auth/me` — Return plan, quota, and identity for the calling API key
- `GET /api/auth/me/usage/daily` — Return per-day usage for the *calling* API key (header-only)
- `GET /api/auth/me/usage/recent` — Return the most recent individual requests for the *calling* API key
- `POST /api/auth/me/regenerate` — Deactivate the *calling* API key and issue a replacement

## API key management

- `GET /api/keys/plans` — List all available API plans with pricing
- `GET /api/keys/token-costs` — Return the full token cost table
- `GET /api/keys/{api_key}/usage` — Deprecated** — use `GET /api/auth/me` instead
- `GET /api/keys/{api_key}/usage/daily` — Deprecated** — use `GET /api/auth/me/usage/daily` instead
- `GET /api/keys/{api_key}/usage/recent` — Deprecated** — use `GET /api/auth/me/usage/recent` instead
- `POST /api/keys/generate` — Generate a free-trial API key
- `POST /api/keys/revoke` — Deactivate a key by its public prefix
- `POST /api/keys/{api_key}/regenerate` — Deprecated** — use `POST /api/auth/me/regenerate` instead

## Billing

- `POST /api/billing/checkout` — Create a Stripe Checkout session for a plan upgrade
- `POST /api/billing/portal` — Create a Stripe Customer Portal session for the calling key
- `POST /api/billing/webhook` — Handle Stripe webhook events for subscription lifecycle

## Disclaimers

Every relevant API response carries a `disclaimers` array (six canonical IDs: screening, market_data, purification, zakat, etf_lookthrough, educational). Each disclaimer object includes `id`, `version` (ISO date), `lang`, `severity` (`religious` | `data`), `text`, and a `url` deep-linking to the long-form legal page. Auth-exempt; no API key required.

- `GET /api/disclaimers` — Full disclaimer registry (returns all six canonical disclaimers with text, version, severity, and section-anchored URLs)
- `GET /api/disclaimers/{id}` — Single disclaimer lookup by stable ID

## Operational

- `GET /api/health` — Check API health status