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

# Support

> How to get help with the Financial Data API and request an API key.

Need a key, found something wrong, or want to talk to a human? Keys are self-serve; everything else reaches the team below.

## Get an API key

Keys are self-serve. Sign up, verify your email, and your key is active immediately. No card is required, and the Free plan covers the full dataset with a trailing 24 month history window and 2,500 calls a month.

<Card title="Create your account" icon="key" href="https://app.financialdatapi.com">
  app.financialdatapi.com
</Card>

You can create, rotate and revoke keys from the same dashboard, and upgrade a plan there when you need the full published history or higher limits.

<Note>
  Keys are hashed server-side and are never returned after issue. Store yours securely when you create it. If it is lost or exposed, rotate it from the dashboard.
</Note>

## Get help with the API

For bugs, unexpected responses, or questions about behavior, email the same address. Before you write, the reference and the spec answer most questions.

<Columns cols={2}>
  <Card title="API reference" icon="square-terminal" href="/api-reference/introduction">
    Endpoints, parameters, scopes, and the response envelope.
  </Card>

  <Card title="OpenAPI spec" icon="file-code" href="/api-reference/openapi.json">
    The machine-readable contract. If it is not in the spec, it is not part of the public surface.
  </Card>
</Columns>

### Always include the request\_id

Every Financial Data API response carries a `request_id` (mirrored as the top-level `requestId`, and inside `error` on failures). It identifies the exact request and lets us trace it server-side, so it is the single most useful thing to send.

<CodeGroup>
  ```bash Read it from a header dump theme={"theme":"css-variables"}
  curl -i https://api.financialdatapi.com/observations/latest \
    -H "x-api-key: $FINANCIALDATA_API_KEY"
  # The request_id is in the JSON body, under meta.request_id (and top-level requestId).
  ```

  ```python Print it from a response theme={"theme":"css-variables"}
  import requests

  r = requests.get(
      "https://api.financialdatapi.com/observations/latest",
      params={"country": "USA", "indicator": "cpi_inflation_yoy"},
      headers={"x-api-key": "<your-key>"},
  )
  body = r.json()
  print("status:", r.status_code)
  print("request_id:", body.get("requestId"))
  ```

  ```typescript Surface it from the SDK theme={"theme":"css-variables"}
  import { FinancialDataApiClient } from "@financialdatapi/client";

  const client = new FinancialDataApiClient({ apiKey: process.env.FINANCIALDATA_API_KEY });

  try {
    const res = await client.getLatestObservations({
      country: "USA",
      indicator: "cpi_inflation_yoy",
    });
    console.log("request_id:", res.meta.request_id);
  } catch (err) {
    // Financial Data API errors carry the request_id under error.request_id.
    console.error(err);
  }
  ```
</CodeGroup>

When you report an issue, include:

* The **`request_id`** from the affected response.
* The **full request URL** (method, path, and query parameters).
* The **HTTP status** and the **`error.code`** if the call failed.
* A short note on what you expected versus what you got.

<Tip>
  You do not need to paste your API key, and you should not. The `request_id` is enough for us to find the request.
</Tip>

## Response times

We aim to acknowledge access requests and support email within one business day.

## Status

For live service health, check the unauthenticated health endpoints. `GET /health` reports liveness and `GET /ready` reports readiness; neither requires a key.

<Card title="Service health" icon="heart-pulse" href="https://api.financialdatapi.com/health">
  [https://api.financialdatapi.com/health](https://api.financialdatapi.com/health)
</Card>