---
title: "Rated-ETF directory"
method: GET
path: "/api/etf/directory"
tags: ["etf"]
---

# Rated-ETF directory

`GET /api/etf/directory`

## Request

- Base URL: `https://api.halalterminal.com`
- URL: `https://api.halalterminal.com/api/etf/directory`
- Auth: API key in header `X-API-Key`

Directory of every rated ETF, with issuer and Shariah-label facets.

Backs the terminal's ETF explorer. The universe is the funds that carry a
rating (screened at least once), not the 40k-row catalog: an explorer over
funds we cannot say anything about would be listing, not exploring.

``labelled=shariah`` filters to funds that present themselves as Shariah
or Islamic in their own name; ``conventional`` is the complement. The flag
reflects the fund's self-description, never our verdict — a labelled fund
can fail and a conventional one can pass, which is exactly what the
explorer exists to show.

## Query parameters

- `q` string: Free-text search over ticker and fund name.
- `family` string: Filter by issuer family (e.g. iShares, Invesco).
- `labelled` string: Self-description filter: "shariah", "conventional", or "" for all.
- `status` string: Verdict filter: "compliant", "non_compliant", "insufficient_data", or "" for all.
- `limit` integer: Maximum funds to return.
- `offset` integer: Number of matches to skip, for pagination.

## Response `200`

Rated-ETF directory with issuer and label facets.

- unknown

## Other responses

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