> ## Documentation Index
> Fetch the complete documentation index at: https://docs.capyfin.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Start building with the CapyFin API

Welcome to the **CapyFin API** documentation. CapyFin provides programmatic access to rich earnings report data, including financials, key takeaways, segment breakdowns, and forward guidance.

<Info>
  **Prerequisite**: You need an API Key to authenticate your requests. You can generate one in the [Developer
  Dashboard](https://capyfin.com/api/dashboard).
</Info>

## Authentication

All API requests must be authenticated using your API key. You can pass the key in one of two ways:

### 1. Header (Recommended)

Include the header `Authorization: Bearer YOUR_API_KEY` in your requests.

```bash theme={null}
curl "https://api.capyfin.com/v1/instruments/nasdaq/aapl" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### 2. Query Parameter

Append `?apikey=YOUR_API_KEY` to the URL.

```bash theme={null}
curl "https://api.capyfin.com/v1/instruments/nasdaq/aapl?apikey=YOUR_API_KEY"
```

## Base URL

All API requests should be made to the following base URL:

```bash theme={null}
https://api.capyfin.com
```

## Get Started

<CardGroup cols={2}>
  <Card title="Get your API Key" icon="key" href="https://capyfin.com/api/dashboard">
    Create an account and generate your API key to start making requests.
  </Card>

  <Card title="Explore the API" icon="code" href="/api-reference">
    Browse our endpoints to retrieve instruments, earnings reports, segments, and more.
  </Card>
</CardGroup>