> Finks API docs. Every page: https://finks.ai/llms.txt. The OpenAPI spec: https://finks.ai/docs/openapi.json.

# Quickstart

Go from a new key to your first result.

## Get a key

[Create a free account](https://dashboard.finks.ai/signin). It comes with a key, and the console's Search and Screener run as it right away. For your own code, create or roll a key on [API keys](https://dashboard.finks.ai/keys): its secret is shown once. Every request your keys make draws from your account's credits.

Every sample reads the key from `FINKS_API_KEY`:

Terminal:

```bash
export FINKS_API_KEY="fk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
```

## Search

One request searches news, filings and earnings calls, best match first.

```bash
curl -sS "https://data.finks.ai/v1/search" \
  -H "Authorization: Bearer $FINKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "Nvidia short interest, holders and insider selling",
  "limit": 10,
  "symbols": [
    "NVDA"
  ]
}'
# Next page: the same body plus "cursor": <next_cursor>, while "has_more" is true.
```

Example response (Illustrative):

```json
{
  "results": [
    {
      "id": "sample-brief-id",
      "type": "brief",
      "title": "Sample brief about Nvidia insider selling",
      "summary": "Sample text. A real brief carries a Finks-written summary here.",
      "url": "https://example.com/sample-brief",
      "publishers": ["newswire.example", "markets.example"],
      "symbols": ["NVDA"],
      "published_at": "2026-10-21T14:05:00Z"
    },
    {
      "id": "sample-filing-id",
      "type": "filing",
      "title": "Sample 8-K current report",
      "summary": "Sample text. A real filing carries a summary of the event it reports.",
      "url": "https://example.com/sample-filing",
      "symbols": ["NVDA"],
      "published_at": "2026-10-20T21:30:00Z",
      "citation_id": "sample-citation-id",
      "excerpt": "Sample text, quoted word for word from the filing."
    }
  ],
  "has_more": true,
  "next_cursor": "sample-cursor",
  "ranking": "retrieval",
  "datasets": [
    { "name": "brief", "state": "searched" },
    { "name": "article", "state": "searched" },
    { "name": "filing", "state": "searched" },
    { "name": "transcript", "state": "searched" },
    { "name": "sec_forms", "state": "searched" }
  ],
  "data": [
    {
      "dataset": "sec_forms",
      "entity": "NVDA",
      "href": "/v1/companies/NVDA/events",
      "as_of": "2026-10-20",
      "results": [
        {
          "id": "sample-filing-id",
          "type": "filing",
          "title": "Sample 8-K current report",
          "url": "https://example.com/sample-filing",
          "published_at": "2026-10-20T21:30:00Z"
        }
      ]
    }
  ]
}
```

What comes back:

- `results`: each with an `id`, `type` and `title`, and usually a `summary`, `url` and `symbols`.
- `has_more` and `next_cursor`: for the next page.
- `data`: company, fund and macro data for what the query names.

## Read the whole record

Open a result's full record with its `id`:

Terminal:

```bash
export RESULT_ID="<an id from your search>"
```

```bash
curl -sS "https://data.finks.ai/v1/content/$RESULT_ID" \
  -H "Authorization: Bearer $FINKS_API_KEY"
```

## Next

- [Connect your agent over MCP](https://finks.ai/docs/mcp.md).
- [Search reference](https://finks.ai/docs/reference/search.md): every filter.
- [Screener](https://finks.ai/docs/reference/screener.md): screen and rank companies.
- [Errors](https://finks.ai/docs/errors.md): what each code means.