---
title: "List Indices"
method: GET
path: "/api/screen-bulk/indices"
tags: ["screening"]
---

# List Indices

`GET /api/screen-bulk/indices`

## Request

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

List available stock indices for bulk screening.

Returns every index supported by the bulk-screening engine, along with
an estimated ticker count and a short description.

**curl example:**
```bash
curl -X GET "https://api.halalterminal.com/api/screen-bulk/indices" \
     -H "X-API-Key: <API_KEY>"
```

**Python requests example:**
```python
import requests

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

## Response `200`

List of available stock indices with metadata

- IndicesResponse
  - `indices` IndexInfo[], required: Available stock indices for bulk screening
    - `name` string, required: Index identifier, e.g. 'SP500', 'DJIA', 'NASDAQ100'
    - `estimated_count` integer, nullable: Approximate number of tickers in the index
    - `description` string, required: Human-readable description of the index

## Other responses

- `401`: API key required or invalid
- `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)