Halal Terminal

com.halalterminalPublished by halalterminal.comOfficial publisherv1.0.0Updated Oct 24, 2026

Shariah-compliant stock and ETF screening across AAOIFI, DJIM, FTSE, MSCI and S&P methodologies.

VerifiedSSEWeb executableFinanceData & Analytics

Overview

AI-generated overview

Halal Terminal screens stocks and ETFs against five Shariah methodologies, and adds market data, portfolio audits, zakat and purification calculations.

What you can do
  • Screen individual stocks and ETFs, run bulk index screens and retrieve past screening results
  • Fetch quotes, stock info, price history, trending names and symbol search
  • Analyze ETFs: constituent-level screening, purification rates and ETF comparisons
  • Scan portfolios and watchlists, and compare stocks side by side
  • Compute dividends, zakat and dividend purification, and pull news and SEC filings
  • Generate reports and answer Islamic-finance education questions
When to use it
Useful when an assistant needs to answer Islamic-finance questions such as whether a stock or ETF is compliant under a given standard, audit a portfolio's compliance share, or work out zakat and dividend purification amounts.
Requirements
A Halal Terminal API key (prefix ht_), obtained by email signup; free tier available. Supply it as the HALALTERMINAL_API_KEY environment variable for the npx stdio bridge, or as the X-API-Key header (or api_key query parameter) for the remote SSE endpoint. Node.js is needed for the npx package; network access to the Halal Terminal API.
Before you install
The API key is a secret and is passed in a header, environment variable or URL query parameter; keep it out of shared configs and logs. Usage is token-metered, and paid plans cost money, so heavy screening can consume quota. Screening verdicts are methodology-based research, not a fatwa or investment advice, and the server has no trading or order execution. Portfolio and watchlist tools take your holdings data and send it to the Halal Terminal API.

Installation

In SourceWeft

  1. Open Halal Terminal in the dashboard and add it to a workspace.
  2. Connect X-API-Key credentials. They are stored privately and never shown on public pages.
  3. Enable the server for the chats that should use its tools.

Web executable via SSE. Remote servers run from the web runtime once configured in a workspace.

Use with an agent

Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.

Read https://sourceweft.com/mcp/com.halalterminal%2Fmcp/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.

Read the install guide the agent follows

Other MCP clients

Add this to your client's mcpServers config.

{
  "mcpServers": {
    "halal-terminal": {
      "type": "sse",
      "url": "https://mcp.halalterminal.com/sse",
      "headers": {
        "X-API-Key": "<YOUR_API_KEY>"
      }
    }
  }
}

README

Halal Terminal MCP — Shariah-compliant stock & ETF screening for AI agents

English | العربية | Bahasa Indonesia | Melayu | اردو | Français

[AAPL halal status] live badge from the API, embed one for any symbol

[npm version] [Apache 2.0] [MCP] [Powered by Halal Terminal]

The official Model Context Protocol server for Halal Terminal. Give your AI agent 22 tools to answer Islamic-finance questions: screen any stock or ETF across 5 methodologies (AAOIFI, DJIM, FTSE, MSCI, S&P), audit portfolios, calculate zakat and dividend purification, and pull live market data, news and SEC filings. Works inside Claude Desktop, Claude Code, Cursor, Windsurf, Cline, Continue, Zed, Goose, and any other MCP client.

"Is AAPL halal?" · "Audit my portfolio: AAPL 30%, MSFT 20%, JNJ 50%" · "Calculate zakat on my holdings."

Quick start

  1. Get a free API key — email-only signup at api.halalterminal.com. No credit card. Key arrives in your inbox in seconds.
  2. Connect your client — one-liners below (or see CONNECT.md for Cursor, Windsurf, Cline, and others).
  3. Ask your first question — "Is AAPL halal?" → the agent calls screen_stock and returns verdicts across all 5 methodologies.

Install

bash
# Recommended — no install needednpx -y @halalterminal/mcp
# Or pin globallynpm install -g @halalterminal/mcp

Claude Desktop

json
{  "mcpServers": {    "halalterminal": {      "command": "npx",      "args": ["-y", "@halalterminal/mcp"],      "env": { "HALALTERMINAL_API_KEY": "ht_yourkey" }    }  }}

Claude Code

bash
claude mcp add --transport sse halalterminal \  https://mcp.halalterminal.com/sse \  --header "X-API-Key: ht_yourkey"

Cursor / Windsurf / direct SSE

https://mcp.halalterminal.com/sse?api_key=ht_yourkey

Full setup guide for all clients: CONNECT.md.

What you get — 22 tools across 8 categories

CategoryTools
Screeningscreen_stock, screen_etf, bulk_screen, get_screening_result, get_all_screening_results
Market dataget_quote, get_stock_info, get_price_history, get_trending_stocks, search_stocks
ETF analysisget_etf_info, etf_purification, compare_etfs
Portfolio & watchlistscan_portfolio, manage_watchlist
Comparisoncompare_stocks
Income & zakatget_dividends, calculate_zakat
News & filingsget_news, get_sec_filings
Reports & educationgenerate_report, islamic_finance_education

Full input/output reference in TOOLS.md. End-to-end prompt walkthroughs in EXAMPLES.md.

