Search

Use search when users enter company names, ticker-like text, or entity names.

curl "https://api.gfin.dev/v1/search?q=apple" \
  -H "X-Gfin-Contact: you@example.com"

results = client.search("apple")

const results = await client.search("apple");

Recommended Flow

1. Send the user's text to /v1/search.
2. Show the returned labels, symbols, exchanges, or entity hints.
3. Use the selected symbol and exchange for quote routes.
4. Store gfin public route names and your own normalized fields, not source internals.

Parameters

Parameter	Required	Description
q	Yes	Search text.
query	No	Alias for q.
term	No	Alias for q.
refresh	No	Set to 1 to bypass cache.