screening

Compare Runs

Compare the results of two bulk screening runs.

Identifies symbols whose compliance status changed between run A and run B, including newly compliant, newly non-compliant, added, and removed symbols.

curl example:

curl -X GET "https://api.halalterminal.com/api/screen-bulk/compare?run_a=abc123&run_b=def456" \
     -H "X-API-Key: <API_KEY>"

Python requests example:

import requests

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

Request

  • Base URL: https://api.halalterminal.com
  • URL: https://api.halalterminal.com/api/screen-bulk/compare
  • Auth: API key in header X-API-Key

Query parameters

run_astring required

Run ID of the first (baseline) screening run.

run_bstring required

Run ID of the second (comparison) screening run.

Response

Side-by-side comparison of two screening runs

run_astring required
run_bstring required
index_namestring required
run_a_datestring nullable
run_b_datestring nullable

Example response

{
  "changes": [
    {
      "change": "became_compliant",
      "reason": "Debt-to-assets ratio dropped below 33% threshold",
      "run_a_compliant": false,
      "run_b_compliant": true,
      "symbol": "TSLA"
    }
  ],
  "index_name": "SP500",
  "run_a": "run_2025-01-01_sp500",
  "run_a_date": "2025-01-01T08:00:00Z",
  "run_b": "run_2025-01-15_sp500",
  "run_b_date": "2025-01-15T08:00:00Z",
  "summary": {
    "added_symbols": 2,
    "newly_compliant": 8,
    "newly_non_compliant": 5,
    "removed_symbols": 1,
    "unchanged_compliant": 304,
    "unchanged_non_compliant": 180
  }
}

Changes

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