screening

Bulk Status

Get the status of a bulk screening run.

Returns real-time progress for the active run (or a specific run if run_id is provided), including completion percentage, current symbol being processed, and estimated time remaining.

curl example:

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

Python requests example:

import requests

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

get/api/screen-bulk/status

Request

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

Query parameters

run_idstring nullable

Specific run ID to check; defaults to the active or most recent run.

Response

Current status of the active or most recent bulk screening run

run_idstring nullable

runningboolean required

statusstring nullable

Run lifecycle status: pending, running, completed, cancelled, failed

index_namestring nullable

totalinteger

doneinteger

failed_countinteger

Number of symbols that failed during screening

current_symbolstring nullable

Ticker currently being processed

progress_pctnumber

Completion percentage (0.0 to 100.0)

estimated_remaining_secondsinteger nullable

created_atstring nullable

started_atstring nullable

updated_atstring nullable

finished_atstring nullable

last_errorstring nullable

Most recent error message, if any

Example response

{
  "created_at": "2025-01-15T08:00:00Z",
  "current_symbol": "MSFT",
  "done": 247,
  "estimated_remaining_seconds": 312,
  "failed_count": 3,
  "index_name": "SP500",
  "progress_pct": 49.1,
  "run_id": "run_2025-01-15_sp500",
  "running": true,
  "started_at": "2025-01-15T08:00:01Z",
  "status": "running",
  "total": 503,
  "updated_at": "2025-01-15T08:05:23Z"
}

Changes

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