screening

List Runs

List historical bulk screening runs.

Returns a paginated history of screening runs, optionally filtered by index name (e.g. "SP500") or status (e.g. "completed", "running").

curl example:

curl -X GET "https://api.halalterminal.com/api/screen-bulk/runs?index_name=SP500&page=1&page_size=10" \
     -H "X-API-Key: <API_KEY>"

Python requests example:

import requests

resp = requests.get(
    "https://api.halalterminal.com/api/screen-bulk/runs",
    params={"index_name": "SP500", "page": 1, "page_size": 10},
    headers={"X-API-Key": "<API_KEY>"},
)
print(resp.json())
get/api/screen-bulk/runs

Request

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

Query parameters

index_namestring nullable

Filter runs by index name, e.g. SP500.

statusstring nullable

Filter runs by status, e.g. completed or running.

pageinteger

Page number, 1-indexed.

page_sizeinteger

Number of runs per page.

Response

Paginated list of past and current screening runs

total_runsinteger required
pageinteger required
page_sizeinteger required

Example response

{
  "page": 1,
  "page_size": 20,
  "runs": [
    {
      "compliance_rate": 62.03,
      "created_at": "2025-01-15T08:00:00Z",
      "done": 503,
      "duration_seconds": 765,
      "failed_count": 3,
      "finished_at": "2025-01-15T08:12:45Z",
      "index_name": "SP500",
      "run_id": "run_2025-01-15_sp500",
      "status": "completed",
      "total": 503
    }
  ],
  "total_runs": 1
}

Changes

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