portfolio

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 the flag is silently treated as False.

post/api/portfolio/scan

Request

Base URL: https://api.halalterminal.com
URL: https://api.halalterminal.com/api/portfolio/scan
Auth: API key in header X-API-Key

Request body

symbolsstring[] required

List of ticker symbols to screen (e.g. ['AAPL', 'MSFT', 'GOOGL']).

force_refreshboolean

When true, bypass cached screening results and re-screen from scratch.

Example request

{
  "force_refresh": false,
  "symbols": [
    "AAPL",
    "MSFT",
    "GOOGL"
  ]
}

Response

Per-symbol screening results and aggregate portfolio compliance summary.

resultsobject required

Mapping of ticker symbol to its screening result.

Example response

{
  "results": {
    "AAPL": {
      "compliance_status": "compliant",
      "name": "Apple Inc.",
      "purification_rate": 0.025,
      "symbol": "AAPL"
    },
    "MSFT": {
      "compliance_status": "compliant",
      "name": "Microsoft Corp.",
      "purification_rate": 0.031,
      "symbol": "MSFT"
    }
  },
  "summary": {
    "avg_purification_rate": 0.028,
    "compliant": 2,
    "engine_version": "abc1234",
    "non_compliant": 0,
    "pending": 0,
    "total": 2
  }
}

Changes

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