screening

Export Csv

Export screening results as a CSV file.

Returns a downloadable CSV containing every screened symbol, its compliance status, financial ratios, and methodology-level verdicts.

curl example:

curl -X GET "https://api.halalterminal.com/api/screen-bulk/abc123/export/csv" \
     -H "X-API-Key: <API_KEY>" \
     -o screening_results.csv

Python requests example:

import requests

resp = requests.get(
    "https://api.halalterminal.com/api/screen-bulk/abc123/export/csv",
    headers={"X-API-Key": "<API_KEY>"},
)
with open("screening_results.csv", "w") as f:
    f.write(resp.text)
get/api/screen-bulk/{run_id}/export/csv

Request

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

Path parameters

run_idstring required

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

Response

CSV file download of all screening results

unknown required

Changes

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