Halal Terminal API — Reference

A crawler-readable index of all 87 endpoints. Interactive docs: /docs · /redoc · OpenAPI · llms-full.txt. All endpoints require an X-API-Key header. Sukuk screening guide: www.halalterminal.com/research/sukuk-screening.

Health

Health-check and liveness probes — no API key required

GET/api/health
Health Check

Screening

Single-symbol and bulk Shariah screening across AAOIFI and custom methodologies

GET/api/result/{symbol}
Get Result
GET/api/results
Get Results
GET/api/results/updates
Get Results Updates
POST/api/screen-bulk
Screen Bulk
GET/api/screen-bulk/compare
Compare Runs
GET/api/screen-bulk/indices
List Indices
GET/api/screen-bulk/runs
List Runs
GET/api/screen-bulk/status
Bulk Status
DELETE/api/screen-bulk/{run_id}
Delete Run
POST/api/screen-bulk/{run_id}/cancel
Cancel Run
GET/api/screen-bulk/{run_id}/export/csv
Export Csv
GET/api/screen-bulk/{run_id}/export/json
Export Json
GET/api/screen-bulk/{run_id}/results
Get Run Results
GET/api/screen-bulk/{run_id}/summary
Get Run Summary
GET/api/screen/{symbol}
Screen Symbol
POST/api/screen/{symbol}
Screen Symbol

Database

Stock database search, autocomplete suggestions, and coverage statistics

GET/api/database/search
Search Database
GET/api/database/stats
Get Database Stats
GET/api/database/stock/{symbol}
Get Stock From Database
GET/api/suggest
Suggest Symbol

Market

Real-time quotes, OHLC candles, trending tickers, and full asset details

GET/api/asset/{symbol}/full
Get Asset Full
GET/api/ohlc/{symbol}
Get Ohlc
GET/api/quote/{symbol}
Get Quote
POST/api/quotes/batch
Get Quotes Batch
GET/api/trending
Get Trending

Portfolio

Portfolio-level compliance scanning with position weighting

POST/api/portfolio/scan
Portfolio Scan

Watchlists

Create, update, and manage personal watchlists

GET/api/watchlists
List Watchlists
POST/api/watchlists
Create Watchlist
DELETE/api/watchlists/{watchlist_id}
Delete Watchlist
GET/api/watchlists/{watchlist_id}
Get Watchlist
POST/api/watchlists/{watchlist_id}/symbols
Add Symbol To Watchlist
DELETE/api/watchlists/{watchlist_id}/symbols/{symbol}
Remove Symbol From Watchlist

Comparison

Side-by-side Shariah compliance comparison for multiple symbols

POST/api/compare
Compare Symbols

Reports

Generate screening and portfolio compliance reports with CSV export

GET/api/reports/export/csv
Export Csv
POST/api/reports/portfolio
Get Portfolio Report
GET/api/reports/screening/{symbol}
Get Screening Report

Education

Islamic finance glossary, screening methodologies, and criteria reference

GET/api/education/glossary
Get Glossary
GET/api/education/methodologies
Get Methodologies
GET/api/education/methodologies/{name}
Get Methodology
GET/api/education/purification
Get Purification Guide
GET/api/education/screening-criteria
Get Screening Criteria

News

Market-wide and per-symbol news aggregation

GET/api/news
Get News
GET/api/news/sources
Get Sources
GET/api/news/{symbol}
Get News For Symbol

Filings

SEC filings (10-K, 10-Q) and XBRL company facts

GET/api/filings/{symbol}
Get Filings
GET/api/filings/{symbol}/events
Get Events
GET/api/filings/{symbol}/facts
Get Facts

Dividends

Dividend history, yield data, and Shariah purification calculations

GET/api/dividends/{symbol}
Get Dividend History
GET/api/dividends/{symbol}/purification
Get Dividend Purification

Zakat

Zakat and dividend purification calculators

POST/api/purification/calculate
Calculate Purification
POST/api/zakat/calculate
Calculate Zakat

Etf

ETF holdings retrieval, per-holding Shariah screening, and purification ratios

POST/api/etf/compare
Compare Etfs
POST/api/etf/screen-bulk
Screen Bulk
GET/api/etf/{symbol}/holdings
Get Etf Holdings
GET/api/etf/{symbol}/info
Get Etf Info
POST/api/etf/{symbol}/purification
Calculate Etf Purification
POST/api/etf/{symbol}/screen
Screen Etf
GET/api/etf/{symbol}/screening
Get Etf Screening

Sukuk

Sukuk (Islamic fixed income) screening and reference data. Search the structural registry by issuer, country, structure, documentation basis, currency, and maturity; resolve a single instrument by ISIN with its AAOIFI pre- and post-Standard 62 disposition and a per-methodology grid; look up all instruments for an issuer LEI; and score the sukuk sleeve of a portfolio via portfolio-impact. Endpoints: GET /api/sukuk/search, GET /api/sukuk/{isin}, GET /api/sukuk/issuer/{lei}, POST /api/sukuk/portfolio-impact.

GET/api/sukuk/issuer/{lei}
Get Issuer Sukuk
POST/api/sukuk/portfolio-impact
Portfolio Impact
GET/api/sukuk/search
Search Sukuk
GET/api/sukuk/{isin}
Get Sukuk

Api Keys

API key generation, usage tracking, and plan management — no API key required

POST/api/keys/generate
Generate Key
GET/api/keys/plans
List Plans
POST/api/keys/revoke
Revoke Key
GET/api/keys/token-costs
Get Token Costs
POST/api/keys/{api_key}/regenerate
Regenerate Key
GET/api/keys/{api_key}/usage
Get Usage
GET/api/keys/{api_key}/usage/daily
Get Daily Usage
GET/api/keys/{api_key}/usage/recent
Get Recent Requests

Billing

Stripe checkout sessions and webhook handling — no API key required

POST/api/billing/checkout
Create Checkout
POST/api/billing/portal
Create Portal Session
POST/api/billing/webhook
Stripe Webhook

Disclaimers

Canonical disclaimer registry. Resolve the `disclaimers[].id` values attached to other API responses. No API key required.

GET/api/disclaimers
Canonical disclaimer registry
GET/api/disclaimers/{disclaimer_id}
Lookup a single disclaimer by ID

Auth

GET/api/auth/me
Me
POST/api/auth/me/regenerate
Me Regenerate
GET/api/auth/me/usage/daily
Me Usage Daily
GET/api/auth/me/usage/recent
Me Usage Recent

Unsubscribe

GET/api/unsubscribe/{token}
Unsubscribe Get
POST/api/unsubscribe/{token}
Unsubscribe Post

Webhooks

POST/api/webhooks/resend
Resend Webhook
POST/api/webhooks/resend/inbound
Resend Inbound

Insights

GET/api/insights/{symbol}/alternatives
Halal alternatives for a non-compliant ticker
GET/api/insights/{symbol}/staleness
Detect screening staleness from recent SEC filings
GET/api/insights/{symbol}/trajectory
Compliance ratio trajectory from XBRL facts