Skip to main content

Getting Started

gfin is a hosted Google Finance API with stable public REST routes, Python and TypeScript SDKs, OpenAPI schemas, public rate limits, cache/coalescing, and source-free response metadata.

pip install gfin
from gfin import Client

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

print(client.search("apple")["data"])
print(client.quote_summary("AAPL", exchange="NASDAQ")["data"])
print(client.research("Why is AAPL moving today?")["data"])

What To Read First​

  • Quickstart for the shortest path from install to data.
  • Concepts for symbols, public response envelopes, cache behavior, quote views, research output, and missing data.
  • Guides for common workflows such as search, research, quotes, markets, news/events, realtime snapshots, and AI agents.
  • Python SDK for package installation and client examples.
  • TypeScript SDK for JavaScript and TypeScript apps.
  • REST API for direct hosted API requests.
  • API Reference for endpoint schemas and examples.
  • Errors and Rate Limits for production handling.

Public Endpoints​

  • Hosted API: https://api.gfin.dev
  • OpenAPI: https://api.gfin.dev/v1/openapi.json
  • Endpoint catalog: https://api.gfin.dev/v1/endpoints
  • Health: https://api.gfin.dev/v1/health
  • LLM index: https://docs.gfin.dev/llms.txt