The API layer for $6T Islamic finance

The Complete Islamic Finance Data Platform

Shariah screening, market data, portfolio compliance, ETF analysis, bulk index screening, news aggregation, SEC filings, dividends, zakat calculators, watchlists, and reports — 58+ REST endpoints, 22 MCP tools, and 7 AI resources. One platform.

Get Your Free API Key → See it in action
Screen a stock for Shariah compliance 
curl https://api.halalterminal.com/api/screen/AAPL \
  -H "X-API-Key: ht_your_key_here"
Response 200 OK
{
  "symbol": "AAPL",
  "name": "Apple Inc.",
  "overall_status": "COMPLIANT",
  "methodologies": {
    "AAOIFI": "COMPLIANT",
    "DJIM": "COMPLIANT",
    "FTSE": "COMPLIANT",
    "MSCI": "COMPLIANT",
    "S&P": "COMPLIANT"
  },
  "purification_rate": 0.42
}
0+ Assets Covered
0+ API Endpoints
0 Islamic Methodologies
0 MCP Tools
0 API Categories
0 Global Indices
Features

17 API categories, 63+ endpoints

Not just screening — a complete Islamic finance data platform covering every data need from compliance to market intelligence.

Shariah Screening

Screen any stock against AAOIFI, DJIM, FTSE, MSCI, and S&P simultaneously — all 5 audited end-to-end against their published specs (DJIM 24-month and S&P 36-month trailing-avg MC, not spot). Per-methodology verdicts, ratio breakdowns, and a verified: true audit flag on every result.

POST /api/screen/{symbol}

Sukuk Screening

Screen Islamic fixed income, not just equities. Search the structural sukuk registry by issuer, country, structure, currency, and maturity; resolve any instrument by ISIN with its AAOIFI pre- and post-Standard 62 disposition and a per-methodology grid; and score the sukuk sleeve of a portfolio. Asset-backed, ijarah, murabaha, and wakala structures classified at the instrument level.

GET /api/sukuk/search

Bulk Index Screening

Screen entire indices asynchronously — S&P 500, NASDAQ 100, DAX 40, Nikkei 225 and 17 more. Track progress, compare runs over time, and export results as CSV/JSON.

POST /api/screen-bulk

Real-Time Market Data

Live quotes, OHLC historical data, trending movers, batch quotes for up to 50 symbols, and full asset profiles. Multi-source data with automatic failover for resilience.

GET /api/quote/{symbol}

Portfolio Compliance

Scan entire portfolios in a single request. Per-stock compliance verdicts, aggregate purification rates, and exportable reports for Shariah board audit trails.

POST /api/portfolio/scan

ETF Analysis

Holdings-based compliance screening for 8,000+ ETFs. Compare funds, calculate purification rates, analyze sector exposure, and bulk screen up to 100 ETFs at once.

POST /api/etf/{symbol}/screen

Database & Search

200K+ assets across equities, ETFs, funds, and indices. Full-text search with autocomplete, filter by sector, country, exchange, or asset type. Instant suggestions as you type.

GET /api/database/search

News & SEC Filings

Multi-source news aggregation with sentiment analysis and deduplication. Articles auto-tagged with compliance_relevance so you can filter to material events — debt issuances, M&A, dividend cuts, distress — and skip the noise. SEC EDGAR integration for 10-K, 10-Q, 8-K filings and XBRL financial facts.

GET /api/news/{symbol}?compliance_relevance=high

Dividends & Zakat

Full dividend history with per-payment purification amounts. Zakat calculator at the 2.5% nisab rate. Dividend purification based on each company's impure income ratio.

GET /api/dividends/{symbol}

Watchlists, Reports & More

Create and manage watchlists, compare 2-5 symbols side-by-side, generate structured screening reports, export results as CSV, and access 50+ Islamic finance educational terms.

POST /api/watchlists

MCP Server (AI-Native)

22 MCP tools + 7 resources for Claude, Cursor, and any MCP-compatible AI assistant. Screen stocks, analyze portfolios, and calculate zakat — all conversationally through AI.

