Skip to main content

​
Overview

The /v1/screen endpoint lets you check compliance for up to 50 stocks at once. This is ideal for screening a portfolio, validating a watchlist, or building a compliance dashboard.

​
Basic portfolio screen

curl -X POST https://api.halal.sh/v1/screen \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "symbols": ["AAPL", "MSFT", "NVDA", "GOOGL", "AMZN", "JPM", "BAC", "LLY", "UNH", "V"],
    "include": ["determination", "screens"]
  }'

​
Response

{
  "data": {
    "results": [
      {
        "symbol": "AAPL",
        "name": "Apple Inc.",
        "status": "compliant",
        "confidence": 0.92,
        "screens": {
          "business_activity": { "result": "pass" },
          "debt_to_market_cap": { "value": 0.037, "threshold": 0.30, "passes": true },
          "prohibited_revenue": { "value": 0.012, "threshold": 0.05, "passes": true },
          "cash_receivables_to_market_cap": { "value": 0.022, "threshold": 0.30, "passes": true }
        }
      },
      {
        "symbol": "JPM",
        "name": "JPMorgan Chase & Co.",
        "status": "non-compliant",
        "confidence": 0.98,
        "screens": {
          "business_activity": { "result": "fail" }
        }
      }
    ],
    "summary": {
      "total": 10,
      "compliant": 8,
      "non_compliant": 2
    }
  }
}

​
Filtering by compliance status

You can also screen without specific symbols — just filter the universe: 
curl -X POST https://api.halal.sh/v1/screen \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "compliant",
    "sector": "Technology",
    "market_cap": "large",
    "stability": "stable",
    "include": ["determination", "stability"],
    "limit": 20
  }'
This returns all large-cap, stable, compliant technology stocks — useful for building a Shariah-compliant investment universe.

​
Include options

Control which fields are returned per result:
Include valueWhat it addsUse case
determinationStatus + confidenceQuick pass/fail check
screensIndividual ratio resultsDetailed compliance view
stabilityStability rating + driversRisk assessment
market_dataCurrent price + market capPortfolio valuation
Requesting fewer fields reduces response size and improves performance.