> ## 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.
# Bulk Property Details
> 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).
Requires Explore Pro access. Ownership and sales transaction fields require Explore Pro+ access.
This endpoint is subject to bulk export quota limits. Each successful request counts returned unique properties toward your account quota.
## OpenAPI
````yaml /openapi/v1/schema.json get /properties/bulk_details
openapi: 3.0.3
info:
title: ApartmentIQ API
version: 1.14.0
termsOfService: https://www.getapartmentiq.com/terms
x-logo:
url: https://developers.apartmentiq.io/logo.svg
altText: ApartmentIQ
description: >-
ApartmentIQ API providing Accounts, Market Surveys, Markets, Market
Narratives, and Forecasts endpoints to access accounts, comp sets, market
survey tables, units, floorplans, and market-based property data. See
documentation pages for authentication, errors, and rate limits.
servers:
- url: https://data.apartmentiq.io/apartmentiq/api/v1
security:
- oauth2: []
tags:
- name: Accounts
description: >-
Endpoints for listing the ApartmentIQ accounts accessible to the
authenticated user.
- name: Market Surveys
description: >-
Market Survey endpoints can be used to access data related to your market
surveys within ApartmentIQ. The ApartmentIQ API refers to the list of
properties within your market surveys as a comp set, or competitive set.
In the rest of this document, comp set and competitive set will be used
interchangeably.
- name: Markets
description: Endpoints used to access market data.
- name: Bulk Data Export
description: >-
Endpoints for requesting and downloading historical property data through
asynchronous batch jobs. Submit a job request, monitor its status, and
download results when ready.
- name: Forecasts
description: >-
Endpoints for retrieving modeled future time-series forecast data for
geographic boundaries and properties. Forecast data spans from the
beginning of the current month up to 5 years in the future. Requires
Explore Pro access.
paths:
/properties/bulk_details:
get:
tags:
- Markets
summary: Bulk Property Details
description: >-
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).
Requires Explore Pro access. Ownership and sales transaction
fields require Explore Pro+ access.
This endpoint is subject to bulk export quota limits. Each
successful request counts returned unique properties toward your account
quota.
operationId: getBulkPropertyDetails
parameters:
- name: account_id
in: query
description: ID of the account (required for authorization).
required: true
schema:
type: integer
example: 2222
- name: property_ids
in: query
description: >-
Comma-separated list of property IDs, or use array notation with
multiple property_ids[] parameters.
required: true
schema:
type: string
example: 99001416,99001470
responses:
'200':
description: Property details retrieved successfully
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: array
items:
type: object
required:
- id
- type
- attributes
properties:
id:
type: string
description: Property ID.
type:
type: string
enum:
- properties
description: Resource type.
attributes:
type: object
description: >-
Detailed property attributes including location,
physical characteristics, rent metrics,
availability, and ownership data. See the Search
Properties endpoint for the full attributes schema.
description: Array of property objects with full details.
'400':
description: The request was invalid or malformed.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Missing Property IDs:
value:
error: property_ids is required and must be a non-empty array
'401':
description: Unauthorized - Invalid or missing authentication
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: >-
Forbidden - Explore Pro access, required account permission, or bulk
export quota is missing
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Bulk Export Quota Exceeded:
value:
error: Bulk export quota () exceeded
'429':
$ref: '#/components/responses/RateLimitExceeded'
components:
schemas:
Error:
type: object
description: >-
Error response payload. Most errors include error and optional message;
some validation responses include errors; quota responses include quota
fields.
properties:
error:
type: string
description: Short error message
example: Invalid parameter
message:
type: string
description: Optional detailed message
example: account_id is required
errors:
type: array
description: Optional list of validation errors.
items:
type: string
quota_limit:
type: integer
description: >-
Quota limit that applied to the request when an account quota was
exceeded.
quota_usage:
type: integer
description: Current quota usage when an account quota was exceeded.
responses:
RateLimitExceeded:
description: >-
Rate limit exceeded. Inspect the rate limit headers and wait before
retrying.
headers:
X-RateLimit-Limit:
description: The limit that applied to the request.
schema:
type: string
X-RateLimit-Reset-After:
description: The rate limit window length, in seconds.
schema:
type: string
X-RateLimit-Reset:
description: Unix timestamp when the current window resets.
schema:
type: string
Retry-After:
description: Seconds to wait before retrying the request.
schema:
type: string
content:
text/plain:
schema:
type: string
example: |
You have exceeded the rate limit for this API.
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: Trial API quota limit exceeded
quota_limit: 5000
quota_usage: 5001
securitySchemes:
oauth2:
type: oauth2
description: >-
Enter a Bearer token obtained via the OAuth client credentials flow or
from the Access Tokens tab in your account settings.
flows:
clientCredentials:
tokenUrl: https://data.apartmentiq.io/oauth/token
scopes: {}
````