reports

Get Screening Report

Generate a Shariah compliance screening report for a single stock.

Returns a comprehensive report including business activity screening, financial ratio analysis, and an overall compliance determination for the given ticker symbol. The report uses the configured screening methodology (e.g. AAOIFI thresholds).

curl example:

curl -X GET "http://localhost:8000/api/reports/screening/AAPL"

Python requests example:

import requests

resp = requests.get("http://localhost:8000/api/reports/screening/AAPL")
report = resp.json()
print(f"Symbol: {report['symbol']}")
print(f"Compliant: {report['screening']['is_compliant']}")
print(f"Generated: {report['report_generated_at']}")
get/api/reports/screening/{symbol}

Request

  • Base URL: https://api.halalterminal.com
  • URL: https://api.halalterminal.com/api/reports/screening/{symbol}
  • Auth: API key in header X-API-Key

Path parameters

symbolstring required

Ticker symbol to generate the screening report for.

Response

Full Shariah compliance screening report for the symbol

symbolstring required

Ticker symbol of the screened company

report_generated_atstring required

ISO 8601 timestamp when the report was generated

screeningobject required

Detailed screening results including business and financial ratio checks

Example response

{
  "report_generated_at": "2026-03-24T12:00:00Z",
  "screening": {
    "business_screening": {
      "haram_revenue_percentage": 0.02,
      "passed": true
    },
    "financial_screening": {
      "debt_to_total_assets": 0.25,
      "interest_income_to_revenue": 0.01,
      "passed": true
    },
    "is_compliant": true,
    "methodology": "aaoifi"
  },
  "symbol": "AAPL"
}

Changes

No recorded changes to this operation across all 1 revision of this API.