screening

Get Run Results

Retrieve filtered, paginated results for a bulk screening run.

Returns individual symbol screening results for the given run. Supports filtering by compliance status, methodology (e.g. "aaoifi", "djim"), sector, and error state, plus sorting and pagination.

curl example:

curl -X GET "https://api.halalterminal.com/api/screen-bulk/abc123/results?compliant=true&methodology=aaoifi&page=1&page_size=20" \
     -H "X-API-Key: <API_KEY>"

Python requests example:

import requests

resp = requests.get(
    "https://api.halalterminal.com/api/screen-bulk/abc123/results",
    params={"compliant": True, "methodology": "aaoifi", "page": 1},
    headers={"X-API-Key": "<API_KEY>"},
)
print(resp.json())
get/api/screen-bulk/{run_id}/results

Request

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

Path parameters

run_idstring required

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

Query parameters

compliantboolean nullable

Filter by compliance status.

methodologystring nullable

Filter by methodology, e.g. aaoifi or djim.

sectorstring nullable

Filter by sector.

has_errorboolean nullable

Filter to results that errored during screening.

sort_bystring nullable

Field to sort results by.

sort_orderstring

Sort direction, asc or desc.

pageinteger

Page number, 1-indexed.

page_sizeinteger

Number of results per page.

Response

Paginated screening results for the specified run

run_idstring required
index_namestring required
total_resultsinteger required

Total number of results matching the applied filters

pageinteger required
page_sizeinteger required
resultsobject[] required

List of per-symbol screening result dictionaries

Example response

{
  "index_name": "SP500",
  "page": 1,
  "page_size": 50,
  "results": [
    {
      "is_compliant": true,
      "purification_rate": 0.012,
      "sector": "Technology",
      "symbol": "AAPL"
    }
  ],
  "run_id": "run_2025-01-15_sp500",
  "total_results": 503
}

Changes

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