Getting Started - ApartmentIQ API

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

https://data.apartmentiq.io/apartmentiq/api/v1

All requests use Bearer token authentication. See Authentication for full details.

curl -s \
  -H "Authorization: Bearer <access_token>" \
  "https://data.apartmentiq.io/apartmentiq/api/v1/accounts/<your_account_id>/comp_sets"

API access must be enabled for your account. If you don’t see the API Credentials section in your settings, contact your ApartmentIQ representative.

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

In the web app, open your user menu (bottom-left avatar) and choose My Settings.
In the API Credentials section, click Create API Key and give it a name.
Copy the Client ID and Client Secret (the secret is only shown once).
Your app exchanges these credentials for short-lived access tokens via the token endpoint.

For quick testing, you can also create a manual access token from the Access Tokens tab. See Authentication for both options.

Never share credentials publicly or commit them to version control.

Market Survey

Analyze your comp set.

Explore markets and properties.

Learn core terms.

Set up API authentication.

Understand request limits.

Understand error responses.

⌘I