---
title: "Get Run Results"
method: GET
path: "/api/screen-bulk/{run_id}/results"
tags: ["screening"]
---

# Get Run Results

`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`

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:**
```bash
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:**
```python
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())
```

## Path parameters

- `run_id` string, required: Bulk-run ID returned by POST /api/screen-bulk.

## Query parameters

- `compliant` boolean, nullable: Filter by compliance status.
- `methodology` string, nullable: Filter by methodology, e.g. aaoifi or djim.
- `sector` string, nullable: Filter by sector.
- `has_error` boolean, nullable: Filter to results that errored during screening.
- `sort_by` string, nullable: Field to sort results by.
- `sort_order` string: Sort direction, asc or desc.
- `page` integer: Page number, 1-indexed.
- `page_size` integer: Number of results per page.

## Response `200`

Paginated screening results for the specified run

- RunResultsResponse
  - `run_id` string, required
  - `index_name` string, required
  - `total_results` integer, required: Total number of results matching the applied filters
  - `page` integer, required
  - `page_size` integer, required
  - `results` object[], required: List of per-symbol screening result dictionaries

## Other responses

- `401`: API key required or invalid
- `404`: Resource or symbol not found
- `422`: Validation Error
- `429`: Quota exceeded

---

[API](https://skmtc.dev/halalterminal/apis/halal-terminal-api.md) · [All operations](https://skmtc.dev/halalterminal/apis/halal-terminal-api/llms.txt) · [OpenAPI document](https://skmtc.dev/halalterminal/apis/halal-terminal-api/revisions/78768b250943?raw)