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

# Quickstart

> First request in under a minute.

<Steps>
  <Step title="Create an API key">
    Sign in at [astreus.ai](https://astreus.ai) (the Free plan needs no
    card), open [astreus.ai/developers](https://astreus.ai/developers), and create a key. It is shown **once** — store
    it immediately.
  </Step>

  <Step title="Make a request">
    Send the key as `X-API-KEY` on every call:

    ```bash theme={null}
    curl "https://astreus.ai/api/v1/companies/NVDA" \
      -H "X-API-KEY: pk_live_YOUR_KEY"
    ```
  </Step>

  <Step title="Pull real data">
    Standardized quarterly financials — every statement, every line, up to 200 periods in one call:

    ```bash theme={null}
    curl "https://astreus.ai/api/v1/companies/NVDA/financials?period_type=quarterly" \
      -H "X-API-KEY: pk_live_YOUR_KEY"
    ```

    And the exact XBRL fact and filing behind one cell (the line key is `std:revenue`, the
    column is its period end):

    ```bash theme={null}
    curl "https://astreus.ai/api/v1/companies/NVDA/fact-source?statement=income_statement&key=std:revenue&end_date=2024-10-27&period_type=quarterly" \
      -H "X-API-KEY: pk_live_YOUR_KEY"
    ```
  </Step>
</Steps>

## Identifiers

`{id}` accepts three forms:

| Form            | Example                                  | Use it for                                                                                                                                           |
| --------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| Ticker symbol   | `NVDA`                                   | US (SEC) issuers. A bare ticker always resolves to the SEC registrant, so `LULU` is lululemon, not Lulu Retail on ADX.                               |
| Numeric SEC CIK | `1045810`                                | The stable choice for a US issuer that has changed symbols. Zero-padding is optional.                                                                |
| Platform key    | `XSAU000001`, `XDFM000002`, `XJPX000018` | Every non-SEC issuer — Tadawul, DFM, ADX, Boursa Kuwait, QSE, TSE, TWSE, KRX, European exchanges. The key is the `cik` field of the company payload. |

Resolve names with `GET /api/v1/search?q=almarai`, or browse a market with
`GET /api/v1/companies?country=SA`. Details and the full market list are on the
[Coverage](/coverage) page.

## Watch the headers

Every response tells you where you stand:

| Header                                                        | Meaning                                              |
| ------------------------------------------------------------- | ---------------------------------------------------- |
| `RateLimit-Limit` / `RateLimit-Remaining` / `RateLimit-Reset` | Per-minute window                                    |
| `X-Quota-Limit` / `X-Quota-Remaining` / `X-Quota-Reset`       | Monthly quota (quota-carrying plans)                 |
| `X-Billing-Source` / `X-Credits-Remaining-USD`                | Present when a request was paid from prepaid credits |
| `Retry-After`                                                 | On a 429 — wait this many seconds                    |

## Where next

* [Financial statements](/financial-statements) — the payload shape, period columns, bases and vintages.
* [Data catalog](/data-catalog) — every dataset with its endpoint, `astreus` command and MCP tool.
* [Guide: trace a number to its filing](/guides/trace-a-number) — the citation loop, end to end.