The goal of the ApartmentIQ data transfer is to give you access to your data as easily as possible. As an HTTP endpoint you can access the data from any programming language or by using many common tools. The file can be obtained using a GET request and returns CSV format of that data. This document shows how to use the “Curl” tool, specifically.
Your data sync URL will be provided to you by ApartmentIQ. This document uses a sample URL but be sure to update that when doing real calls.
To output the results of the file you can run the following command:
curl “https://data.apartmentiq.io/apartmentiq/api/v1/accounts/[YOUR_ACCOUNT_ID]/data_sync/data.csv?key=[YOUR_KEY]”
Below is a table listing all the fields included in the file:
Field Name |
Data Type |
Notes |
Report Generation Date |
Date |
The day the report was generated |
Market Name |
String |
|
Market ID |
String |
|
Property Name |
String |
|
Property ID |
Integer |
|
Property URL |
String |
|
Address |
String |
|
City |
String |
|
State |
String |
|
Zip |
String |
|
Latitude |
Float |
|
Longitude |
Float |
|
Date Tracking Started |
Date |
|
Unit Count |
Integer |
|
Year Built |
Integer |
|
Unit Name |
String |
|
Days On Market |
Integer |
|
Date Available |
Date |
|
Beds |
Integer |
|
Baths |
Integer |
|
Rent |
Float |
|
Sq Ft |
Integer |
|
Rent / Sq Ft |
Float |
|
Last Change Date |
Date |
|
Last Change |
String |
|
Total Change |
String |
|
Rent Changes |
Integer |
|
Trucomp |
Boolean |
|
Date Leased |
Date |
|
Trucomp Rent Differential |
String |
|
Trucomp Sq Ft Differential |
String |
|
Trucomp Rent / Sq Ft Differential |
String |
|
Concessions |
String |
*Only Available in some pricing tiers |
NER |
String |
*Only Available in some pricing tiers |
Concession Details |
String |
*Only Available in some pricing tiers |
NER / Sq Ft |
String |
*Only Available in some pricing tiers |
For further assistance, please contact the ApartmentIQ Support team by emailing into support@apartmentiq.io