python -m backend.mcp_server

Symbol Comparison

Compare 2–5 stocks side by side across all screening methodologies. Benchmark compliance ratios, financial metrics, and Shariah status in a single unified view.

POST /api/compare

Education & Glossary

50+ Islamic finance terms, screening criteria explanations, purification guides, and methodology deep-dives. Built-in reference for developers integrating Shariah compliance.

GET /api/education/glossary

Compliance Insights

Three derived endpoints layered on the screening, news, and SEC XBRL caches: halal alternatives for any non-compliant ticker (ranked by same-country preference + market-cap proximity), 8-K-driven staleness flags that catch material 8-Ks filed after the cached screening, and 8-quarter compliance trajectories with a one-line direction summary so you see whether a stock is trending toward or away from compliance.

GET /api/insights/{symbol}/{alternatives,staleness,trajectory}

Plain-English Verdicts

Every screening response carries a compliance_explanation field — a one-sentence summary of which methodologies pass, which fail, and which ratio tripped the failures. "Compliant under AAOIFI, DJIM, S&P (debt/MC 13.0%, well under their caps), but fails FTSE, MSCI on debt/assets 42.1% > FTSE 33%, MSCI 30%." No need to re-implement methodology rules client-side.

field on POST /api/screen/{symbol}

Built-in Disclaimers

Every relevant response carries a disclaimers array — versioned, severity-tagged (religious / data), and deep-linked to the long-form legal page. Six canonical IDs cover screening, market data, purification, zakat, ETF look-through, and education, with the right fiqh nuance baked in (silver nisab, hawl, capital-gains caveats, scholar-attestation context). Skip the "is this a fatwa?" compliance review — the response tells your users.

GET /api/disclaimers
Methodologies

5 global Shariah standards, all 5 verified

Each methodology applies different financial ratio thresholds — and each is now audited end-to-end against its published spec. AAOIFI, FTSE, and MSCI use an asset basis; DJIM and S&P use the prescribed 24-month and 36-month trailing-average market cap. Every screening response carries a verified: true flag on every methodology in the by_methodology block.

shariah-screening-thresholds.json
Criterion AAOIFI DJIM FTSE MSCI S&P
Debt / Market Cap < 30% < 33% < 33% < 33.33% < 33%
Cash & Interest-bearing / Market Cap < 30% < 33% < 33% < 33.33% < 33%
Impure Revenue / Total Revenue < 5% < 5% < 5% < 5% < 5%
Receivables / Market Cap < 49% < 33% < 50% < 33.33% < 49%
Denominator Total Assets Avg Mkt Cap (24m) Total Assets Total Assets Avg Mkt Cap (36m)

All five methodologies applied in a single POST /api/screen/{symbol} call — per-methodology status, ratio breakdowns, overall compliance verdict, and a verified: true audit flag confirming the threshold logic matches the published spec.

Use Cases

Built for the builders of Islamic fintech

From solo developers to enterprise banks — powering the next generation of halal finance products.

Halal Robo-Advisors

Automate portfolio construction with real-time compliance checks. Screen the universe, build model portfolios, and rebalance — all through the API.

POST /api/portfolio/scan

Islamic Banks & Funds

Integrate screening into investment workflows. Support Shariah board reporting requirements with exportable compliance data and audit trails.

POST /api/screen-bulk

Muslim Finance Super-Apps

Add Shariah screening, zakat calculators, and purification tools to your consumer app. White-label ready with full REST API flexibility.

POST /api/zakat/calculate

Research Platforms

Power academic research and institutional analysis with methodology comparisons, historical screening data, and bulk screening across entire indices.

GET /api/education/methodologies

ETF Fund Managers

Screen ETF holdings, calculate fund-level purification rates, compare compliant alternatives, and monitor portfolio drift continuously.

POST /api/etf/{symbol}/screen

Family Offices

Multi-portfolio compliance monitoring across generations. Track zakat obligations, purification requirements, and methodology preferences per family member.

