---
title: "Suggest Symbol"
method: GET
path: "/api/suggest"
tags: ["database"]
---

# Suggest Symbol

`GET /api/suggest`

## Request

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

Auto-complete symbol suggestions for a search query.

Returns a ranked list of symbol suggestions that match the provided
query prefix, useful for type-ahead search interfaces.

**curl example**:
```bash
curl -X GET "http://localhost:8000/api/suggest?q=AAP"
```

**Python requests example**:
```python
import requests
resp = requests.get(
    "http://localhost:8000/api/suggest",
    params={"q": "AAP"},
)
suggestions = resp.json()
```

## Query parameters

- `q` string: Symbol prefix to search for, e.g. AAP.

## Response `200`

List of symbol suggestions matching the query

- SuggestionResponse[]
  - `symbol` string, required: Ticker symbol
  - `name` string, required: Company or asset name
  - `sector` string, required: Sector classification
  - `exchange` string, required: Exchange where the asset is listed
  - `type` string, required: Asset type, e.g. equities, etfs, funds

## 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)