Skip to main content

REST API

Use the REST API when you want gfin from curl, a backend service, a serverless function, a browser runtime, or an AI tool.

Base URL

https://api.gfin.dev

OpenAPI

https://api.gfin.dev/v1/openapi.json

Use the API Reference for an interactive endpoint browser.

Identity

Anonymous calls work without signup. For higher public limits, send a contact identity:

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

Manual API keys can be sent as Bearer tokens:

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

Response Envelope

Most successful responses include data and meta:

{
"data": {},
"meta": {
"route": "search",
"contract": "gfin.search.v1",
"generated_at": "2026-05-05T18:05:21.407Z"
}
}

Error responses include an error object. See Errors for status codes, retry behavior, and SDK exceptions.

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

Research

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

Quotes

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

Markets And News

curl "https://api.gfin.dev/v1/markets/summary" \
-H "X-Gfin-Contact: you@example.com"

curl "https://api.gfin.dev/v1/news?limit=5" \
-H "X-Gfin-Contact: you@example.com"

Public Route Catalog

curl "https://api.gfin.dev/v1/endpoints"

The catalog returns public route names, public paths, public contract IDs, and identity policy. It does not expose raw transport or source-debug surfaces.