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

# Quickstart

> Create an account, create an API key, and make your first request.

## 1. Create an account

Create a Prontiq account from the product site, then open the console. The
console is where you manage API keys, usage, and billing.

<Card title="Open Prontiq" icon="arrow-up-right-from-square" href="https://prontiq.dev">
  Create your account, then continue in the console.
</Card>

## 2. Create an API key

In the console, open **API keys** and create a key for your organization. Copy
the raw key when it is revealed; Prontiq only shows it once.

Store the key in an environment variable:

```bash theme={null}
export PRONTIQ_API_KEY="YOUR_API_KEY"
```

<Warning>
  API keys are server-side secrets. Do not put them in browser code, mobile
  apps, screenshots, docs, or source control.
</Warning>

## 3. Make your first call

<CodeGroup>
  ```bash curl theme={null}
  curl -i "https://api.prontiq.dev/v1/address/autocomplete?q=9+endeavour+cou" \
    -H "X-Api-Key: $PRONTIQ_API_KEY"
  ```

  ```typescript Node.js (server-side) theme={null}
  const response = await fetch(
    "https://api.prontiq.dev/v1/address/autocomplete?q=9+endeavour+cou",
    {
      headers: { "X-Api-Key": process.env.PRONTIQ_API_KEY ?? "" },
    },
  );

  const data = await response.json();
  console.log(data.suggestions[0].addressLabel);
  ```

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

  response = requests.get(
      "https://api.prontiq.dev/v1/address/autocomplete",
      params={"q": "9 endeavour cou"},
      headers={"X-Api-Key": os.environ["PRONTIQ_API_KEY"]},
  )

  data = response.json()
  print(data["suggestions"][0]["addressLabel"])
  ```
</CodeGroup>

## 4. Confirm the response

Successful responses include a request id and request-time usage headers. Header
values are based on the current account state and may vary by plan, product, and
billing period.

```http theme={null}
HTTP/2 200
X-Request-Id: req_018f4d8c-...
X-RateLimit-Product: address
X-RateLimit-Reset: <period reset timestamp>
X-RateLimit-Limit: <current limit when applicable>
X-RateLimit-Remaining: <remaining credits when applicable>
```

```json theme={null}
{
  "suggestions": [
    {
      "id": "GAQLD156786950",
      "addressLabel": "9 ENDEAVOUR COURT",
      "localityName": "LAMMERMOOR",
      "state": "QLD",
      "postcode": "4703",
      "prontiqMatchScore": 92,
      "prontiqMatchQuality": "high"
    }
  ],
  "total": 1
}
```

## 5. What's next?

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/guides/authentication">
    Learn how API keys work and how to handle auth failures.
  </Card>

  <Card title="Error handling" icon="triangle-exclamation" href="/guides/error-handling">
    Handle 4xx and 5xx responses with request-id tracing.
  </Card>

  <Card title="Rate limits" icon="gauge-high" href="/guides/rate-limits">
    Understand request-time headers, quota outcomes, and retries.
  </Card>

  <Card title="Autocomplete" icon="magnifying-glass" href="/guides/address/autocomplete">
    Build real-time typeahead with the Address API.
  </Card>
</CardGroup>
