canonical: https://jentic.com/apis/halalterminal.com/halalterminal

# Halal Terminal API

The Halal Terminal API screens stocks, ETFs, and sukuk for Shariah compliance and serves the market data behind it. It runs single-symbol and bulk screening across AAOIFI and custom methodologies, scans portfolios for compliance, and generates screening and portfolio reports. It also returns real-time quotes, OHLC candles, SEC filings and XBRL company facts, dividend history, and news, and includes zakat and dividend-purification calculators. A free key unlocks most endpoints, with a few open ones for health and plan details.

## For AI agents

Screen stocks, ETFs, and sukuk for Shariah compliance, scan portfolios, and read market data, filings, and dividends. Agents can also calculate zakat and dividend purification.

## Scope

Does not execute trades, hold assets, or issue religious rulings. Use for Shariah compliance screening and financial market data only.

## Capabilities

- Screen individual stocks and ETFs for Shariah compliance across methodologies
- Run bulk screening jobs over indices and track their status and results
- Scan a portfolio for compliance and generate screening reports
- Retrieve real-time quotes, OHLC candles, and full asset details
- Calculate zakat and dividend purification amounts
- Read SEC filings, XBRL company facts, and dividend history
- Look up sukuk reference data and screen ETF holdings

## Use cases

### AI Agent Shariah Screening

An AI agent connected through Jentic can check whether a ticker is Shariah-compliant and explain why, without a human running a terminal. The agent searches for the screening operation, Halal Terminal returns its input schema, and the agent submits a symbol and reads the verdict with its ratios. This supports compliant-investing assistants and research bots.

Example prompt: Screen a stock symbol and report whether it is compliant along with the reason

### Portfolio Compliance Scanning

Submit a set of positions and scan the whole portfolio for Shariah compliance, weighting by position size, then generate a portfolio report. This lets an advisor tool flag non-compliant holdings and quantify exposure across a book.

Example prompt: Scan a portfolio of holdings and generate a compliance report

### Zakat and Dividend Purification

Calculate the zakat due on holdings and the purification amount owed on impure dividend income, using Halal Terminal's dividend history and purification rates. This covers the obligations a compliant investor settles each year.

Example prompt: Calculate the zakat due and the dividend purification amount for a holding

### ETF Compliance Analysis

Retrieve an ETF's holdings and screen each one for Shariah compliance, then compute the fund's purification ratio. An agent can rank ETFs by compliant weight or compare several funds side by side.

Example prompt: Retrieve an ETF's holdings and screen each holding for compliance

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/screen/{symbol}` | Screen a symbol for Shariah compliance |
| POST | `/api/portfolio/scan` | Scan a portfolio for compliance |
| POST | `/api/zakat/calculate` | Calculate zakat |
| GET | `/api/quote/{symbol}` | Real-time quote for a symbol |
| GET | `/api/dividends/{symbol}/purification` | Dividend purification for a symbol |
| GET | `/api/etf/{symbol}/holdings` | ETF holdings |
| GET | `/api/filings/{symbol}` | SEC filings for a symbol |
| POST | `/api/screen-bulk` | Run a bulk screening job |

## Key resources

- **Screening** — Single-symbol and bulk Shariah screening with runs and results
- **Market** — Quotes, OHLC candles, trending tickers, and asset details
- **Filings and Dividends** — SEC filings, XBRL facts, and dividend purification
- **Zakat** — Zakat and dividend-purification calculators
- **ETF and Sukuk** — ETF holdings screening and sukuk reference data

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 65 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 74 / 100
  - Developer Experience & Jentic Compatibility: 64 / 100
  - AI-Readiness & Agent Experience: 53 / 100
  - Agent Usability: 87 / 100
  - Security: 50 / 100
  - AI Discoverability: 79 / 100
- **View full report:** https://jentic.com/apis/halalterminal.com/halalterminal/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Halal Terminal API by hand means generating an API key, passing it in the X-API-Key header on protected calls, and separating the open endpoints from the metered ones. Through Jentic you install once, import Halal Terminal from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Halal Terminal separates its read endpoints (screening, quotes, filings, reports) from account operations like key generation, revocation, and billing checkout, so a rule can hold your agent to the data reads it needs. You choose the operations it may call, so revoking a key or starting a billing checkout is not included unless you add it.
- **Credential handling:** Your Halal Terminal API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'screen a stock for Shariah compliance' or 'calculate zakat', and Jentic returns the matching Halal Terminal operation with its input schema so the agent calls the right endpoint without reading the docs.

## Related APIs

- **Finnhub** — Stock fundamentals, quotes, and filings for global markets.
- **Polygon** — Real-time and historical market data across asset classes.
- **Alpha Vantage** — Free stock, forex, and fundamentals data.
- **SEC EDGAR** — Official filings and company facts from the SEC.

## FAQ

### What authentication does the Halal Terminal API use?

The Halal Terminal API authenticates with an API key sent in the X-API-Key header per its OpenAPI spec; you can generate a free key, and a few endpoints such as the health check and plan listing need no key. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at call time, so it never reaches the agent's prompt or logs.

### Can I screen a stock for Shariah compliance with the Halal Terminal API?

Yes. Submit a ticker to the screening endpoint and it returns the compliance verdict with the underlying ratios, drawn from AAOIFI and custom methodologies. Bulk screening across whole indices, portfolio scans, and per-holding ETF screening are available too.

### Is there a Halal Terminal MCP server?

You don't need an MCP server to give your agent the Halal Terminal API. Jentic connects it directly from the API Directory: import the API, store your key once, and your agent calls the screening and market-data endpoints it needs.

### Can I limit what my agent is allowed to do with the Halal Terminal API?

Yes. Write a rule that allows only the screening, quote, and report read operations, so a research agent can analyse compliance while key revocation and billing operations stay out of reach, and every call it makes is logged.

### What are the rate limits for the Halal Terminal API?

The OpenAPI spec does not publish fixed rate limits; usage is tied to your plan and key. Halal Terminal exposes per-key usage endpoints you can poll, a token-costs endpoint, and a plans endpoint that lists tier details, so you can track consumption against your plan.

### How do I screen a stock with the Halal Terminal API through Jentic?

Search Jentic for an intent like 'screen a stock for Shariah compliance', and it returns the Halal Terminal screening operation with its input schema so your agent calls it with a ticker. Your stored key is injected at call time. To run it on your own infrastructure, install Jentic One from its GitHub repo.