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).
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 support@apartmentiq.io.
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 support@apartmentiq.io.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ApartmentIQ API","colors":{"primary":"#5046E5","light":"#7A7EF3","dark":"#5046E5"},"logo":{"light":"https://mintcdn.com/apartmentiq-c1886649/bOkm0DURAy3zqK_v/logo/light.svg?fit=max\u0026auto=format\u0026n=bOkm0DURAy3zqK_v\u0026q=85\u0026s=0c92db5d709d8537ed3442caf047462f","dark":"https://mintcdn.com/apartmentiq-c1886649/bOkm0DURAy3zqK_v/logo/dark.svg?fit=max\u0026auto=format\u0026n=bOkm0DURAy3zqK_v\u0026q=85\u0026s=236aedeedc8d1be8508b4194f1ec161f"},"favicon":"https://mintcdn.com/apartmentiq-c1886649/b14Ka2Z5VsBhEojA/favicon.ico?fit=max\u0026auto=format\u0026n=b14Ka2Z5VsBhEojA\u0026q=85\u0026s=269b6e8976f2a41da8bbadca410d14b2","api":{"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required"}},"navbar":{"links":[{"href":"https://support.apartmentiq.io/","label":"Support"},{"href":"https://app.apartmentiq.io/","label":"Login"}],"primary":{"type":"button","label":"Request a Demo","href":"https://www.apartmentiq.io/request-a-demo/"}},"footer":{},"seo":{"metatags":{"robots":"noindex"}},"icons":{"library":"lucide"},"contextual":{"options":["copy","download-spec","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"apartmentiq-c1886649","hasAudioNarration":false,"actualSubdomain":"apartmentiq-c1886649","customDomains":["developers.apartmentiq.io"],"gitSource":{"type":"github","owner":"abodo-dev","repo":"apartmentiq-api-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af9205b59fc4106fcc45a33","clientVersion":"0.0.4263","searchFilterCounts":[{"language":"default","tag":"API Reference","count":38},{"language":"default","tag":"Overview","count":14},{"language":"default","tag":"Market Surveys","count":9},{"language":"default","tag":"Markets","count":7},{"language":"default","tag":"Bulk","count":6},{"language":"default","tag":"Use Cases","count":5},{"language":"default","tag":"Bulk Data Export","count":5},{"language":"default","tag":"Organizations","count":4},{"language":"default","tag":"Accounts","count":2},{"language":"default","tag":"Forecasts","count":2}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"v1/use-cases/data-sync","slug":"/v1/use-cases/data-sync","pageMetadata":{"title":"Data Sync","description":"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).","href":"/v1/use-cases/data-sync"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"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).\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`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.`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Data Sync does not use Bearer token authentication. It uses a dedicated, account‑specific Data Sync key. Do not send an `,_jsx(_components.code,{children:`Authorization: Bearer`}),` header for Data Sync downloads.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Your account’s Data Sync key (not your API token)`}),`\n`,_jsx(_components.li,{children:`Your Account ID (used in the URL path)`}),`\n`]}),`\n`,_jsxs(Tip,{children:[`If you need your Data Sync key or want to enable Data Sync for your account, contact support at `,_jsx(_components.a,{href:`mailto:support@apartmentiq.io`,children:`support@apartmentiq.io`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`delivery-options`,children:`Delivery options`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Direct download: You pull CSVs from secure URLs using your Data Sync key`}),`\n`,_jsx(_components.li,{children:`No-code BI delivery: Domo, PowerBI, Tableau, Excel, Google Drive, OneDrive, Email`}),`\n`,_jsx(_components.li,{children:`Data lake integrations: AWS, Snowflake, Azure, GCP`}),`\n`,_jsx(_components.li,{children:`SFTP push: ApartmentIQ uploads CSVs to your SFTP server (you provide host, username, and password)`}),`\n`]}),`\n`,_jsx(_components.p,{children:`For step-by-step setup guides (including platform-specific instructions), see Support Documentation below.`}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`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 `,_jsx(_components.code,{children:`Authorization`}),` header.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Example (replace placeholders with your actual values)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -s`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://data.apartmentiq.io/apartmentiq/api/v1/accounts/\u003cYOUR_ACCOUNT_ID>/data_sync/data.csv?key=\u003cYOUR_KEY>\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Method: GET`}),`\n`,_jsxs(_components.li,{children:[`No `,_jsx(_components.code,{children:`Authorization: Bearer ...`}),` header is required or used for Data Sync`]}),`\n`,_jsxs(_components.li,{children:[`Requests without a valid `,_jsx(_components.code,{children:`key`}),` are rejected with an authorization error`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/v1/authentication`,children:`Authentication`}),` for standard API token usage. Again, this does not apply to Data Sync.`]}),`\n`,_jsx(Heading,{level:`2`,id:`data-granularity`,children:`Data granularity`}),`\n`,_jsx(_components.p,{children:`Choose from three levels of granularity in your feed:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Property`}),`\n`,_jsx(_components.li,{children:`Floor plan`}),`\n`,_jsx(_components.li,{children:`Unit`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`files-and-scheduling`,children:`Files and scheduling`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Format: CSV per dataset (property, floor plan, unit)`}),`\n`,_jsx(_components.li,{children:`Update time: Files update every morning and are ready with the current day’s data by 11 AM CST`}),`\n`,_jsx(_components.li,{children:`Availability: If you access a file before the daily update completes, it will still contain the previous day’s data (no downtime)`}),`\n`]}),`\n`,_jsx(_components.p,{children:`When users add or remove comps in ApartmentIQ, Standard and DataLake deliveries reflect changes the next day; API data is available in real time.`}),`\n`,_jsx(Heading,{level:`2`,id:`download-behavior`,children:`Download behavior`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`If the current day’s file is not yet updated, the download returns the previous day’s data to avoid gaps`}),`\n`,_jsx(_components.li,{children:`Downloads stream CSV content as an attachment`}),`\n`]}),`\n`,_jsx(_components.p,{children:`When supported by your configuration:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`report_type`}),`: Selects which dataset to download`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`msa_id`}),` (optional): Targets a specific MSA when your account has MSA‑level files`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`security`,children:`Security`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Treat your Data Sync key like a secret; store it securely (for example, environment variables or a secrets manager)`}),`\n`,_jsx(_components.li,{children:`Rotate the key upon suspicion of compromise and notify ApartmentIQ to reconfigure destinations if needed`}),`\n`,_jsx(_components.li,{children:`Limit destination access permissions`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`use-cases`,children:`Use Cases`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Nightly warehouse loads: Receive CSVs on SFTP and ingest to your warehouse`}),`\n`,_jsx(_components.li,{children:`Portfolio reporting: Automate recurring exports for executive and property‑level reporting`}),`\n`,_jsx(_components.li,{children:`Regional analysis: Pull MSA‑specific files (when enabled) to power submarket dashboards`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`available-fields`,children:`Available fields`}),`\n`,_jsx(_components.p,{children:`For a comprehensive list of available fields for unit, floor plan, and property datasets, see the field reference in our Support Documentation below.`}),`\n`,_jsx(Heading,{level:`2`,id:`support-documentation`,children:`Support Documentation`}),`\n`,_jsxs(_components.p,{children:[`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 `,_jsx(_components.a,{href:`https://support.apartmentiq.io/technical-documentation/apartmentiq-direct-data-delivery`,children:`Support Documentation`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`getting-help`,children:`Getting help`}),`\n`,_jsxs(_components.p,{children:[`If you need to enable Data Sync, add destinations, or retrieve your key, contact support at `,_jsx(_components.a,{href:`mailto:support@apartmentiq.io`,children:`support@apartmentiq.io`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Data Sync","description":"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).","href":"/v1/use-cases/data-sync"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Delivery options","slug":"delivery-options","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Data granularity","slug":"data-granularity","depth":2,"children":[]},{"title":"Files and scheduling","slug":"files-and-scheduling","depth":2,"children":[]},{"title":"Download behavior","slug":"download-behavior","depth":2,"children":[]},{"title":"Security","slug":"security","depth":2,"children":[]},{"title":"Use Cases","slug":"use-cases","depth":2,"children":[]},{"title":"Available fields","slug":"available-fields","depth":2,"children":[]},{"title":"Support Documentation","slug":"support-documentation","depth":2,"children":[]},{"title":"Getting help","slug":"getting-help","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"apartmentiq-c1886649","siteName":"ApartmentIQ API","title":"Data Sync - ApartmentIQ API","navMaps":{"firstHrefInVersion":{"API Version: 1":{"href":"/v1/use-cases/data-sync","matchLevel":0},"API Version: 2 (Preview)":{"href":"/v2","matchLevel":3}},"firstHrefInLanguage":{}},"lastModified":"2026-07-01T22:46:07.558Z","originalFileLocation":"v1/use-cases/data-sync.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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).\">\u003cmeta data-mint-head name=\"application-name\" content=\"ApartmentIQ API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/apartmentiq-c1886649/_q5dJxOe_4A4IlTw/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/apartmentiq-c1886649/_q5dJxOe_4A4IlTw/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/apartmentiq-c1886649/_q5dJxOe_4A4IlTw/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/apartmentiq-c1886649/_q5dJxOe_4A4IlTw/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/apartmentiq-c1886649/_q5dJxOe_4A4IlTw/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/apartmentiq-c1886649/_q5dJxOe_4A4IlTw/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/apartmentiq-c1886649/_q5dJxOe_4A4IlTw/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/apartmentiq-c1886649/_q5dJxOe_4A4IlTw/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/apartmentiq-c1886649/_q5dJxOe_4A4IlTw/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Data Sync - ApartmentIQ API\">\u003cmeta data-mint-head property=\"og:description\" content=\"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).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ApartmentIQ API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.apartmentiq.io/v1/use-cases/data-sync\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://apartmentiq-c1886649.mintlify.site/_mintlify/api/og/v2?division=Use+Cases\u0026amp;title=Data+Sync\u0026amp;description=Daily+direct+data+delivery+via+no-code+BI+connectors%2C+data+lake+destinations%2C+SFTP%2C+or+secure+download+%E2%80%94+authenticated+with+a+dedicated+Data+Sync+key+%28not+a+Bea\u0026amp;theme=dc0e3ba1149aaeec6590ba45\u0026amp;signature=482f90f44a24d08f8d2505bed05fec5e13f7c8f39ee2da88eacf46cdd62ceaf8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Data Sync - ApartmentIQ API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://apartmentiq-c1886649.mintlify.site/_mintlify/api/og/v2?division=Use+Cases\u0026amp;title=Data+Sync\u0026amp;description=Daily+direct+data+delivery+via+no-code+BI+connectors%2C+data+lake+destinations%2C+SFTP%2C+or+secure+download+%E2%80%94+authenticated+with+a+dedicated+Data+Sync+key+%28not+a+Bea\u0026amp;theme=dc0e3ba1149aaeec6590ba45\u0026amp;signature=482f90f44a24d08f8d2505bed05fec5e13f7c8f39ee2da88eacf46cdd62ceaf8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/apartmentiq-c1886649/_q5dJxOe_4A4IlTw/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ApartmentIQ API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5046E5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.apartmentiq.io/v1/use-cases/data-sync\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v1/use-cases/data-sync.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.apartmentiq.io/#organization\",\"name\":\"ApartmentIQ API\",\"url\":\"https://developers.apartmentiq.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/apartmentiq-c1886649/bOkm0DURAy3zqK_v/logo/light.svg?fit=max\u0026auto=format\u0026n=bOkm0DURAy3zqK_v\u0026q=85\u0026s=0c92db5d709d8537ed3442caf047462f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.apartmentiq.io#website\",\"name\":\"ApartmentIQ API\",\"url\":\"https://developers.apartmentiq.io\",\"publisher\":{\"@id\":\"https://developers.apartmentiq.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.apartmentiq.io/v1/use-cases/data-sync#webpage\",\"url\":\"https://developers.apartmentiq.io/v1/use-cases/data-sync\",\"name\":\"Data Sync\",\"description\":\"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).\",\"dateModified\":\"2026-07-01T22:46:07.558Z\",\"isPartOf\":{\"@id\":\"https://developers.apartmentiq.io#website\"},\"breadcrumb\":{\"@id\":\"https://developers.apartmentiq.io/v1/use-cases/data-sync#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.apartmentiq.io/v1/use-cases/data-sync#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Use Cases\",\"item\":\"https://developers.apartmentiq.io/v1/use-cases/market-survey\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Data Sync\",\"item\":\"https://developers.apartmentiq.io/v1/use-cases/data-sync\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developers.apartmentiq.io/v1/use-cases/data-sync#article\",\"headline\":\"Data Sync\",\"name\":\"Data Sync\",\"description\":\"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).\",\"url\":\"https://developers.apartmentiq.io/v1/use-cases/data-sync\",\"mainEntityOfPage\":{\"@id\":\"https://developers.apartmentiq.io/v1/use-cases/data-sync#webpage\"},\"dateModified\":\"2026-07-01T22:46:07.558Z\",\"publisher\":{\"@id\":\"https://developers.apartmentiq.io/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.apartmentiq.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ApartmentIQ API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ApartmentIQ API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/v1/use-cases/data-sync.md","siteName":"ApartmentIQ API","nav":{"global":{},"versions":[{"version":"API Version: 1","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/v1"},{"title":"Getting Started","href":"/v1/getting-started"},{"title":"Key Terms","href":"/v1/key-terms"},{"title":"Authentication","href":"/v1/authentication"},{"title":"Rate Limits","href":"/v1/rate-limits"},{"title":"Errors","href":"/v1/errors"},{"title":"Changelog","href":"/changelog/v1"}]},{"group":"Use Cases","pages":[{"title":"Market Survey","href":"/v1/use-cases/market-survey"},{"title":"Market Analysis","href":"/v1/use-cases/market-analysis"},{"title":"Compare Markets","description":"Compare aggregated metrics across MSAs and submarkets.","href":"/v1/use-cases/compare-markets"},{"title":"Data Sync","href":"/v1/use-cases/data-sync"},{"title":"Bulk Data Export","description":"Request and download historical property data at scale using batch jobs.","href":"/v1/use-cases/bulk-data-export"}]},{"group":"API Reference","expanded":true,"pages":[{"group":"Accounts","expanded":true,"pages":[{"title":"List Accounts","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json get /accounts","href":"/api-reference/accounts/list-accounts"}]},{"group":"Market Surveys","expanded":true,"pages":[{"title":"List Competitive Sets","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json get /accounts/{account_id}/comp_sets","href":"/api-reference/market-surveys/list-competitive-sets"},{"title":"Get Market Survey Data","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json get /comp_sets/{comp_set_id}/market_survey","href":"/api-reference/market-surveys/get-market-survey-data"},{"title":"List Units In Competitive Set","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json get /comp_sets/{comp_set_id}/units","href":"/api-reference/market-surveys/list-units-in-competitive-set"},{"title":"List Floorplans","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json get /comp_sets/{comp_set_id}/floor_plans","href":"/api-reference/market-surveys/list-floorplans"}]},{"group":"Markets","expanded":true,"pages":[{"title":"Search Geo Boundaries","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json post /geo_boundaries/search","href":"/api-reference/markets/search-geo-boundaries"},{"title":"Search Properties","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json post /geo_boundaries/properties","href":"/api-reference/markets/search-properties"},{"title":"Property Lookup","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json get /properties/lookup","href":"/api-reference/markets/property-lookup"},{"title":"Bulk Property Details","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json get /properties/bulk_details","href":"/api-reference/markets/bulk-property-details"},{"title":"Compare Markets","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json post /explore_markets","href":"/api-reference/markets/compare-markets"},{"title":"Get Market Narrative","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json get /markets/narratives","href":"/api-reference/markets/get-market-narrative"}]},{"group":"Bulk Data Export","expanded":true,"pages":[{"title":"Create Batch Job","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json post /bulk_api/jobs","href":"/api-reference/bulk-data-export/create-batch-job"},{"title":"List Batch Jobs","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json get /bulk_api/jobs","href":"/api-reference/bulk-data-export/list-batch-jobs"},{"title":"Get Batch Job Status","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json get /bulk_api/jobs/{job_id}","href":"/api-reference/bulk-data-export/get-batch-job-status"},{"title":"Cancel Batch Job","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json delete /bulk_api/jobs/{job_id}","href":"/api-reference/bulk-data-export/cancel-batch-job"},{"title":"Download Batch Job Results","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json get /bulk_api/jobs/{job_id}/results","href":"/api-reference/bulk-data-export/download-batch-job-results"}]},{"group":"Forecasts","expanded":true,"pages":[{"title":"Geo Boundary Forecasts","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json post /geo_boundary/{geo_boundary_id}/forecasts","href":"/api-reference/forecasts/geo-boundary-forecasts"},{"title":"Property Forecasts","deprecated":null,"version":null,"openapi":"/openapi/v1/schema.json post /properties/{property_id}/forecasts","href":"/api-reference/forecasts/property-forecasts"}]}]}]},{"version":"API Version: 2 (Preview)","pages":[{"title":"API Version: 2 (Preview)","href":"/v2"}]}]},"basePath":"","title":"Data Sync - ApartmentIQ API","deploymentId":"dpl_7AgmPo2RyRWZ68ZGceW618SWGEAz","buildId":"dpl_7AgmPo2RyRWZ68ZGceW618SWGEAz","dynamics":[],"chunks":[]}