---
title: "Get Screening Report"
method: GET
path: "/api/reports/screening/{symbol}"
tags: ["reports"]
---

# Get Screening Report

`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`

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:**
```bash
curl -X GET "http://localhost:8000/api/reports/screening/AAPL"
```

**Python requests example:**
```python
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']}")
```

## Path parameters

- `symbol` string, required: Ticker symbol to generate the screening report for.

## Response `200`

Full Shariah compliance screening report for the symbol

- ScreeningReportResponse: Full Shariah compliance screening report for a single stock.
  - `symbol` string, required: Ticker symbol of the screened company
  - `report_generated_at` string, required: ISO 8601 timestamp when the report was generated
  - `screening` object, required: Detailed screening results including business and financial ratio checks

## Other responses

- `401`: Authentication required
- `404`: Resource not found
- `422`: Validation Error
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/halalterminal/apis/halal-terminal-api.md) · [All operations](https://skmtc.dev/halalterminal/apis/halal-terminal-api/llms.txt) · [OpenAPI document](https://skmtc.dev/halalterminal/apis/halal-terminal-api/revisions/78768b250943?raw)