POST /api/portfolio/scan

AI-Powered Assistants

Connect via MCP and let Claude, Cursor, or any AI assistant screen stocks, check compliance, and answer Islamic finance questions conversationally — no code needed.

22 MCP tools

Zakat & Purification Platforms

Build zakat calculators and purification trackers powered by real market data. Nisab thresholds, per-holding breakdowns, and automated annual calculations.

POST /api/zakat/calculate

Compliance Reporting Tools

Generate audit-ready compliance reports for Shariah boards and regulators. Exportable screening data across all 5 methodologies with full ratio transparency.

GET /api/screen-bulk/{run_id}/results
AI-Native

Talk to your data — MCP Server

22 tools and 7 resources for Claude Desktop, Cursor, Windsurf, and any MCP-compatible AI. No code needed — just ask.

Is Apple halal? Check my portfolio too — AAPL, MSFT, and GOOGL.

› screen_stock("AAPL") › scan_portfolio(["AAPL","MSFT","GOOGL"])

Apple is Shariah-compliant across all 5 methodologies. Purification rate: 0.42%.

Your full portfolio is 100% compliant — all three pass AAOIFI, DJIM, FTSE, MSCI & S&P.

22Tools
7Resources
2Transports
claude_desktop_config.json 
{
  "mcpServers": {
    "halal-finance": {
      "command": "python3",
      "args": ["-m", "backend.mcp_server"]
    }
  }
}
Works with Claude Desktop · Cursor · Windsurf · Docker SSE
Interactive Demo

Try it right now

See live API responses. No sign-up required for the demo.

terminal 
# Screen Apple for Shariah compliance
curl -X POST "https://api.halalterminal.com/api/screen/AAPL" \
  -H "X-API-Key: ht_your_key_here"

# Get real-time quote
curl "https://api.halalterminal.com/api/quote/MSFT" \
  -H "X-API-Key: ht_your_key_here"

# Scan a portfolio
curl -X POST "https://api.halalterminal.com/api/portfolio/scan" \
  -H "X-API-Key: ht_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"symbols": ["AAPL", "MSFT", "GOOGL", "AMZN"]}'
app.py 
import requests

API_KEY = "ht_your_key_here"
BASE    = "https://api.halalterminal.com"
headers = {"X-API-Key": API_KEY}

# Screen a stock
result = requests.post(
    f"{BASE}/api/screen/AAPL",
    headers=headers
).json()

print(f"Status: {result['overall_status']}")
print(f"Purification: {result['purification_rate']}%")

# Scan a portfolio
portfolio = requests.post(
    f"{BASE}/api/portfolio/scan",
    headers=headers,
    json={"symbols": ["AAPL", "MSFT", "GOOGL"]}
).json()

for stock in portfolio["results"]:
    print(f"{stock['symbol']}: {stock['status']}")
index.js 
const API_KEY = "ht_your_key_here";
const BASE = "https://api.halalterminal.com";

// Screen a stock for Shariah compliance
const response = await fetch(
  `${BASE}/api/screen/AAPL`,
  {
    method: "POST",
    headers: { "X-API-Key": API_KEY }
  }
);
const data = await response.json();

console.log(`Status: ${data.overall_status}`);
console.log(`Methodologies:`, data.methodologies);

// Calculate zakat on portfolio
const zakat = await fetch(
  `${BASE}/api/zakat/calculate`,
  {
    method: "POST",
    headers: {
      "X-API-Key": API_KEY,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      holdings: [
        { symbol: "AAPL", shares: 100 },
        { symbol: "MSFT", shares: 50 }
      ]
    })
  }
).then(r => r.json());
Pricing

Simple, transparent pricing

Institutional-grade Shariah screening data that banks pay $50K+/year for — starting free. No hidden fees, no enterprise contracts required.

Free

Perfect for testing & evaluation

$0 forever
  • ✓ 500 tokens/month
  • ✓ All endpoints accessible
  • ✓ 5 screening methodologies
  • ✓ Community support
