database

Suggest Symbol

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:

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

Python requests example:

import requests
resp = requests.get(
    "http://localhost:8000/api/suggest",
    params={"q": "AAP"},
)
suggestions = resp.json()
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

Query parameters

qstring

Symbol prefix to search for, e.g. AAP.

Response

List of symbol suggestions matching the query

symbolstring required

Ticker symbol

namestring required

Company or asset name

sectorstring required

Sector classification

exchangestring required

Exchange where the asset is listed

typestring required

Asset type, e.g. equities, etfs, funds

Example response

[
  {
    "exchange": "NMS",
    "name": "Apple Inc.",
    "sector": "Technology",
    "symbol": "AAPL",
    "type": "equities"
  }
]

Changes

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