Halal Terminal API
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.
1 subscribers
8.2/10 popularity
421 ms avg latency
50% success rate
71 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Halal Terminal API endpoints
| Method | Endpoint | Description |
|---|---|---|
| health | ||
| GET |
health_check_api_health_get /api/health |
Check API health status. Returns a simple status message confirming the API is running. This endpoint requires no authentication and is suitable for uptime monitors and… |
| screening | ||
| POST |
cancel_run_api_screen_bulk__run_id__cancel_post /api/screen-bulk/{run_id}/cancel |
Cancel a running bulk screening job. Stops the specified run gracefully. Results already collected are preserved and can still be queried. Returns the run status at the time of… |
| POST |
screen_bulk_api_screen_bulk_post /api/screen-bulk |
Trigger a new bulk Shariah screening run. Starts asynchronous screening of all tickers in the specified index (e.g. "SP500", "DJIA"). Returns immediately with a run ID that can… |
| GET |
compare_runs_api_screen_bulk_compare_get /api/screen-bulk/compare |
Compare the results of two bulk screening runs. Identifies symbols whose compliance status changed between run A and run B, including newly compliant, newly non-compliant, added,… |
| POST |
screen_symbol_api_screen__symbol__post /api/screen/{symbol} |
Screen a single symbol for Shariah compliance. Performs a full Shariah compliance analysis on the given ticker, including business activity screening and financial ratio checks… |
| GET |
get_result_api_result__symbol__get /api/result/{symbol} |
Get the cached screening result for a single symbol. Returns the most recent Shariah compliance screening result for the given ticker symbol. Returns 404 if the symbol has not… |
| DELETE |
delete_run_api_screen_bulk__run_id__delete /api/screen-bulk/{run_id} |
Delete a bulk screening run and its results. Permanently removes a completed or cancelled run and all associated screening results from the database. This action cannot be… |
| GET |
export_csv_api_screen_bulk__run_id__export_csv_get /api/screen-bulk/{run_id}/export/csv |
Export screening results as a CSV file. Returns a downloadable CSV containing every screened symbol, its compliance status, financial ratios, and methodology-level verdicts.… |
| GET |
get_results_api_results_get /api/results |
Get all cached screening results. Returns every screening result currently stored in the database, regardless of when the screening was performed. **curl example:** ```bash curl… |
| GET |
bulk_status_api_screen_bulk_status_get /api/screen-bulk/status |
Get the status of a bulk screening run. Returns real-time progress for the active run (or a specific run if `run_id` is provided), including completion percentage, current symbol… |
| GET |
get_run_summary_api_screen_bulk__run_id__summary_get /api/screen-bulk/{run_id}/summary |
Get an aggregated summary of a bulk screening run. Returns compliance statistics broken down by methodology and sector, overall compliance rate, and a list of the top compliant… |
| GET |
list_indices_api_screen_bulk_indices_get /api/screen-bulk/indices |
List available stock indices for bulk screening. Returns every index supported by the bulk-screening engine, along with an estimated ticker count and a short description. **curl… |
| GET |
export_json_api_screen_bulk__run_id__export_json_get /api/screen-bulk/{run_id}/export/json |
Export screening results as JSON. Returns the complete screening dataset for a run in JSON format, suitable for programmatic consumption or archiving. **curl example:** ```bash… |
| GET |
get_results_updates_api_results_updates_get /api/results/updates |
Get screening results updated since a given timestamp. Returns only the results that have been created or modified after the `since` ISO-8601 timestamp. Useful for incremental… |
| GET |
get_run_results_api_screen_bulk__run_id__results_get /api/screen-bulk/{run_id}/results |
Retrieve filtered, paginated results for a bulk screening run. Returns individual symbol screening results for the given run. Supports filtering by compliance status, methodology… |
| GET |
list_runs_api_screen_bulk_runs_get /api/screen-bulk/runs |
List historical bulk screening runs. Returns a paginated history of screening runs, optionally filtered by index name (e.g. "SP500") or status (e.g. "completed", "running").… |
| database | ||
| GET |
suggest_symbol_api_suggest_get /api/suggest |
Auto-complete symbol suggestions for a search query. Returns a ranked list of symbol suggestions that match the provided query prefix, useful for type-ahead search interfaces.… |
| GET |
get_database_stats_api_database_stats_get /api/database/stats |
Get aggregate statistics about the database contents. Returns counts of equities, ETFs, funds, indices, and screening results, along with the number of distinct sectors and… |
| GET |
search_database_api_database_search_get /api/database/search |
Search the local database of assets with filtering and pagination. Returns a paginated list of assets matching the query string and optional filters for asset type, sector,… |
| GET |
get_stock_from_database_api_database_stock__symbol__get /api/database/stock/{symbol} |
Retrieve the database record for a single stock by symbol. Returns the stored reference data for the given symbol including name, sector, exchange, and country. **curl example**:… |
| market | ||
| GET |
get_trending_api_trending_get /api/trending |
List currently trending assets. Returns an ordered list of assets that are currently trending by trading activity or price movement. **curl example**: ```bash curl -X GET… |
| POST |
get_quotes_batch_api_quotes_batch_post /api/quotes/batch |
Fetch quotes for multiple symbols in a single request. Returns a dictionary keyed by symbol, where each value is either the quote object or null if the symbol could not be… |
| GET |
get_asset_full_api_asset__symbol__full_get /api/asset/{symbol}/full |
Get a comprehensive view of an asset combining multiple data sources. Returns a unified response containing the live quote, Shariah screening result, and static database record… |
| GET |
get_ohlc_api_ohlc__symbol__get /api/ohlc/{symbol} |
Retrieve OHLC candlestick data for a given symbol. Returns a time-series list of Open, High, Low, Close, and Volume data points for the requested symbol, period, and interval.… |
| GET |
get_quote_api_quote__symbol__get /api/quote/{symbol} |
Get a real-time quote for a single symbol. Returns the latest price, change, volume, and key metrics for the requested ticker symbol. **curl example**: ```bash curl -X GET… |
| portfolio | ||
| POST |
portfolio_scan_api_portfolio_scan_post /api/portfolio/scan |
Scan a portfolio of stocks for Shariah compliance. Set `force_refresh=true` to bypass cached screening data — available only for enterprise and internal plans. For other plans… |
| watchlists | ||
| GET |
list_watchlists_api_watchlists_get /api/watchlists |
List all watchlists. Returns every watchlist owned by the authenticated user, ordered by creation date. **curl example**: ```bash curl… |
| POST |
create_watchlist_api_watchlists_post /api/watchlists |
Create a new watchlist. Creates a named watchlist with an optional initial set of symbols. Returns the full watchlist object including its generated ID. **curl example**: ```bash… |
| GET |
get_watchlist_api_watchlists__watchlist_id__get /api/watchlists/{watchlist_id} |
Get a single watchlist by ID. Returns the full watchlist object including all symbols. Raises 404 if the watchlist does not exist. **curl example**: ```bash curl… |
| POST |
add_symbol_to_watchlist_api_watchlists__watchlist_id__symbols_post /api/watchlists/{watchlist_id}/symbols |
Add a symbol to an existing watchlist. Appends a single ticker symbol to the watchlist. Returns the updated watchlist. Raises 404 if the watchlist does not exist. **curl… |
| DELETE |
delete_watchlist_api_watchlists__watchlist_id__delete /api/watchlists/{watchlist_id} |
Delete a watchlist. Permanently removes the watchlist and all its symbol associations. Returns a confirmation object. Raises 404 if the watchlist does not exist. **curl… |
| DELETE |
remove_symbol_from_watchlist_api_watchlists__watchlist_id__symbols__symbol__delete /api/watchlists/{watchlist_id}/symbols/{symbol} |
Remove a symbol from a watchlist. Removes the specified ticker symbol from the watchlist. Returns the updated watchlist. Raises 404 if the watchlist does not exist. **curl… |
| comparison | ||
| POST |
compare_symbols_api_compare_post /api/compare |
Compare Shariah compliance across multiple symbols. Accepts 2-5 ticker symbols and returns screening results, market quotes, and stored database data for each symbol side by… |
| reports | ||
| GET |
export_csv_api_reports_export_csv_get /api/reports/export/csv |
Export all cached screening results as a downloadable CSV file. Returns a CSV file containing the most recent screening results for all previously screened stocks. The file is… |
| POST |
get_portfolio_report_api_reports_portfolio_post /api/reports/portfolio |
Generate a Shariah compliance report for a portfolio of stocks. Accepts a list of ticker symbols and returns an aggregated report with per-holding compliance results, overall… |
| GET |
get_screening_report_api_reports_screening__symbol__get /api/reports/screening/{symbol} |
Generate a Shariah compliance screening report for a single stock. Returns a comprehensive report including business activity screening, financial ratio analysis, and an overall… |
| education | ||
| GET |
get_screening_criteria_api_education_screening_criteria_get /api/education/screening-criteria |
Retrieve the Shariah compliance screening criteria. Returns the business activity screening rules (prohibited sectors and revenue thresholds) and financial ratio screening… |
| GET |
get_methodology_api_education_methodologies__name__get /api/education/methodologies/{name} |
Retrieve detailed information about a specific Shariah screening methodology. Returns comprehensive details for the requested methodology, including its screening process,… |
| GET |
get_glossary_api_education_glossary_get /api/education/glossary |
Retrieve the Islamic finance glossary, optionally filtered by search query. Returns a list of key Islamic finance terms (e.g. Riba, Gharar, Murabaha, Sukuk) with their Arabic… |
| GET |
get_purification_guide_api_education_purification_get /api/education/purification |
Retrieve the dividend purification and zakat guide. Returns educational content on how to purify investment returns that may contain a haram (impermissible) component. Includes… |
| GET |
get_methodologies_api_education_methodologies_get /api/education/methodologies |
List all supported Shariah screening methodologies. Returns summary information for every screening methodology available in the system, such as AAOIFI, SEC Malaysia, DJIM, MSCI,… |
| news | ||
| GET |
get_news_api_news_get /api/news |
Retrieve a paginated list of Islamic finance and market news articles. Returns news articles from all configured sources, optionally filtered by source, category, or free-text… |
| GET |
get_sources_api_news_sources_get /api/news/sources |
List all configured news sources. Returns every news feed source available in the system, including its category, URL, and whether it is currently enabled. **curl example:**… |
| GET |
get_news_for_symbol_api_news__symbol__get /api/news/{symbol} |
Retrieve recent news articles for a specific stock symbol. Returns news articles mentioning the given ticker symbol, ranked by relevance and recency. Useful for researching a… |
| filings | ||
| GET |
get_filings_api_filings__symbol__get /api/filings/{symbol} |
Retrieve SEC EDGAR filings for a company by ticker symbol. Returns a list of filings (10-K, 10-Q, 8-K, etc.) sourced from the SEC EDGAR database. Results can be filtered by… |
| GET |
get_facts_api_filings__symbol__facts_get /api/filings/{symbol}/facts |
Retrieve XBRL company facts for a ticker symbol. Returns structured financial data extracted from the company's SEC filings via the EDGAR XBRL API. Facts are organized by… |
| dividends | ||
| GET |
get_dividend_history_api_dividends__symbol__get /api/dividends/{symbol} |
Retrieve the dividend payment history for a stock. Returns every recorded dividend payment for the given symbol, including the payment date and per-share amount in USD, ordered… |
| GET |
get_dividend_purification_api_dividends__symbol__purification_get /api/dividends/{symbol}/purification |
Calculate dividend purification amounts for a stock. Applies the company's Shariah purification rate to each historical dividend payment and returns per-dividend purification… |
| zakat | ||
| POST |
calculate_zakat_api_zakat_calculate_post /api/zakat/calculate |
Calculate zakat owed on a portfolio of stock holdings. Determines whether the total market value of the provided holdings exceeds the nisab threshold (85 grams of gold at the… |
| POST |
calculate_purification_api_purification_calculate_post /api/purification/calculate |
Calculate dividend purification amounts for multiple holdings at once. For each holding, looks up its Shariah purification rate and applies it to the provided dividend income to… |
+ 21 more endpoints on the provider's documentation.
Halal Terminal API pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
