Download Dataset

curl --request POST \
  --url https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "{account_id}",
  "dataset": "properties",
  "file_type": "parquet"
}
'

import requests

url = "https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download"

payload = {
    "account_id": "{account_id}",
    "dataset": "properties",
    "file_type": "parquet"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_id: '{account_id}', dataset: 'properties', file_type: 'parquet'})
};

fetch('https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => '{account_id}',
    'dataset' => 'properties',
    'file_type' => 'parquet'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download"

	payload := strings.NewReader("{\n  \"account_id\": \"{account_id}\",\n  \"dataset\": \"properties\",\n  \"file_type\": \"parquet\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"{account_id}\",\n  \"dataset\": \"properties\",\n  \"file_type\": \"parquet\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"{account_id}\",\n  \"dataset\": \"properties\",\n  \"file_type\": \"parquet\"\n}"

response = http.request(request)
puts response.read_body

{
  "dataset": "properties",
  "file_type": "parquet",
  "dataset_date": "2026-07-21",
  "download_url": "https://secure-downloads.example.com/properties-2026-07-21.parquet?signature=..."
}

Datasets

Download Dataset

Request a complete ApartmentIQ dataset snapshot in Parquet or CSV format.

This API is not available to all customers. Please reach out to your account representative if you would like to learn more.

How downloads work

By default, the endpoint returns JSON containing the selected dataset, file type, snapshot date, and a private, pre-signed download URL that expires after five minutes. Set redirect_to_download to true to receive a 303 See Other redirect to the download URL instead.

If you omit date, the endpoint returns the newest available dataset.

Datasets refresh in the early morning, EST. Exact refresh timing can vary. Properties, Organizations, and Organization Properties datasets refresh daily, and the Contacts dataset refreshes monthly on the 5th day of the month.

Properties dataset

One row per property visible in ApartmentIQ Explore, using the requested snapshot date.

Field	Parquet type	Meaning
`property_name`	string	Property display name.
`market_name`	string	ApartmentIQ market name.
`submarket_name`	string	ApartmentIQ submarket name.
`property_id`	int64	ApartmentIQ property ID.
`address`	string	Street address.
`city`	string	City.
`state`	string	State abbreviation.
`zip_code`	string	Postal code.
`latitude`	double	Latitude rounded to six decimal places.
`longitude`	double	Longitude rounded to six decimal places.
`unified_status`	string	Current ApartmentIQ property status.
`unit_count`	int64	Known number of units.
`number_of_stories`	int64	Known number of stories.
`year_built`	int64	Year built.
`year_renovated`	int64	Year most recently renovated.
`property_class`	string	ApartmentIQ property class.
`property_type`	string	ApartmentIQ property type.
`property_website`	string	Property website URL.
`on_revenue_management_tool`	boolean	Whether ApartmentIQ identifies the property as using a revenue management tool.
`management_company_names`	string	Current management company names, encoded as a pipe-delimited scalar list.
`management_change_date`	string	Most recent management change date in YYYY-MM-DD format, or an empty string.
`previous_management_company_names`	string	Management company names before the most recent change, encoded as a pipe-delimited scalar list.
`ownership_company_names`	string	Current ownership company names, encoded as a pipe-delimited scalar list.
`ownership_change_date`	string	Most recent ownership change date in YYYY-MM-DD format, or an empty string.
`previous_ownership_company_names`	string	Ownership company names before the most recent change, encoded as a pipe-delimited scalar list.
`rent`	double	Average asking rent over the trailing 30 days.
`rent_0_bed`	double	Average studio asking rent over the trailing 30 days.
`rent_1_bed`	double	Average one-bedroom asking rent over the trailing 30 days.
`rent_2_bed`	double	Average two-bedroom asking rent over the trailing 30 days.
`rent_3_bed`	double	Average three-bedroom asking rent over the trailing 30 days.
`ner`	double	Average net effective rent after concessions over the trailing 30 days.
`ner_0_bed`	double	Average studio net effective rent over the trailing 30 days.
`ner_1_bed`	double	Average one-bedroom net effective rent over the trailing 30 days.
`ner_2_bed`	double	Average two-bedroom net effective rent over the trailing 30 days.
`ner_3_bed`	double	Average three-bedroom net effective rent over the trailing 30 days.
`rent_psf`	double	Average asking rent per square foot over the trailing 30 days.
`rent_0_bed_psf`	double	Average studio asking rent per square foot over the trailing 30 days.
`rent_1_bed_psf`	double	Average one-bedroom asking rent per square foot over the trailing 30 days.
`rent_2_bed_psf`	double	Average two-bedroom asking rent per square foot over the trailing 30 days.
`rent_3_bed_psf`	double	Average three-bedroom asking rent per square foot over the trailing 30 days.
`ner_psf`	double	Average net effective rent per square foot over the trailing 30 days.
`ner_0_bed_psf`	double	Average studio net effective rent per square foot over the trailing 30 days.
`ner_1_bed_psf`	double	Average one-bedroom net effective rent per square foot over the trailing 30 days.
`ner_2_bed_psf`	double	Average two-bedroom net effective rent per square foot over the trailing 30 days.
`ner_3_bed_psf`	double	Average three-bedroom net effective rent per square foot over the trailing 30 days.
`rent_growth_rate_yoy`	double	Year-over-year asking rent growth rate.
`ner_growth_rate_yoy`	double	Year-over-year net effective rent growth rate.
`concession_value`	double	Average concession value over the trailing 30 days.
`concession_percent`	double	Average concession as a share of rent over the trailing 30 days.
`days_on_market`	double	Average days on market for available units over the trailing 30 days.
`occupancy_percent`	double	Average occupancy share over the trailing 30 days.
`leased_percent`	double	Average leased share over the trailing 30 days.
`exposure_percent`	double	Average share of units exposed for lease over the trailing 30 days.

Organizations dataset

One row per stakeholder organization associated with at least one property. Profile fields describe the organization, while property and unit counts reflect the requested snapshot date. Breakdown fields are flattened into fixed scalar columns.

Field	Parquet type	Meaning
`id`	int64	ApartmentIQ stakeholder entity ID.
`name`	string	Organization display name.
`entity_type`	string	Stakeholder entity type, such as Property Manager or Owner.
`image_url`	string	Organization logo or image URL.
`website_url`	string	Organization website URL.
`domain_name`	string	Organization domain name.
`linkedin_url`	string	Organization LinkedIn URL.
`description`	string	Organization description.
`company_entity_type`	string	Company entity classification.
`company_legal_type`	string	Company legal structure.
`year_founded`	string	Year the organization was founded.
`phone_number`	string	Organization phone number.
`employee_count_range`	string	Known employee count range.
`headquarters_address`	string	Headquarters street address.
`headquarters_city`	string	Headquarters city.
`headquarters_state`	string	Headquarters state.
`headquarters_zip_code`	string	Headquarters postal code.
`headquarters_country`	string	Headquarters country.
`property_count`	int64	Number of associated properties on the snapshot date.
`total_unit_count`	int64	Total units across associated properties on the snapshot date.
`units_by_property_class_a_unit_count`	int64	Units in associated class A properties.
`units_by_property_class_b_unit_count`	int64	Units in associated class B properties.
`units_by_property_class_c_unit_count`	int64	Units in associated class C properties.
`units_by_property_class_d_unit_count`	int64	Units in associated class D properties.
`units_by_property_type_conventional_unit_count`	int64	Units in associated conventional properties.
`units_by_property_type_student_unit_count`	int64	Units in associated student housing properties.
`units_by_property_type_senior_unit_count`	int64	Units in associated senior living properties.
`units_by_property_type_build_to_rent_unit_count`	int64	Units in associated build-to-rent properties.
`units_by_property_type_affordable_unit_count`	int64	Units in associated income-restricted properties.

Organization Properties dataset

Use this dataset to connect properties to their current organizations without matching organization names. Each row links one property to one organization, so a property associated with multiple organizations appears in multiple rows. Join property_id to properties.property_id and organization_id to organizations.id. Use organizations.entity_type to determine each organization’s role. Historical organization relationships are not included.

Field	Parquet type	Meaning
`property_id`	int64	ApartmentIQ property ID. Joins to `property_id` in the Properties dataset.
`organization_id`	int64	ApartmentIQ stakeholder entity ID. Joins to `id` in the Organizations dataset.

Contacts dataset

One row per contact and linked stakeholder organization. A person linked to multiple qualifying organizations can appear once for each organization.

Field	Parquet type	Meaning
`name`	string	Contact name.
`job_title`	string	Contact job title.
`linkedin_url`	string	Contact LinkedIn URL.
`email_address`	string	Contact email address.
`phone_number`	string	Contact phone number.
`stakeholder_entity_id`	int64	ApartmentIQ stakeholder entity ID for the linked organization.
`stakeholder_entity_name`	string	Display name of the linked stakeholder organization.

POST

datasets

download

Download Dataset

curl --request POST \
  --url https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "{account_id}",
  "dataset": "properties",
  "file_type": "parquet"
}
'

import requests

url = "https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download"

payload = {
    "account_id": "{account_id}",
    "dataset": "properties",
    "file_type": "parquet"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_id: '{account_id}', dataset: 'properties', file_type: 'parquet'})
};

