screening

Cancel Run

Cancel a running bulk screening job.

Stops the specified run gracefully. Results already collected are preserved and can still be queried. Returns the run status at the time of cancellation.

curl example:

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

Python requests example:

import requests

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

Request

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

Path parameters

run_idstring required

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

Response

Confirmation that the run has been cancelled

run_idstring required
statusstring required
doneinteger required

Number of symbols that were screened before cancellation

totalinteger required

Total number of symbols that were queued

Example response

{
  "done": 247,
  "run_id": "run_2025-01-15_sp500",
  "status": "cancelled",
  "total": 503
}

Changes

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