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

# Quickstart

> Get a free key and make your first AlphaYou API call in about 5 minutes.

You will get a key, check what your plan can read, and pull a company's latest SEC filings with their links.

**1. Get a free key**

Open [alphayou.net/developers](https://alphayou.net/developers), log in or sign up, and press **Get a free key**. No card is needed.

Your key starts with `ay_`. Keep it secret. Store it in an environment variable, not in code other people can read:

```bash theme={null}
export ALPHAYOU_API_KEY="ay_your_key"
```

**2. See what your plan can read (costs 0)**

The dataset catalog lists every dataset, its address, its plan and what a call costs. Calling it uses none of your daily allowance.

```bash theme={null}
curl -H "x-api-key: $ALPHAYOU_API_KEY" \
  "https://api.alphayou.net/api/v1/datasets"
```

You see 9 datasets. Free keys can call the ones marked `free`. The rest say `pro`.

**3. Make your first real call (costs 1)**

Ask for NVIDIA's most recent 8-K filings. An 8-K is the notice a US-listed company files when something material happens.

```bash curl theme={null}
curl -H "x-api-key: $ALPHAYOU_API_KEY" \
  "https://api.alphayou.net/api/v1/tickers/NVDA/disclosures?days=90&limit=2"
```

```python Python theme={null}
import os
import requests

response = requests.get(
    "https://api.alphayou.net/api/v1/tickers/NVDA/disclosures",
    params={"days": 90, "limit": 2},
    headers={"x-api-key": os.environ["ALPHAYOU_API_KEY"]},
    timeout=20,
)
response.raise_for_status()
for filing in response.json()["disclosures"]:
    print(filing["filedAt"], filing["sourceUrl"])
```

```javascript JavaScript theme={null}
const response = await fetch(
  "https://api.alphayou.net/api/v1/tickers/NVDA/disclosures?days=90&limit=2",
  { headers: { "x-api-key": process.env.ALPHAYOU_API_KEY } },
);
if (!response.ok) throw new Error(`AlphaYou API ${response.status}`);
const data = await response.json();
for (const filing of data.disclosures) {
  console.log(filing.filedAt, filing.sourceUrl);
}
```

**4. Read the answer**

Here is a trimmed example of what comes back:

```json theme={null}
{
  "asOf": "2026-11-05T07:20:59.480Z",
  "source": "SEC EDGAR (Form 8-K and 8-K/A filings)",
  "ticker": "NVDA",
  "company": { "cik": 1045810, "name": "NVIDIA CORP" },
  "status": "available",
  "windowDays": 90,
  "count": 2,
  "totalInWindow": 3,
  "disclosures": [
    {
      "form": "8-K",
      "items": [{ "item": "8.01", "title": "Other Events" }],
      "filedAt": "2026-09-03",
      "sourceUrl": "https://www.sec.gov/Archives/edgar/data/1045810/000104581026000078/nvda-20260902.htm"
    }
  ]
}
```

* `filedAt` is the day the company filed it with the SEC.
* `sourceUrl` is the original filing. Keep it next to every fact you show.
* `totalInWindow` tells you how many filings exist in the window, even if `limit` cut the list short.

The example is shortened and the dates are from the day it was captured. Your response has more fields. The full set is on [Conventions](https://docs.mirrortrade.co/api/conventions.md).

**5. Check what is left today**

Every response carries headers that show the cost of the call and what remains of your daily allowance:

```bash theme={null}
curl -i -H "x-api-key: $ALPHAYOU_API_KEY" \
  "https://api.alphayou.net/api/v1/funds?limit=1"
```

Look for `X-RateLimit-Cost` and `X-RateLimit-Remaining`. The meaning of each limit is on [Plans and limits](https://docs.mirrortrade.co/api/plans-and-limits.md).

## If something goes wrong

* `401` means the key is missing or not recognised. See [Keys and authentication](https://docs.mirrortrade.co/api/authentication.md).
* `403` means the dataset needs Pro. See [Errors](https://docs.mirrortrade.co/api/errors.md).
* `429` means you went too fast. Wait the number of seconds in the `Retry-After` header and try again.

## Next steps

* Browse every endpoint in the **Endpoint reference** group in the sidebar.
* Read [Conventions](https://docs.mirrortrade.co/api/conventions.md) before you store or show any data.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.