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

# Getting Started

> Base URL, auth, and key resources.

Welcome to the ApartmentIQ API. These docs help you authenticate, explore resources, and implement common workflows.

### Base URL

```txt theme={null}
https://data.apartmentiq.io/apartmentiq/api/v2
```

### Authentication

All requests use Bearer token authentication. See [Authentication](/v2/authentication) for full details.

```bash theme={null}
curl -s \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{"account_id": {account_id}, "interval": "month"}' \
  "https://data.apartmentiq.io/apartmentiq/api/v2/markets/bulk"
```

### Set up authentication

<Tip>
  API access must be enabled for your account. If you don't see the API Credentials section in your settings, contact your ApartmentIQ representative.
</Tip>

The recommended approach is to create an **API Key**, which manages token lifecycle automatically.

1. In the [web app](https://app.apartmentiq.io), open your user menu (bottom-left avatar) and choose **My Settings**.
2. In the **API Credentials** section, click **Create API Key** and give it a name.
3. Copy the **Client ID** and **Client Secret** (the secret is only shown once).
4. Your app exchanges these credentials for short-lived access tokens via the [token endpoint](/v2/authentication).

For quick testing, you can also create a manual access token from the **Access Tokens** tab. See [Authentication](/v2/authentication) for both options.

<Warning>Never share credentials publicly or commit them to version control.</Warning>

## Explore next

<CardGroup cols={2}>
  <Card title="Key Terms" icon="book" href="/v2/key-terms">
    Learn core terms.
  </Card>

  <Card title="Authentication" icon="shield" href="/v2/authentication">
    Set up API authentication.
  </Card>

  <Card title="Rate Limits" icon="gauge" href="/v2/rate-limits">
    Understand request limits.
  </Card>

  <Card title="Errors" icon="cloud-alert" href="/v2/errors">
    Understand error responses.
  </Card>
</CardGroup>