fetch('https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => '{account_id}',
    'dataset' => 'properties',
    'file_type' => 'parquet'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download"

	payload := strings.NewReader("{\n  \"account_id\": \"{account_id}\",\n  \"dataset\": \"properties\",\n  \"file_type\": \"parquet\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"{account_id}\",\n  \"dataset\": \"properties\",\n  \"file_type\": \"parquet\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://data.apartmentiq.io/apartmentiq/api/v2/datasets/download")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"{account_id}\",\n  \"dataset\": \"properties\",\n  \"file_type\": \"parquet\"\n}"

response = http.request(request)
puts response.read_body

{
  "dataset": "properties",
  "file_type": "parquet",
  "dataset_date": "2026-07-21",
  "download_url": "https://secure-downloads.example.com/properties-2026-07-21.parquet?signature=..."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

account_id

required

ApartmentIQ account ID used to set the request account context.

dataset

enum<string>

required

Dataset snapshot to download.

Available options:

properties,

organizations,

contacts,

organization_properties

file_type

enum<string>

required

Output file format.

Available options:

parquet,

csv

date

string<date>

Optional exact snapshot date in YYYY-MM-DD format. Omit it to download the newest completed snapshot.

Pattern: ^\d{4}-\d{2}-\d{2}$

redirect_to_download

boolean

default:false

Set to true to return a 303 redirect to the download URL instead of the default JSON response.

Response

Download details for the requested dataset. The private pre-signed URL expires after five minutes.

dataset

enum<string>

required

Dataset snapshot to download.

Available options:

properties,

organizations,

contacts,

organization_properties

file_type

enum<string>

required

Output file format.

Available options:

parquet,

csv

dataset_date

string<date>

required

Snapshot date selected for the download.

download_url

string<uri>

required

Private pre-signed download URL that expires after five minutes.

⌘I

Overview

API Reference

Download Dataset

How downloads work

Properties dataset

Organizations dataset

Organization Properties dataset

Contacts dataset

Authorizations

Body

Response