screening

Get Run 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 stocks.

curl example:

curl -X GET "https://api.halalterminal.com/api/screen-bulk/abc123/summary" \
     -H "X-API-Key: <API_KEY>"

Python requests example:

import requests

resp = requests.get(
    "https://api.halalterminal.com/api/screen-bulk/abc123/summary",
    headers={"X-API-Key": "<API_KEY>"},
)
print(resp.json())

get/api/screen-bulk/{run_id}/summary

Request

Base URL: https://api.halalterminal.com
URL: https://api.halalterminal.com/api/screen-bulk/{run_id}/summary
Auth: API key in header X-API-Key

Path parameters

run_idstring required

Bulk-run ID returned by POST /api/screen-bulk.

Response

Aggregated compliance summary for the screening run

run_idstring required

index_namestring required

completed_atstring nullable

duration_secondsinteger nullable

Wall-clock time in seconds from start to finish

total_screenedinteger required

by_methodologyobject required

Compliance breakdown per screening methodology

by_sectorobject required

Compliance breakdown per GICS sector

Example response

{
  "by_methodology": {
    "aaoifi": {
      "compliant": 298,
      "errors": 6,
      "insufficient_data": 21,
      "non_compliant": 178
    },
    "djim": {
      "compliant": 334,
      "errors": 6,
      "insufficient_data": 21,
      "non_compliant": 142
    }
  },
  "by_sector": {
    "Healthcare": {
      "compliance_rate": 65.08,
      "compliant": 41,
      "total": 63
    },
    "Technology": {
      "compliance_rate": 66.67,
      "compliant": 52,
      "total": 78
    }
  },
  "completed_at": "2025-01-15T08:12:45Z",
  "duration_seconds": 765,
  "index_name": "SP500",
  "overall": {
    "compliance_rate": 62.03,
    "compliant": 312,
    "errors": 6,
    "non_compliant": 185
  },
  "run_id": "run_2025-01-15_sp500",
  "top_compliant": [
    {
      "methodology_count": 5,
      "purification_rate": 0.012,
      "symbol": "AAPL"
    },
    {
      "methodology_count": 5,
      "purification_rate": 0.008,
      "symbol": "MSFT"
    }
  ],
  "total_screened": 503
}

Changes

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