Why Halal Terminal

  • 5 methodologies, one tool. AAOIFI, DJIM, FTSE Shariah, MSCI Islamic, and S&P Shariah — each with distinct business-activity rules and financial-ratio thresholds — surfaced side-by-side per stock so users pick the standard they follow.
  • Holdings-level ETF screening. Every constituent is screened, weighted, and aggregated into an overall verdict plus a per-dollar purification rate. Covers SPY, QQQ, VTI, ISDU, SPUS, HLAL, and 8,000+ ETFs.
  • Zakat & purification, computed. 2.5% zakat against a live nisab threshold; per-dividend impure-income calculation based on the issuer's non-compliant revenue ratio.
  • Bulk index screens. Trigger-and-poll runs on the S&P 500, NASDAQ-100, FTSE 100, and others; filter by methodology, sector, or compliant-only.
  • Free tier, no credit card. Email signup → key in your inbox in seconds → ~5–10 full screens per month at no cost.

Endpoint & transport

SSE: https://mcp.halalterminal.com/sseAuth: X-API-Key: <your_key>   (or ?api_key=<your_key>)

Transports supported: SSE (recommended), stdio (via this @halalterminal/mcp bridge for clients that need it).

Plans & quotas

The Halal Terminal API is token-metered, not request-metered.

PlanMonthly tokensPriceNotes
Free50$0~5–10 full screenings · email signup, no credit card
Starter2,500$19Individual investors
Pro15,000$49Webhooks, bulk priority
EnterpriseUnlimited$199+Custom methodologies, SLA

Sign up: api.halalterminal.com · Pricing: halalterminal.com/pricing

What this MCP server is NOT

  • Not a fatwa. Every verdict is a methodology-based screening. Consult a qualified scholar for personal rulings.
  • Not a trading platform. No broker integrations, no order execution.
  • Not a real-time alert system. Request-response only in v1; webhook-driven alerts are on the Pro+ roadmap.
  • English-only in v1. Arabic + French rendering is on the roadmap.

FAQ

Is this MCP server free to use?

Yes. The @halalterminal/mcp package is Apache-2.0 and free. The Halal Terminal API has a free tier (500 tokens / month, no credit card) that covers ~100 full stock screenings — enough to evaluate it before upgrading.

Which AI clients does it work with?

Any client that supports the Model Context Protocol over SSE or stdio — Claude Desktop, Claude Code, Cursor, Windsurf, Cline, Continue, Zed, Goose, and more. SSE is recommended; the @halalterminal/mcp package wraps it as stdio for clients that don't yet support SSE.

How is "halal" determined?

Each verdict applies the published rules of the chosen methodology — AAOIFI, Dow Jones Islamic Market (DJIM), FTSE Shariah, MSCI Islamic, and S&P Shariah. Two layers: (1) a business-activity screen (no alcohol, gambling, conventional finance, adult content, weapons, pork, …), then (2) financial-ratio thresholds (e.g. interest-bearing debt over market cap, illiquid assets, interest income share). The MCP exposes all five verdicts so the user — or scholar — can pick the standard they follow.

What is dividend purification?

When you hold a stock with a small share of non-compliant revenue, scholars require donating the non-compliant fraction of any dividend received. calculate_zakat(calculation_type="purification", …) and get_dividends(include_purification=True) compute that amount automatically.

Can it screen ETFs?

Yes — screen_etf walks every underlying holding, applies the methodology to each, and returns an overall verdict, compliant percentage, and aggregate purification rate. Sukuk ETFs are handled separately (asset-based methodologies).

Can I screen an entire index at once?

Yes — bulk_screen triggers an asynchronous run on indices like S&P 500, NASDAQ-100, FTSE 100, and lets you poll for status, filter results by methodology / sector / compliant-only, and diff two runs.

Does it support webhooks for compliance changes?

Webhooks are a Pro-plan feature on the API roadmap; v1 of this MCP is request-response only.

Where do I report bugs or request tools?

github.com/goww7/halalterminal-mcp/issues or email [email protected].

Learn more

Part of the Halal Terminal ecosystem

Website · API · Python SDK · JS SDK · Claude plugin · Discord bot · TradingView indicator · Portfolio tracker

Related projects (sibling OSS)

Open-source tools that share the same Halal Terminal API — different surfaces, same data:

ProjectWhat it isLicense
halalterminal-claude-skillsClaude Code plugin — curated skills, slash commands, and a portfolio-builder subagent on top of this MCP server.Apache-2.0
yassir-ossOpen-source ReAct agent for halal finance research — CLI + web UI; supports OpenAI / Anthropic / local LLMs.Apache-2.0
halal-discord-botDiscord bot — /halal AAPL, /portfolio, /trending slash commands.MIT
halal-portfolio-trackerNext.js 14 app — enter holdings, get per-stock compliance + portfolio halal % + purification owed. One-click Vercel deploy.MIT
halal-pineTradingView Pine Script v5 indicator that overlays compliance status on charts. Refreshed daily from this API.MIT

License & trademarks

Apache-2.0 — see LICENSE.

"Halal Terminal", "HalalTerminal", and the Halal Terminal logo are reserved trademarks — see TRADEMARKS.md.

Legal

Support


Powered by Halal Terminal — halalterminal.com


Part of the Halal Terminal open ecosystem: API · MCP server · Python SDK · JS SDK · Datasets · Awesome Islamic Finance

Source: README.md at commit ad6593c

Tools

0
This server asks for a credential such as an API key, so SourceWeft could not read its tools without one and has not indexed them.

Version history

1
  1. v1.0.0LatestSep 16, 2026

Score

85% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 daysRequired25 pts
  • Auth declaredRequired10 pts
  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts

Other Halalterminal integrations