# ApartmentIQ API ## Docs - [List Accounts](https://developers.apartmentiq.io/api-reference/accounts/list-accounts.md): Retrieves a paginated list of ApartmentIQ accounts the authenticated user has access to. Each account object includes its ID and display name. - [Cancel Batch Job](https://developers.apartmentiq.io/api-reference/bulk-data-export/cancel-batch-job.md): Cancel a running or submitted batch job. Once cancelled, the job cannot be resumed and no results will be available for download. - [Create Batch Job](https://developers.apartmentiq.io/api-reference/bulk-data-export/create-batch-job.md): Submit a new batch job request to retrieve historical property data. The job will process asynchronously and return results in the specified format (CSV, JSONL, or Parquet). Use the job_id from the response to check job status and download results when complete. - [Download Batch Job Results](https://developers.apartmentiq.io/api-reference/bulk-data-export/download-batch-job-results.md): Download the results of a completed batch job. Returns a 302 redirect to a pre-signed S3 URL where the file can be downloaded. The pre-signed URL is valid for 7 days. Jobs must have a status of 'succeeded' to download results. - [Get Batch Job Status](https://developers.apartmentiq.io/api-reference/bulk-data-export/get-batch-job-status.md): Retrieve the current status and details of a batch job. Use this endpoint to monitor job progress and check for completion or errors. - [List Batch Jobs](https://developers.apartmentiq.io/api-reference/bulk-data-export/list-batch-jobs.md): Retrieve a paginated list of all batch jobs for the authenticated user. Results are ordered by creation date (newest first) and include job status, configuration, and metadata. - [Geo Boundary Forecasts](https://developers.apartmentiq.io/api-reference/forecasts/geo-boundary-forecasts.md): Retrieve modeled future time-series forecast data for a geographic boundary. Returns aggregated forecast metrics at configurable time intervals. - [Property Forecasts](https://developers.apartmentiq.io/api-reference/forecasts/property-forecasts.md): Retrieve modeled future time-series forecast data for a specific property. Returns aggregated forecast metrics at configurable time intervals. - [Get Market Survey Data](https://developers.apartmentiq.io/api-reference/market-surveys/get-market-survey-data.md): Retrieves the [market survey](#response-data-attributes-market-survey-items) data for a comp set. - [List Competitive Sets](https://developers.apartmentiq.io/api-reference/market-surveys/list-competitive-sets.md): Retrieves a list of [comp sets](#response-attributes-name) the current user has access to within the given account. - [List Floorplans](https://developers.apartmentiq.io/api-reference/market-surveys/list-floorplans.md): Retrieves a list of [floorplans](#response-data-attributes-floor-plans-by-bed-bath) for a comp set. - [List Units In Competitive Set](https://developers.apartmentiq.io/api-reference/market-surveys/list-units-in-competitive-set.md): Retrieves the list of [units](#response-data-attributes) in a Competitive Set. - [Bulk Property Details](https://developers.apartmentiq.io/api-reference/markets/bulk-property-details.md): Retrieve full property details and aggregated metrics for multiple properties by ID. Returns comprehensive data including physical characteristics, rent metrics, availability, and ownership information (with appropriate data access). - [Compare Markets](https://developers.apartmentiq.io/api-reference/markets/compare-markets.md): Retrieve aggregated market-level metrics for geographic areas such as MSAs and Submarkets. This endpoint returns comprehensive market data including rent averages, occupancy rates, inventory counts, population demographics, and sales transaction data. Use market-level filters to narrow results by ge… - [Get Market Narrative](https://developers.apartmentiq.io/api-reference/markets/get-market-narrative.md): Retrieve a market narrative for a geographic boundary. Returns a structured analysis covering market overview, rent performance, occupancy and demand, construction pipeline, sales transactions, and demographics. - [Property Lookup](https://developers.apartmentiq.io/api-reference/markets/property-lookup.md): Search for properties and return paginated property IDs based on location, coordinates, or property attributes. Use this endpoint to discover properties matching your criteria, then retrieve full details using the Bulk Property Details endpoint. - [Search Geo Boundaries](https://developers.apartmentiq.io/api-reference/markets/search-geo-boundaries.md): Searches for geo boundaries by name and type. Returns matching geographic areas including MSAs, Submarkets, Census Places (Cities, Towns, etc.), Counties, Zip Codes, and Neighborhoods. Result order is weighted by property count and geo type relevance. - [Search Properties](https://developers.apartmentiq.io/api-reference/markets/search-properties.md): Retrieve bulk property data filtered by geographic boundaries (MSAs, Submarkets, Cities, Counties, Zip Codes, or Neighborhoods) or custom GeoJSON geometries. Returns detailed property data including physical characteristics, rent metrics, availability, and ownership information (with appropriate dat… - [Changelog](https://developers.apartmentiq.io/changelog/v1.md): Product updates and release notes for the ApartmentIQ API V1. - [Authentication](https://developers.apartmentiq.io/v1/authentication.md): Authenticate with the ApartmentIQ API using OAuth client credentials or a Bearer token. - [Errors](https://developers.apartmentiq.io/v1/errors.md): Error format and common status codes. - [Getting Started](https://developers.apartmentiq.io/v1/getting-started.md): Base URL, auth, and key resources. - [Introduction](https://developers.apartmentiq.io/v1/index.md) - [Key Terms](https://developers.apartmentiq.io/v1/key-terms.md): Definitions used throughout the ApartmentIQ API. - [Rate Limits](https://developers.apartmentiq.io/v1/rate-limits.md): Rate limit response headers and retry guidance. - [Bulk Data Export](https://developers.apartmentiq.io/v1/use-cases/bulk-data-export.md): Request and download historical property data at scale using batch jobs. - [Compare Markets](https://developers.apartmentiq.io/v1/use-cases/compare-markets.md): Compare aggregated metrics across MSAs and submarkets. - [Data Sync](https://developers.apartmentiq.io/v1/use-cases/data-sync.md): Daily direct data delivery via no-code BI connectors, data lake destinations, SFTP, or secure download — authenticated with a dedicated Data Sync key (not a Bearer token). - [Market Analysis](https://developers.apartmentiq.io/v1/use-cases/market-analysis.md): Explore markets and retrieve bulk property data. - [Market Survey](https://developers.apartmentiq.io/v1/use-cases/market-survey.md): Analyze comp sets with survey tables, units, and floorplans. ## OpenAPI Specs - [schema](https://developers.apartmentiq.io/openapi/v2/schema.json) - [openapi](https://developers.apartmentiq.io/api-reference/openapi.json)