Skip to main content

Quickstart

Install the Python package:

pip install gfin

Or install the TypeScript package:

npm install @gfin/sdk

Fetch search results, quote data, news, and research from Python:

from gfin import Client

client = Client(contact="you@example.com")

print(client.search("apple"))
print(client.quote_summary("AAPL", exchange="NASDAQ"))
print(client.news(limit=5))
print(client.research("What are Apple's latest earnings highlights?"))

Or call the REST API directly:

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

curl "https://api.gfin.dev/v1/quote/AAPL/summary?exchange=NASDAQ" \
  -H "X-Gfin-Contact: you@example.com"

curl "https://api.gfin.dev/v1/research?q=Why%20is%20AAPL%20moving%20today%3F" \
  -H "X-Gfin-Contact: you@example.com"

Identity​

Anonymous calls work out of the box with IP-based limits. For higher public limits, declare a contact identity:

from gfin import Client

client = Client(contact="you@example.com")

High-volume callers can use manually configured API keys and send them as a Bearer token:

curl "https://api.gfin.dev/v1/markets/summary" \
  -H "Authorization: Bearer gfin_..."

Next Steps​