Get Free Key

Starter

For individual developers & small apps

$19 /month
  • ✓ 2,500 tokens/month
  • ✓ All endpoints accessible
  • ✓ 5 screening methodologies
  • ✓ Email support
  • ✓ Usage analytics dashboard
  • ✓ Overage: $0.01/token
Subscribe

Pro

For growing products & fintech teams

$49 /month
  • ✓ 15,000 tokens/month
  • ✓ All endpoints accessible
  • ✓ 5 screening methodologies
  • ✓ Priority email support
  • ✓ Usage analytics dashboard
  • ✓ Bulk screening priority queue
  • ✓ Webhook notifications
  • ✓ Overage: $0.008/token
Subscribe

Enterprise

For banks, funds & large organizations

$199 /month
  • ✓ Unlimited tokens
  • ✓ All endpoints accessible
  • ✓ Custom methodologies
  • ✓ Dedicated support & SLA
  • ✓ On-premise deployment
  • ✓ SSO & team management
  • ✓ Custom integrations
Subscribe

Token costs vary by endpoint: lightweight reads cost 1–2 tokens, screening costs 5–10, heavy operations up to 50. View full token cost table →

Get your free API key in seconds

Start with 5 free requests. No credit card required. Upgrade anytime.

We'll send your API key to this email. No spam, ever.

API Reference

58+ endpoints, 22 MCP tools across 15 categories

Full REST API with OpenAPI documentation. View full docs →

POST/api/screen/{symbol}Screen single stock
GET/api/result/{symbol}Get cached result
GET/api/resultsAll screening results
POST/api/screen-bulkBulk screen index
GET/api/screen-bulk/statusBulk job status
GET/api/screen-bulk/{run_id}/resultsPaginated results
GET/api/screen-bulk/{run_id}/summaryRun summary
GET/api/screen-bulk/compareCompare two runs
GET/api/screen-bulk/{run_id}/export/csvExport CSV
GET/api/quote/{symbol}Real-time quote
GET/api/ohlc/{symbol}Historical OHLC
POST/api/quotes/batchBatch quotes (50 max)
GET/api/asset/{symbol}/fullFull asset profile
GET/api/trendingTrending movers
POST/api/portfolio/scanMulti-symbol compliance
GET/api/suggestAutocomplete search
GET/api/database/searchFull-text search
GET/api/database/stock/{symbol}Stock metadata
GET/api/database/statsAsset statistics
GET/api/etf/{symbol}/holdingsETF holdings
POST/api/etf/{symbol}/screenScreen holdings
POST/api/etf/{symbol}/purificationPurification calc
POST/api/etf/compareCompare ETFs
POST/api/etf/screen-bulkBulk ETF screen
GET/api/dividends/{symbol}Dividend history
POST/api/dividends/{symbol}/purificationPurification calc
POST/api/zakat/calculateZakat calculation
POST/api/purification/calculateDividend purification
GET/api/education/glossaryIslamic finance terms
GET/api/education/methodologiesAll methodologies
GET/api/education/screening-criteriaScreening criteria
GET/api/newsAggregated news
GET/api/news/sourcesNews sources
GET/api/filings/{symbol}SEC filings
GET/api/filings/{symbol}/factsXBRL financial facts
GET/api/disclaimersFull disclaimer registry (no key)
GET/api/disclaimers/{id}Single disclaimer lookup
POST/api/watchlistsCreate watchlist
GET/api/watchlistsList watchlists
POST/api/compareCompare symbols
GET/api/reports/screening/{symbol}Screening report
POST/api/reports/portfolioPortfolio report
MCPscreen_stockFull Shariah compliance screen
MCPget_quoteReal-time quote (single or batch)
MCPscan_portfolioPortfolio compliance scan
MCPsearch_stocksDatabase search with filters
MCPscreen_etfETF holdings screening
MCPcalculate_zakatZakat and purification
MCPget_newsFinancial news with sentiment
MCPislamic_finance_educationGlossary and methodology guide
REShalal://glossaryIslamic finance terms (resource)
REShalal://methodologiesScreening methodologies (resource)
$6T+ Islamic Finance Industry
21% YoY Industry Growth
484 Islamic Fintech Companies
1.8B Muslims Worldwide
FAQ

