Skip to main content
Use Data Sync to receive a daily direct data feed from ApartmentIQ. You can use no-code connectors for common BI tools, integrate with major data lake providers, push to your SFTP server, or download securely via account‑specific URLs.
Data Sync does not use Bearer token authentication. It uses a dedicated, account‑specific Data Sync key. Do not send an Authorization: Bearer header for Data Sync downloads.

​
Prerequisites

  • Your account’s Data Sync key (not your API token)
  • Your Account ID (used in the URL path)
If you need your Data Sync key or want to enable Data Sync for your account, contact support at [email protected].

​
Delivery options

  • Direct download: You pull CSVs from secure URLs using your Data Sync key
  • No-code BI delivery: Domo, PowerBI, Tableau, Excel, Google Drive, OneDrive, Email
  • Data lake integrations: AWS, Snowflake, Azure, GCP
  • SFTP push: ApartmentIQ uploads CSVs to your SFTP server (you provide host, username, and password)
For step-by-step setup guides (including platform-specific instructions), see Support Documentation below.

​
Authentication

Data Sync is an HTTP endpoint. You access the file with a GET request and receive CSV. Authentication uses a dedicated key appended as a query parameter. Do not include an Authorization header. 
# Example (replace placeholders with your actual values)
curl -s "https://data.apartmentiq.io/apartmentiq/api/v1/accounts/<YOUR_ACCOUNT_ID>/data_sync/data.csv?key=<YOUR_KEY>"
  • Method: GET
  • No Authorization: Bearer ... header is required or used for Data Sync
  • Requests without a valid key are rejected with an authorization error
See Authentication for standard API token usage. Again, this does not apply to Data Sync.

​
Data granularity

Choose from three levels of granularity in your feed:
  • Property
  • Floor plan
  • Unit

​
Files and scheduling

  • Format: CSV per dataset (property, floor plan, unit)
  • Update time: Files update every morning and are ready with the current day’s data by 11 AM CST
  • Availability: If you access a file before the daily update completes, it will still contain the previous day’s data (no downtime)
When users add or remove comps in ApartmentIQ, Standard and DataLake deliveries reflect changes the next day; API data is available in real time.

​
Download behavior

  • If the current day’s file is not yet updated, the download returns the previous day’s data to avoid gaps
  • Downloads stream CSV content as an attachment
When supported by your configuration:
  • report_type: Selects which dataset to download
  • msa_id (optional): Targets a specific MSA when your account has MSA‑level files

​
Security

  • Treat your Data Sync key like a secret; store it securely (for example, environment variables or a secrets manager)
  • Rotate the key upon suspicion of compromise and notify ApartmentIQ to reconfigure destinations if needed
  • Limit destination access permissions

​
Use Cases

  • Nightly warehouse loads: Receive CSVs on SFTP and ingest to your warehouse
  • Portfolio reporting: Automate recurring exports for executive and property‑level reporting
  • Regional analysis: Pull MSA‑specific files (when enabled) to power submarket dashboards

​
Available fields

For a comprehensive list of available fields for unit, floor plan, and property datasets, see the field reference in our Support Documentation below.

​
Support Documentation

For platform-specific no-code setup guides (Domo, PowerBI, Tableau, Excel, Google Drive, OneDrive, Email, and CURL) and a detailed field reference, visit our comprehensive Support Documentation.

​
Getting help

If you need to enable Data Sync, add destinations, or retrieve your key, contact support at [email protected].