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

​
Base URL

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

​
Authentication

All requests use Bearer token authentication. 
curl -s \
  -H "Authorization: Bearer <your_api_key>" \
  "https://data.apartmentiq.io/apartmentiq/api/v1/accounts/9901947/comp_sets"
See Authentication for details.

​
Get an API token

API tokens are available for accounts with API access enabled. If you don’t see the API Tokens section in your settings, contact your ApartmentIQ representative to enable API access for your account.
  1. In the web app, open your user menu (bottom-left avatar) and choose My Settings.
  2. Scroll to the API Tokens section.
  3. Select Create Token, then copy the token shown. For security reasons, you’ll only be able to see the token when it’s first generated.
  4. Store the token securely (for example, in an environment variable or secret manager) and use it as a Bearer token in requests.
curl -s \
  -H "Authorization: Bearer <your_api_token>" \
  "https://data.apartmentiq.io/apartmentiq/api/v1/accounts/<your_account_id>/comp_sets"
Never share your token publicly or commit it to version control.

​
What you can do

Market Survey

Analyze your comp set.

Market Analysis

Explore markets and properties.

​
Explore next

Key Terms

Learn core terms.

Authentication

Use a Bearer token.

Rate Limits

Understand request limits.

Errors

Understand error responses.