Frequently asked questions

Shariah screening evaluates whether a company's financial ratios and business activities comply with Islamic law. It checks debt levels, interest-bearing income, impure revenue sources (alcohol, gambling, tobacco, weapons), and receivable ratios against thresholds set by recognized Islamic finance standards bodies.

Yes. Beyond equities and ETFs, Halal Terminal maintains a structural sukuk registry you can query by issuer, country, structure, documentation basis, currency, and maturity. Each instrument carries an AAOIFI pre- and post-Standard 62 disposition plus a per-methodology grid, and a portfolio-impact endpoint scores the sukuk sleeve of a portfolio. See GET /api/sukuk/search and GET /api/sukuk/{isin}, or read the sukuk screening guide.

Different regions and institutions follow different Shariah standards. Gulf states typically follow AAOIFI, Malaysian investors may use DJIM or FTSE, while global asset managers often reference MSCI or S&P. By screening against all five simultaneously, our API lets you serve any market from a single integration. All five are audited end-to-end against their published specs — DJIM and S&P use the prescribed 24-month and 36-month trailing-average market cap rather than spot MC — and every response carries a verified: true flag on every methodology.

Financial data is sourced from SEC filings and market data providers. Screening results reflect the latest available annual/quarterly financial statements. Market data (quotes, OHLC) is near real-time with configurable cache TTLs.

Even compliant companies may earn a small percentage of income from impure sources (e.g., interest income). Purification calculates the portion of dividends an investor should donate to charity to “purify” their returns. Our API computes this automatically based on each company's impure income ratio.

Yes. All paid plans (Starter, Pro, Enterprise) allow commercial use. You can integrate the API into your app, website, robo-advisor, or internal tool. Enterprise plans include custom SLAs and on-premise deployment options.

Consumer apps like Zoya and Islamicly offer end-user screening interfaces but don't provide developer APIs. Institutional providers like MSCI and Refinitiv charge $30K–$100K+/year and require enterprise contracts. Halal Terminal API offers the same institutional-grade data through a developer-friendly REST API starting at $19/month.

All API requests require an X-API-Key header. Generate a free key instantly with your email — no credit card required. Keys are scoped to plans with token-based quotas that reset monthly. Each endpoint costs a specific number of tokens.

MCP (Model Context Protocol) is an open standard that lets AI assistants like Claude Desktop, Cursor, and Windsurf call external tools. Our MCP server exposes 22 tools and 7 resources — so you can ask your AI “Is Apple halal?” or “Screen my portfolio” and it calls our API directly. Run locally via python -m backend.mcp_server (stdio) or deploy as a Docker service on port 8001 (SSE). No API key needed for MCP — it calls services directly.

Yes. Our database covers 200,000+ assets across NYSE, NASDAQ, LSE, and other major exchanges. Coverage includes stocks, ETFs, and other equity instruments across 21 global indices.

No. Our verdicts are produced by automated screening of public financial filings against the five published methodologies (AAOIFI, DJIM, FTSE, MSCI, S&P). They are not a fatwa or scholarly attestation. Every relevant response carries a disclaimers array — versioned, severity-tagged, and deep-linked to our legal disclaimer page — so your downstream users see the same caveats your compliance team would write themselves. Hit GET /api/disclaimers for the full registry.

Our zakat calculator returns a simplified 2.5% estimate using current gold nisab — the disclaimer it ships with explicitly names what it skips: the silver-nisab alternative, the hawl (lunar-year ownership) requirement, business-inventory rules, and liability deductions. Purification estimates the non-permissible portion of dividend income under the chosen methodology and ships with a disclaimer noting that capital-gains treatment and eligible recipients are matters on which scholars differ. Your users get the obligation to consult a scholar surfaced inline, not buried in a Terms of Service.