Install Jentic One Beta

Connect the Halal Terminal API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Halal Terminal API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fhalalterminal.com%2Fhalalterminal" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fhalalterminal.com%2Fhalalterminal" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Halal Terminal API.

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

GET STARTED

Start building with Halal Terminal API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Halal Terminal API for, with concrete tasks.

★ 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.

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.

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.

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.

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

Key Endpoints

91 endpoints — the halal terminal api screens stocks, etfs, and sukuk for shariah compliance and serves the market data behind it.

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

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

Why Jentic?

What agents get from Jentic-routed access to this vendor.

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 isolation

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.

Intent-based discovery

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.

FAQs

Specific to using Halal Terminal API through Jentic.

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.

Halal Terminal API

AI ReadinessAI-Aware (B)65/100

See full scorecard

Official vendor OpenAPI document · agent-readyFinanceBankingapiKey91 EndpointsREST

For 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.

Use for: Screen a stock ticker for Shariah compliance, Get a Shariah compliance report for a symbol, Scan my portfolio for non-compliant holdings, Calculate the zakat due on an asset

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

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.

Jentic One on Github View OpenAPI Document

Show dimension breakdown

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: A-Signals: 4

95%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

100%

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: BSignals: 4

Example Density

How richly the API is illustrated with examples.

100%

Example Validity

Percentage of examples that conform to their schemas.

51%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: C-Signals: 4

60%

Description Coverage

Coverage of descriptions across API elements.

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

100%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

51%

Summary Coverage

Coverage of summaries across operations/tags/info.

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: ASignals: 1

87%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

Security

Trust, risk posture, and security compliance.

Grade: C-Signals: 1

50%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: A-Signals: 1

79%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the Halal Terminal API to your agent

Capabilities

Start building with Halal Terminal API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

Halal Terminal API

Jentic AI Readiness Score

Halal Terminal API

Foundational Compliance

Lint Results

Resolution Completeness

Specification Validity

Structural Integrity

Developer Experience & Jentic Compatibility

Example Density

Example Validity

Response Coverage

Tooling Readiness

AI-Readiness & Agent Experience

Description Coverage

Error Standardization

OperationId Quality

Summary Coverage

Agent Usability

Complexity Comfort

Security

Authentication Strength

AI Discoverability

Descriptive Richness