Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
account_id
integerstring
required
ApartmentIQ account ID used to set the request account context.
time_period
enum<string>
required
Forecast horizon.
Available options:
next_12_months,
next_3_years,
next_5_years
interval
enum<string>
required
Forecast period bucket.
Available options:
month,
quarter,
year
fields
enum<string>[]
Forecast metric field names to include in each property row.
Available options:
rent_growth_rate_yoy,
rent_growth_rate_yoy_downside,
rent_growth_rate_yoy_upside,
occupancy_percent,
occupancy_percent_downside,
occupancy_percent_upside
property_filters
object
Filters used to select properties and constrain the metric aggregation date range.
Show child attributes
page
integer
default:1
Page number. Values less than 1 are treated as 1.
Required range: x >= 1
per_page
integer
default:25
Matched properties per page. Values above 100 are capped at 100. Interval-based rows expand each matched property into one row per period, so the number of rows returned can be greater than per_page.
Required range: 1 <= x <= 100
Response
Bulk property forecast rows and pagination metadata.
Paginated property forecast export results.
rows
object[]
required
Property forecast rows for the matched properties on the current page. Each matched property is expanded into one row per interval period, so the number of rows returned can be greater than the per_page value. Each row includes property identity fields, an output period, and any requested forecast fields.
Show child attributes
pagination
object
required
Pagination details for matched properties, not the expanded interval-period rows.
Show child attributes
{"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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":"v2/api-reference/bulk/bulk-property-forecasts","slug":"/v2/api-reference/bulk/bulk-property-forecasts","pageMetadata":{"title":"Bulk Property Forecasts","description":"Retrieve bulk property forecast rows using optional property filters, requested forecast fields, and pagination.\n\n\u003cWarning>Requires Explore Pro access and consumes property bulk export quota.\u003c/Warning>","deprecated":null,"version":null,"sidebarTitle":"Bulk property forecasts","openapi":"/openapi/v2/schema.json post /properties/bulk_forecasts","href":"/v2/api-reference/bulk/bulk-property-forecasts","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n }, {Warning} = _components;\n if (!Warning) _missingMdxReference(\"Warning\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve bulk property forecast rows using optional property filters, requested forecast fields, and pagination.\"\n }), \"\\n\", _jsx(Warning, {\n children: \"Requires Explore Pro access and consumes property bulk export quota.\"\n })]\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};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Bulk Property Forecasts","description":"Retrieve bulk property forecast rows using optional property filters, requested forecast fields, and pagination.\n\n\u003cWarning>Requires Explore Pro access and consumes property bulk export quota.\u003c/Warning>","deprecated":null,"version":null,"sidebarTitle":"Bulk property forecasts","openapi":"/openapi/v2/schema.json post /properties/bulk_forecasts","href":"/v2/api-reference/bulk/bulk-property-forecasts","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Bulk"],"summary":"Bulk Property Forecasts","description":"Retrieve bulk property forecast rows using optional property filters, requested forecast fields, and pagination.\n\n\u003cWarning>Requires Explore Pro access and consumes property bulk export quota.\u003c/Warning>","operationId":"createV2PropertiesBulkForecasts","requestBody":"957993a5-3fa8-4f9e-b8f3-feb2498ecdbf","responses":{"200":"447c0bb9-77fb-4399-afa9-d772eb643a3d","400":"c3b36795-fa6a-438d-859a-f956ad7f82e9","401":"caad415a-eed5-4487-9343-3fbef217b55a","403":"10e8e428-abaf-47c5-99a5-c08571ac0a91","429":"39c5b752-8b21-4302-a12c-12060c74d11d","500":"8b13464a-8fea-4da8-a4fa-efc2879bba73"},"x-mint":{"href":"/v2/api-reference/bulk/bulk-property-forecasts"},"method":"post","type":"path","servers":["def266db-b426-422c-8a18-ce77be7a68b8"],"security":["3efcaff5-2dc6-4d5d-bb85-05579ed7f33d"],"path":"/properties/bulk_forecasts","baseUrlOptions":["https://data.apartmentiq.io/apartmentiq/api/v2"],"title":"Bulk Property Forecasts","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"oneOf":[{"type":"integer","description":"ApartmentIQ account ID used to set the request account context.","isRequired":true,"uniqueKey":"account_id.oneOf.0","typeLabel":"integer"},{"type":"string","description":"ApartmentIQ account ID used to set the request account context.","isRequired":true,"uniqueKey":"account_id.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"account_id","typeLabel":"integer | string"},"time_period":{"type":"string","enum":["next_12_months","next_3_years","next_5_years"],"description":"Forecast horizon.","isRequired":true,"uniqueKey":"time_period","typeLabel":"enum\u003cstring>"},"interval":{"type":"string","enum":["month","quarter","year"],"description":"Forecast period bucket.","isRequired":true,"uniqueKey":"interval","typeLabel":"enum\u003cstring>"},"fields":{"type":"array","items":{"type":"string","enum":["rent_growth_rate_yoy","rent_growth_rate_yoy_downside","rent_growth_rate_yoy_upside","occupancy_percent","occupancy_percent_downside","occupancy_percent_upside"],"uniqueKey":"fields.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueItems":true,"description":"Forecast metric field names to include in each property row.","uniqueKey":"fields","typeLabel":"enum\u003cstring>[]"},"property_filters":{"type":"object","description":"Filters used to select properties and constrain the metric aggregation date range.","properties":{"amenity_ids":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"integer","uniqueKey":"property_filters.amenity_ids.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"integer"},{"type":"string","uniqueKey":"property_filters.amenity_ids.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"string"}],"uniqueKey":"property_filters.amenity_ids.oneOf.0.items.[INDEX]","typeLabel":"integer | string"},"description":"Amenity IDs that matching properties must include.","uniqueKey":"property_filters.amenity_ids.oneOf.0","typeLabel":"(integer | string)[]"},{"type":"string","description":"Amenity IDs that matching properties must include.","uniqueKey":"property_filters.amenity_ids.oneOf.1","typeLabel":"string"}],"uniqueKey":"property_filters.amenity_ids","typeLabel":"(integer | string)[] | string"},"bathroom_count":{"oneOf":[{"type":"array","items":{"type":"number","uniqueKey":"property_filters.bathroom_count.oneOf.0.items.[INDEX]","typeLabel":"number"},"description":"Bathroom counts that matching properties must offer.","uniqueKey":"property_filters.bathroom_count.oneOf.0","typeLabel":"number[]"},{"type":"string","description":"Bathroom counts that matching properties must offer.","uniqueKey":"property_filters.bathroom_count.oneOf.1","typeLabel":"string"}],"uniqueKey":"property_filters.bathroom_count","typeLabel":"number[] | string"},"bedroom_count":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"property_filters.bedroom_count.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"Bedroom counts that matching properties must offer.","uniqueKey":"property_filters.bedroom_count.oneOf.0","typeLabel":"integer[]"},{"type":"string","description":"Bedroom counts that matching properties must offer.","uniqueKey":"property_filters.bedroom_count.oneOf.1","typeLabel":"string"}],"uniqueKey":"property_filters.bedroom_count","typeLabel":"integer[] | string"},"city":{"type":"string","description":"City for location-based property filtering. Use with state.","uniqueKey":"property_filters.city","typeLabel":"string"},"collected_at_gte":{"type":"string","format":"date","description":"Inclusive start date for metric data. Must be on or after 2022-01-01.","uniqueKey":"property_filters.collected_at_gte","typeLabel":"string\u003cdate>"},"collected_at_lte":{"type":"string","format":"date","description":"Inclusive end date for metric data. Must be on or after 2022-01-01.","uniqueKey":"property_filters.collected_at_lte","typeLabel":"string\u003cdate>"},"concession_percent_gte":{"type":"number","description":"Minimum concession percentage, expressed as a decimal value.","uniqueKey":"property_filters.concession_percent_gte","typeLabel":"number"},"concession_percent_lte":{"type":"number","description":"Maximum concession percentage, expressed as a decimal value.","uniqueKey":"property_filters.concession_percent_lte","typeLabel":"number"},"concession_value_gte":{"type":"number","description":"Minimum advertised concession value in dollars.","uniqueKey":"property_filters.concession_value_gte","typeLabel":"number"},"concession_value_lte":{"type":"number","description":"Maximum advertised concession value in dollars.","uniqueKey":"property_filters.concession_value_lte","typeLabel":"number"},"construction_state":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"property_filters.construction_state.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Construction state filters such as existing or new_supply.","uniqueKey":"property_filters.construction_state.oneOf.0","typeLabel":"string[]"},{"type":"string","description":"Construction state filters such as existing or new_supply.","uniqueKey":"property_filters.construction_state.oneOf.1","typeLabel":"string"}],"uniqueKey":"property_filters.construction_state","typeLabel":"string[] | string"},"exposure_gte":{"type":"number","description":"Minimum exposure percentage, expressed as a decimal value.","uniqueKey":"property_filters.exposure_gte","typeLabel":"number"},"exposure_lte":{"type":"number","description":"Maximum exposure percentage, expressed as a decimal value.","uniqueKey":"property_filters.exposure_lte","typeLabel":"number"},"geo_boundary_ids":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"integer","uniqueKey":"property_filters.geo_boundary_ids.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"integer"},{"type":"string","uniqueKey":"property_filters.geo_boundary_ids.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"string"}],"uniqueKey":"property_filters.geo_boundary_ids.oneOf.0.items.[INDEX]","typeLabel":"integer | string"},"description":"Geo boundary IDs used to limit matching properties by market.","uniqueKey":"property_filters.geo_boundary_ids.oneOf.0","typeLabel":"(integer | string)[]"},{"type":"string","description":"Geo boundary IDs used to limit matching properties by market.","uniqueKey":"property_filters.geo_boundary_ids.oneOf.1","typeLabel":"string"}],"uniqueKey":"property_filters.geo_boundary_ids","typeLabel":"(integer | string)[] | string"},"lat":{"type":"number","description":"Latitude for radius search. Use with lng.","uniqueKey":"property_filters.lat","typeLabel":"number"},"leased_percent_gte":{"type":"number","description":"Minimum leased percentage, expressed as a decimal value.","uniqueKey":"property_filters.leased_percent_gte","typeLabel":"number"},"leased_percent_lte":{"type":"number","description":"Maximum leased percentage, expressed as a decimal value.","uniqueKey":"property_filters.leased_percent_lte","typeLabel":"number"},"lng":{"type":"number","description":"Longitude for radius search. Use with lat.","uniqueKey":"property_filters.lng","typeLabel":"number"},"ner_gte":{"type":"number","description":"Minimum net effective rent.","uniqueKey":"property_filters.ner_gte","typeLabel":"number"},"ner_lte":{"type":"number","description":"Maximum net effective rent.","uniqueKey":"property_filters.ner_lte","typeLabel":"number"},"ner_per_sq_ft_gte":{"type":"number","description":"Minimum net effective rent per square foot.","uniqueKey":"property_filters.ner_per_sq_ft_gte","typeLabel":"number"},"ner_per_sq_ft_lte":{"type":"number","description":"Maximum net effective rent per square foot.","uniqueKey":"property_filters.ner_per_sq_ft_lte","typeLabel":"number"},"number_of_stories_gte":{"type":"number","description":"Minimum property story count.","uniqueKey":"property_filters.number_of_stories_gte","typeLabel":"number"},"number_of_stories_lte":{"type":"number","description":"Maximum property story count.","uniqueKey":"property_filters.number_of_stories_lte","typeLabel":"number"},"occupancy_gte":{"type":"number","description":"Minimum occupancy percentage, expressed as a decimal value.","uniqueKey":"property_filters.occupancy_gte","typeLabel":"number"},"occupancy_lte":{"type":"number","description":"Maximum occupancy percentage, expressed as a decimal value.","uniqueKey":"property_filters.occupancy_lte","typeLabel":"number"},"property_class":{"oneOf":[{"type":"array","items":{"type":"string","enum":["A","B","C","D"],"uniqueKey":"property_filters.property_class.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Property class values to include. Valid values: `A`, `B`, `C`, `D`.","uniqueKey":"property_filters.property_class.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"string","description":"Property class values to include. Valid values: `A`, `B`, `C`, `D`.","uniqueKey":"property_filters.property_class.oneOf.1","typeLabel":"string"}],"uniqueKey":"property_filters.property_class","typeLabel":"enum\u003cstring>[] | string"},"property_ids":{"type":"string","description":"Comma-separated ApartmentIQ property IDs to include.","uniqueKey":"property_filters.property_ids","typeLabel":"string"},"property_type":{"oneOf":[{"type":"array","items":{"type":"string","enum":["conventional","student","student_housing","senior","senior_living","build_to_rent","affordable"],"uniqueKey":"property_filters.property_type.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Property type filters to include. Valid values: `conventional`, `student`, `student_housing`, `senior`, `senior_living`, `build_to_rent`, `affordable`.","uniqueKey":"property_filters.property_type.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"string","description":"Property type filters to include. Valid values: `conventional`, `student`, `student_housing`, `senior`, `senior_living`, `build_to_rent`, `affordable`.","uniqueKey":"property_filters.property_type.oneOf.1","typeLabel":"string"}],"uniqueKey":"property_filters.property_type","typeLabel":"enum\u003cstring>[] | string"},"radius":{"type":"number","description":"Radius in miles for lat/lng search. Values are clamped between 0 and 30.","uniqueKey":"property_filters.radius","typeLabel":"number"},"renovated_units":{"type":"boolean","description":"Whether matching properties must have renovated unit inventory.","uniqueKey":"property_filters.renovated_units","typeLabel":"boolean"},"rent_gte":{"type":"number","description":"Minimum advertised rent.","uniqueKey":"property_filters.rent_gte","typeLabel":"number"},"rent_lte":{"type":"number","description":"Maximum advertised rent.","uniqueKey":"property_filters.rent_lte","typeLabel":"number"},"rent_per_sq_ft_gte":{"type":"number","description":"Minimum advertised rent per square foot.","uniqueKey":"property_filters.rent_per_sq_ft_gte","typeLabel":"number"},"rent_per_sq_ft_lte":{"type":"number","description":"Maximum advertised rent per square foot.","uniqueKey":"property_filters.rent_per_sq_ft_lte","typeLabel":"number"},"size_gte":{"type":"number","description":"Minimum unit size in square feet.","uniqueKey":"property_filters.size_gte","typeLabel":"number"},"size_lte":{"type":"number","description":"Maximum unit size in square feet.","uniqueKey":"property_filters.size_lte","typeLabel":"number"},"stakeholder_entity_ids":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"integer","uniqueKey":"property_filters.stakeholder_entity_ids.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"integer"},{"type":"string","uniqueKey":"property_filters.stakeholder_entity_ids.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"string"}],"uniqueKey":"property_filters.stakeholder_entity_ids.oneOf.0.items.[INDEX]","typeLabel":"integer | string"},"description":"Stakeholder entity IDs associated with matching properties.","uniqueKey":"property_filters.stakeholder_entity_ids.oneOf.0","typeLabel":"(integer | string)[]"},{"type":"string","description":"Stakeholder entity IDs associated with matching properties.","uniqueKey":"property_filters.stakeholder_entity_ids.oneOf.1","typeLabel":"string"}],"uniqueKey":"property_filters.stakeholder_entity_ids","typeLabel":"(integer | string)[] | string"},"state":{"type":"string","description":"State for location-based property filtering. Use with city.","uniqueKey":"property_filters.state","typeLabel":"string"},"total_units_gte":{"type":"number","description":"Minimum total property unit count.","uniqueKey":"property_filters.total_units_gte","typeLabel":"number"},"total_units_lte":{"type":"number","description":"Maximum total property unit count.","uniqueKey":"property_filters.total_units_lte","typeLabel":"number"},"transaction_cap_rate_gte":{"type":"number","description":"Minimum transaction capitalization rate for pro-plus users.","uniqueKey":"property_filters.transaction_cap_rate_gte","typeLabel":"number"},"transaction_cap_rate_lte":{"type":"number","description":"Maximum transaction capitalization rate for pro-plus users.","uniqueKey":"property_filters.transaction_cap_rate_lte","typeLabel":"number"},"transaction_date_closed_gte":{"type":"string","format":"date","description":"Inclusive earliest transaction closed date for pro-plus users.","uniqueKey":"property_filters.transaction_date_closed_gte","typeLabel":"string\u003cdate>"},"transaction_date_closed_lte":{"type":"string","format":"date","description":"Inclusive latest transaction closed date for pro-plus users.","uniqueKey":"property_filters.transaction_date_closed_lte","typeLabel":"string\u003cdate>"},"transaction_price_per_unit_gte":{"type":"number","description":"Minimum transaction price per unit for pro-plus users.","uniqueKey":"property_filters.transaction_price_per_unit_gte","typeLabel":"number"},"transaction_price_per_unit_lte":{"type":"number","description":"Maximum transaction price per unit for pro-plus users.","uniqueKey":"property_filters.transaction_price_per_unit_lte","typeLabel":"number"},"unified_status":{"oneOf":[{"type":"array","items":{"type":"string","enum":["stabilized","planning","scheduled_construction","under_construction","lease_up"],"uniqueKey":"property_filters.unified_status.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Unified property status values to include.","uniqueKey":"property_filters.unified_status.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"string","description":"Unified property status values to include.","uniqueKey":"property_filters.unified_status.oneOf.1","typeLabel":"string"}],"uniqueKey":"property_filters.unified_status","typeLabel":"enum\u003cstring>[] | string"},"year_built_gte":{"type":"number","description":"Minimum year built.","uniqueKey":"property_filters.year_built_gte","typeLabel":"number"},"year_built_lte":{"type":"number","description":"Maximum year built.","uniqueKey":"property_filters.year_built_lte","typeLabel":"number"},"zip_code":{"type":"string","description":"Zip code for location-based property filtering.","uniqueKey":"property_filters.zip_code","typeLabel":"string"}},"uniqueKey":"property_filters","typeLabel":"object"},"page":{"type":"integer","minimum":1,"default":1,"description":"Page number. Values less than 1 are treated as 1.","uniqueKey":"page","typeLabel":"integer"},"per_page":{"type":"integer","minimum":1,"maximum":100,"default":25,"description":"Matched properties per page. Values above 100 are capped at 100. Interval-based rows expand each matched property into one row per period, so the number of rows returned can be greater than per_page.","uniqueKey":"per_page","typeLabel":"integer"}},"required":["account_id","time_period","interval"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"account_id":"{account_id}","time_period":"next_12_months","interval":"month","property_filters":{"total_units_gte":100},"fields":["rent_growth_rate_yoy","occupancy_percent"],"page":1,"per_page":25},"examples":{"Example":{"title":"Example","value":{"account_id":"{account_id}","time_period":"next_12_months","interval":"month","property_filters":{"total_units_gte":100},"fields":["rent_growth_rate_yoy","occupancy_percent"],"page":1,"per_page":25}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"447c0bb9-77fb-4399-afa9-d772eb643a3d":{"description":"Bulk property forecast rows and pagination metadata.","content":{"application/json":{"schema":{"type":"object","description":"Paginated property forecast export results.","properties":{"rows":{"type":"array","items":{"type":"object","description":"Property identity fields plus requested forecast fields for an output period.","properties":{"property_name":{"oneOf":[{"type":"string","description":"Property display name.","isRequired":true,"uniqueKey":"rows.items.[INDEX].property_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Property display name.","isRequired":true,"uniqueKey":"rows.items.[INDEX].property_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rows.items.[INDEX].property_name","typeLabel":"string | null"},"property_id":{"type":"integer","description":"ApartmentIQ property ID.","isRequired":true,"uniqueKey":"rows.items.[INDEX].property_id","typeLabel":"integer"},"management_company_names":{"type":"array","items":{"type":"string","uniqueKey":"rows.items.[INDEX].management_company_names.items.[INDEX]","typeLabel":"string"},"description":"Management company names associated with the property.","isRequired":true,"uniqueKey":"rows.items.[INDEX].management_company_names","typeLabel":"string[]"},"period":{"oneOf":[{"type":"string","description":"Output period for the row. Format is YYYY-MM, YYYY-QN, or YYYY, depending on the requested interval.","isRequired":true,"uniqueKey":"rows.items.[INDEX].period.oneOf.0","typeLabel":"string"},{"type":"null","description":"Output period for the row. Format is YYYY-MM, YYYY-QN, or YYYY, depending on the requested interval.","isRequired":true,"uniqueKey":"rows.items.[INDEX].period.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rows.items.[INDEX].period","typeLabel":"string | null"},"market_name":{"oneOf":[{"type":"string","description":"Primary market for the property, when available.","uniqueKey":"rows.items.[INDEX].market_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Primary market for the property, when available.","uniqueKey":"rows.items.[INDEX].market_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].market_name","typeLabel":"string | null"},"submarket_name":{"oneOf":[{"type":"string","description":"Primary submarket for the property, when available.","uniqueKey":"rows.items.[INDEX].submarket_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Primary submarket for the property, when available.","uniqueKey":"rows.items.[INDEX].submarket_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].submarket_name","typeLabel":"string | null"},"address":{"oneOf":[{"type":"string","description":"Property street address.","uniqueKey":"rows.items.[INDEX].address.oneOf.0","typeLabel":"string"},{"type":"null","description":"Property street address.","uniqueKey":"rows.items.[INDEX].address.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].address","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"Property city.","uniqueKey":"rows.items.[INDEX].city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Property city.","uniqueKey":"rows.items.[INDEX].city.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Property state abbreviation.","uniqueKey":"rows.items.[INDEX].state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Property state abbreviation.","uniqueKey":"rows.items.[INDEX].state.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].state","typeLabel":"string | null"},"zip_code":{"oneOf":[{"type":"string","description":"Property postal code.","uniqueKey":"rows.items.[INDEX].zip_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Property postal code.","uniqueKey":"rows.items.[INDEX].zip_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].zip_code","typeLabel":"string | null"},"latitude":{"oneOf":[{"type":"number","description":"Property latitude, rounded to six decimal places.","uniqueKey":"rows.items.[INDEX].latitude.oneOf.0","typeLabel":"number"},{"type":"null","description":"Property latitude, rounded to six decimal places.","uniqueKey":"rows.items.[INDEX].latitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].latitude","typeLabel":"number | null"},"longitude":{"oneOf":[{"type":"number","description":"Property longitude, rounded to six decimal places.","uniqueKey":"rows.items.[INDEX].longitude.oneOf.0","typeLabel":"number"},{"type":"null","description":"Property longitude, rounded to six decimal places.","uniqueKey":"rows.items.[INDEX].longitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].longitude","typeLabel":"number | null"},"unified_status":{"oneOf":[{"type":"string","description":"Current ApartmentIQ status for the property.","uniqueKey":"rows.items.[INDEX].unified_status.oneOf.0","typeLabel":"string"},{"type":"null","description":"Current ApartmentIQ status for the property.","uniqueKey":"rows.items.[INDEX].unified_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].unified_status","typeLabel":"string | null"},"unit_count":{"oneOf":[{"type":"integer","description":"Known unit count for the property.","uniqueKey":"rows.items.[INDEX].unit_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Known unit count for the property.","uniqueKey":"rows.items.[INDEX].unit_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].unit_count","typeLabel":"integer | null"},"number_of_stories":{"oneOf":[{"type":"number","description":"Known number of stories for the property.","uniqueKey":"rows.items.[INDEX].number_of_stories.oneOf.0","typeLabel":"number"},{"type":"null","description":"Known number of stories for the property.","uniqueKey":"rows.items.[INDEX].number_of_stories.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].number_of_stories","typeLabel":"number | null"},"year_built":{"oneOf":[{"type":"integer","description":"Year the property was built, when known.","uniqueKey":"rows.items.[INDEX].year_built.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Year the property was built, when known.","uniqueKey":"rows.items.[INDEX].year_built.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].year_built","typeLabel":"integer | null"},"year_renovated":{"oneOf":[{"type":"integer","description":"Year the property was renovated, when known.","uniqueKey":"rows.items.[INDEX].year_renovated.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Year the property was renovated, when known.","uniqueKey":"rows.items.[INDEX].year_renovated.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].year_renovated","typeLabel":"integer | null"},"property_class":{"oneOf":[{"type":"string","description":"Property class, when classified.","uniqueKey":"rows.items.[INDEX].property_class.oneOf.0","typeLabel":"string"},{"type":"null","description":"Property class, when classified.","uniqueKey":"rows.items.[INDEX].property_class.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].property_class","typeLabel":"string | null"},"property_type":{"oneOf":[{"type":"string","description":"Property type, when classified.","uniqueKey":"rows.items.[INDEX].property_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Property type, when classified.","uniqueKey":"rows.items.[INDEX].property_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].property_type","typeLabel":"string | null"},"ownership_company_names":{"type":"array","items":{"type":"string","uniqueKey":"rows.items.[INDEX].ownership_company_names.items.[INDEX]","typeLabel":"string"},"description":"Ownership company names associated with the property. Returned only when your account has access to owner data.","uniqueKey":"rows.items.[INDEX].ownership_company_names","typeLabel":"string[]"},"rent_growth_rate_yoy":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_rate_yoy.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_rate_yoy.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_rate_yoy","typeLabel":"number | null"},"rent_growth_rate_yoy_downside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_rate_yoy_downside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_rate_yoy_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_rate_yoy_downside","typeLabel":"number | null"},"rent_growth_rate_yoy_upside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_rate_yoy_upside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_rate_yoy_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_rate_yoy_upside","typeLabel":"number | null"},"occupancy_percent":{"oneOf":[{"type":"number","description":"Forecasted occupancy percentage. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].occupancy_percent.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted occupancy percentage. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].occupancy_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].occupancy_percent","typeLabel":"number | null"},"occupancy_percent_downside":{"oneOf":[{"type":"number","description":"Forecasted occupancy percentage downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].occupancy_percent_downside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted occupancy percentage downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].occupancy_percent_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].occupancy_percent_downside","typeLabel":"number | null"},"occupancy_percent_upside":{"oneOf":[{"type":"number","description":"Forecasted occupancy percentage upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].occupancy_percent_upside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted occupancy percentage upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].occupancy_percent_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].occupancy_percent_upside","typeLabel":"number | null"}},"required":["property_name","property_id","management_company_names","period"],"additionalProperties":false,"uniqueKey":"rows.items.[INDEX]","typeLabel":"object"},"description":"Property forecast rows for the matched properties on the current page. Each matched property is expanded into one row per interval period, so the number of rows returned can be greater than the per_page value. Each row includes property identity fields, an output period, and any requested forecast fields.","isRequired":true,"uniqueKey":"rows","typeLabel":"object[]"},"pagination":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number in the result set.","isRequired":true,"uniqueKey":"pagination.current_page","typeLabel":"integer"},"total_pages":{"type":"integer","description":"Total number of pages available for the request.","isRequired":true,"uniqueKey":"pagination.total_pages","typeLabel":"integer"},"total_count":{"type":"integer","description":"Total number of matching records across all pages.","isRequired":true,"uniqueKey":"pagination.total_count","typeLabel":"integer"},"per_page":{"type":"integer","description":"Maximum number of records returned per page.","isRequired":true,"uniqueKey":"pagination.per_page","typeLabel":"integer"}},"required":["current_page","total_pages","total_count","per_page"],"additionalProperties":false,"description":"Pagination details for matched properties, not the expanded interval-period rows.","isRequired":true,"uniqueKey":"pagination","typeLabel":"object"}},"required":["rows","pagination"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"rows":[{"property_name":"The Livingston","market_name":"Madison, WI Metro Area","submarket_name":"Downtown Madison","property_id":781245,"address":"1025 E Washington Ave","city":"Madison","state":"WI","zip_code":"53703","latitude":43.0836,"longitude":-89.3723,"unified_status":"stabilized","unit_count":186,"number_of_stories":6,"year_built":2018,"year_renovated":null,"property_class":"A","property_type":"Multifamily","management_company_names":["Northstar Residential"],"ownership_company_names":["Lakeview Multifamily Fund"],"period":"2026-07","rent_growth_rate_yoy":0.0312,"rent_growth_rate_yoy_downside":0.0175,"rent_growth_rate_yoy_upside":0.0468,"occupancy_percent":0.9412,"occupancy_percent_downside":0.9224,"occupancy_percent_upside":0.9588},{"property_name":"Summit Row","market_name":"Madison, WI Metro Area","submarket_name":"West Madison","property_id":781266,"address":"711 Junction Rd","city":"Madison","state":"WI","zip_code":"53717","latitude":43.0719,"longitude":-89.5264,"unified_status":"lease_up","unit_count":244,"number_of_stories":5,"year_built":2024,"year_renovated":null,"property_class":"A","property_type":"Multifamily","management_company_names":["Crescent Urban Living"],"ownership_company_names":[],"period":"2026-08","rent_growth_rate_yoy":null,"rent_growth_rate_yoy_downside":null,"rent_growth_rate_yoy_upside":null,"occupancy_percent":0.8721,"occupancy_percent_downside":0.8365,"occupancy_percent_upside":0.9018}],"pagination":{"current_page":1,"total_pages":4,"total_count":100,"per_page":25}},"examples":{"Example":{"title":"Example","value":{"rows":[{"property_name":"The Livingston","market_name":"Madison, WI Metro Area","submarket_name":"Downtown Madison","property_id":781245,"address":"1025 E Washington Ave","city":"Madison","state":"WI","zip_code":"53703","latitude":43.0836,"longitude":-89.3723,"unified_status":"stabilized","unit_count":186,"number_of_stories":6,"year_built":2018,"year_renovated":null,"property_class":"A","property_type":"Multifamily","management_company_names":["Northstar Residential"],"ownership_company_names":["Lakeview Multifamily Fund"],"period":"2026-07","rent_growth_rate_yoy":0.0312,"rent_growth_rate_yoy_downside":0.0175,"rent_growth_rate_yoy_upside":0.0468,"occupancy_percent":0.9412,"occupancy_percent_downside":0.9224,"occupancy_percent_upside":0.9588},{"property_name":"Summit Row","market_name":"Madison, WI Metro Area","submarket_name":"West Madison","property_id":781266,"address":"711 Junction Rd","city":"Madison","state":"WI","zip_code":"53717","latitude":43.0719,"longitude":-89.5264,"unified_status":"lease_up","unit_count":244,"number_of_stories":5,"year_built":2024,"year_renovated":null,"property_class":"A","property_type":"Multifamily","management_company_names":["Crescent Urban Living"],"ownership_company_names":[],"period":"2026-08","rent_growth_rate_yoy":null,"rent_growth_rate_yoy_downside":null,"rent_growth_rate_yoy_upside":null,"occupancy_percent":0.8721,"occupancy_percent_downside":0.8365,"occupancy_percent_upside":0.9018}],"pagination":{"current_page":1,"total_pages":4,"total_count":100,"per_page":25}}}},"exampleType":"examples"}},"exampleType":"examples"},"c3b36795-fa6a-438d-859a-f956ad7f82e9":{"description":"The request was invalid or malformed.","content":{"application/json":{"schema":{"type":"object","description":"Error response payload.","properties":{"error":{"type":"string","description":"Short error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Additional error details, when available.","uniqueKey":"message","typeLabel":"string"},"quota_limit":{"type":"integer","description":"Quota limit that applied to the request, when relevant.","uniqueKey":"quota_limit","typeLabel":"integer"},"quota_usage":{"type":"integer","description":"Quota already used, when relevant.","uniqueKey":"quota_usage","typeLabel":"integer"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","quota_limit":123,"quota_usage":123}}},"exampleType":"generated"}},"exampleType":"generated"},"caad415a-eed5-4487-9343-3fbef217b55a":{"description":"Unauthorized - Invalid or missing authentication.","content":{"application/json":{"schema":{"type":"object","description":"Error response payload.","properties":{"error":{"type":"string","description":"Short error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Additional error details, when available.","uniqueKey":"message","typeLabel":"string"},"quota_limit":{"type":"integer","description":"Quota limit that applied to the request, when relevant.","uniqueKey":"quota_limit","typeLabel":"integer"},"quota_usage":{"type":"integer","description":"Quota already used, when relevant.","uniqueKey":"quota_usage","typeLabel":"integer"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","quota_limit":123,"quota_usage":123}}},"exampleType":"generated"}},"exampleType":"generated"},"10e8e428-abaf-47c5-99a5-c08571ac0a91":{"description":"Forbidden - The user lacks account access, Explore Pro access, or remaining bulk export quota.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"39c5b752-8b21-4302-a12c-12060c74d11d":{"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","uniqueKey":"","typeLabel":"string"},"example":"You have exceeded the rate limit for this API.\n","examples":{"Example":{"title":"Example","value":"You have exceeded the rate limit for this API.\n"}},"exampleType":"examples"}},"exampleType":"examples"},"8b13464a-8fea-4da8-a4fa-efc2879bba73":{"description":"An unexpected error occurred while processing the request.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"3efcaff5-2dc6-4d5d-bb85-05579ed7f33d":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"def266db-b426-422c-8a18-ce77be7a68b8":{"url":"https://data.apartmentiq.io/apartmentiq/api/v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/v2/schema.json"},"subdomain":"apartmentiq-c1886649","siteName":"ApartmentIQ API","title":"Bulk Property Forecasts - ApartmentIQ API","navMaps":{"firstHrefInVersion":{"API Version: 1":{"href":"/api-reference/accounts/list-accounts","matchLevel":2},"API Version: 2 (Preview)":{"href":"/v2/api-reference/bulk/bulk-property-forecasts","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T16:34:09.288Z","originalFileLocation":"v2/api-reference/bulk/bulk-property-forecasts.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=\"Retrieve bulk property forecast rows using optional property filters, requested forecast fields, and pagination. Requires Explore Pro access and consumes property bulk export quota.\">\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=\"Bulk Property Forecasts - ApartmentIQ API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve bulk property forecast rows using optional property filters, requested forecast fields, and pagination. Requires Explore Pro access and consumes property bulk export quota.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ApartmentIQ API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-property-forecasts\">\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=Bulk\u0026amp;title=Bulk+Property+Forecasts\u0026amp;description=Retrieve+bulk+property+forecast+rows+using+optional+property+filters%2C+requested+forecast+fields%2C+and+pagination.%0A%0A%3CWarning%3ERequires+Explore+Pro+access+and+consu\u0026amp;theme=dc0e3ba1149aaeec6590ba45\u0026amp;signature=e21ac7c715a27c540f1f90b3a28cf80321a3d1ff5033c67f765a0f0b7fff7f48\">\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=\"Bulk Property Forecasts - ApartmentIQ API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve bulk property forecast rows using optional property filters, requested forecast fields, and pagination. Requires Explore Pro access and consumes property bulk export quota.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://apartmentiq-c1886649.mintlify.site/_mintlify/api/og/v2?division=Bulk\u0026amp;title=Bulk+Property+Forecasts\u0026amp;description=Retrieve+bulk+property+forecast+rows+using+optional+property+filters%2C+requested+forecast+fields%2C+and+pagination.%0A%0A%3CWarning%3ERequires+Explore+Pro+access+and+consu\u0026amp;theme=dc0e3ba1149aaeec6590ba45\u0026amp;signature=e21ac7c715a27c540f1f90b3a28cf80321a3d1ff5033c67f765a0f0b7fff7f48\">\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/v2/api-reference/bulk/bulk-property-forecasts\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/api-reference/bulk/bulk-property-forecasts.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/v2/api-reference/bulk/bulk-property-forecasts#webpage\",\"url\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-property-forecasts\",\"name\":\"Bulk Property Forecasts\",\"description\":\"Retrieve bulk property forecast rows using optional property filters, requested forecast fields, and pagination. Requires Explore Pro access and consumes property bulk export quota.\",\"dateModified\":\"2026-11-03T16:34:09.288Z\",\"isPartOf\":{\"@id\":\"https://developers.apartmentiq.io#website\"},\"breadcrumb\":{\"@id\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-property-forecasts#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-property-forecasts#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://developers.apartmentiq.io/v2/api-reference/accounts/list-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Bulk\",\"item\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-properties\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Bulk Property Forecasts\",\"item\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-property-forecasts\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-property-forecasts#apireference\",\"headline\":\"Bulk Property Forecasts\",\"name\":\"Bulk Property Forecasts\",\"description\":\"Retrieve bulk property forecast rows using optional property filters, requested forecast fields, and pagination. Requires Explore Pro access and consumes property bulk export quota.\",\"url\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-property-forecasts\",\"mainEntityOfPage\":{\"@id\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-property-forecasts#webpage\"},\"dateModified\":\"2026-11-03T16:34:09.288Z\",\"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":"/v2/api-reference/bulk/bulk-property-forecasts.md","siteName":"ApartmentIQ API","nav":{"global":{},"versions":[{"version":"API Version: 1","pages":[{"title":"API Version: 1","href":"/api-reference/accounts/list-accounts"}]},{"version":"API Version: 2 (Preview)","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/v2"},{"title":"Getting Started","href":"/v2/getting-started"},{"title":"Key Terms","href":"/v2/key-terms"},{"title":"Authentication","href":"/v2/authentication"},{"title":"Rate Limits","href":"/v2/rate-limits"},{"title":"Errors","href":"/v2/errors"},{"title":"Changelog","href":"/changelog/v2"}]},{"group":"API Reference","expanded":true,"pages":[{"group":"Accounts","expanded":true,"pages":[{"title":"List Accounts","deprecated":null,"version":null,"sidebarTitle":"List accounts","openapi":"/openapi/v2/schema.json get /accounts","href":"/v2/api-reference/accounts/list-accounts"}]},{"group":"Amenities","expanded":true,"pages":[{"title":"List Amenities","deprecated":null,"version":null,"sidebarTitle":"List amenities","openapi":"/openapi/v2/schema.json get /amenities","href":"/v2/api-reference/amenities/list-amenities"}]},{"group":"Properties","expanded":true,"pages":[{"title":"Search Properties","deprecated":null,"version":null,"sidebarTitle":"Search properties","openapi":"/openapi/v2/schema.json post /properties/search","href":"/v2/api-reference/properties/search-properties"}]},{"group":"Market Surveys","expanded":true,"pages":[{"title":"Suggest Comps","deprecated":null,"version":null,"sidebarTitle":"Suggest comps","openapi":"/openapi/v2/schema.json get /properties/{property_id}/comp_suggestions","href":"/v2/api-reference/market-surveys/suggest-comps"},{"title":"Create Market Survey","deprecated":null,"version":null,"sidebarTitle":"Create market survey","openapi":"/openapi/v2/schema.json post /market_surveys","href":"/v2/api-reference/market-surveys/create-market-survey"},{"title":"Create Research Report","deprecated":null,"version":null,"sidebarTitle":"Create research report","openapi":"/openapi/v2/schema.json post /research_reports","href":"/v2/api-reference/market-surveys/create-research-report"},{"title":"Replace Comps","deprecated":null,"version":null,"sidebarTitle":"Replace comps","openapi":"/openapi/v2/schema.json put /comp_sets/{comp_set_id}/comps","href":"/v2/api-reference/market-surveys/replace-comps"},{"title":"Update Comp Set","deprecated":null,"version":null,"sidebarTitle":"Update comp set","openapi":"/openapi/v2/schema.json patch /comp_sets/{comp_set_id}","href":"/v2/api-reference/market-surveys/update-comp-set"}]},{"group":"Markets","expanded":true,"pages":[{"title":"Search Geo Boundaries","deprecated":null,"version":null,"sidebarTitle":"Search geo boundaries","openapi":"/openapi/v2/schema.json post /geo_boundaries/search","href":"/v2/api-reference/markets/search-geo-boundaries"}]},{"group":"Organizations","expanded":true,"pages":[{"title":"Search Organizations","deprecated":null,"version":null,"sidebarTitle":"Search organizations","openapi":"/openapi/v2/schema.json post /stakeholder_entities/search","href":"/v2/api-reference/organizations/search-organizations"},{"title":"Get Organization Details","deprecated":null,"version":null,"sidebarTitle":"Get organization details","openapi":"/openapi/v2/schema.json get /stakeholder_entities/{stakeholder_entity_id}/details","href":"/v2/api-reference/organizations/get-organization-details"},{"title":"List Organization People","deprecated":null,"version":null,"sidebarTitle":"List organization people","openapi":"/openapi/v2/schema.json get /stakeholder_entities/{stakeholder_entity_id}/people","href":"/v2/api-reference/organizations/list-organization-people"},{"title":"List Organization Properties","deprecated":null,"version":null,"sidebarTitle":"List organization properties","openapi":"/openapi/v2/schema.json post /stakeholder_entities/{stakeholder_entity_id}/properties","href":"/v2/api-reference/organizations/list-organization-properties"}]},{"group":"Bulk","expanded":true,"pages":[{"title":"Bulk Properties","deprecated":null,"version":null,"sidebarTitle":"Bulk properties","openapi":"/openapi/v2/schema.json post /properties/bulk","href":"/v2/api-reference/bulk/bulk-properties"},{"title":"Bulk Properties Quota Impact","deprecated":null,"version":null,"sidebarTitle":"Bulk properties quota impact","openapi":"/openapi/v2/schema.json post /properties/bulk/quota_impact","href":"/v2/api-reference/bulk/bulk-properties-quota-impact"},{"title":"Bulk Markets","deprecated":null,"version":null,"sidebarTitle":"Bulk markets","openapi":"/openapi/v2/schema.json post /markets/bulk","href":"/v2/api-reference/bulk/bulk-markets"},{"title":"Bulk Organizations","description":"Retrieve bulk organization rows using optional organization and property filters, requested fields, and pagination.\n\nCount fields use the latest indexed property data. The `collected_at_gte` and `collected_at_lte` filters do not change these values. If you request an interval, each interval row contains the same current count values.\n\n\u003cWarning>Requires Explore Pro Plus access.\u003c/Warning>","deprecated":null,"version":null,"sidebarTitle":"Bulk organizations","openapi":"/openapi/v2/schema.json post /stakeholder_entities/bulk","href":"/v2/api-reference/bulk/bulk-organizations"},{"title":"Bulk Property Forecasts","deprecated":null,"version":null,"sidebarTitle":"Bulk property forecasts","openapi":"/openapi/v2/schema.json post /properties/bulk_forecasts","href":"/v2/api-reference/bulk/bulk-property-forecasts"},{"title":"Bulk Market Forecasts","description":"Retrieve bulk market forecast rows for geographic boundaries using optional geography filters, requested forecast fields, and pagination.\n\n\u003cWarning>Requires Explore Pro access.\u003c/Warning>\n\n\u003cNote>`property_filters` and `filters` are not supported.\u003c/Note>","deprecated":null,"version":null,"sidebarTitle":"Bulk market forecasts","openapi":"/openapi/v2/schema.json post /markets/bulk_forecasts","href":"/v2/api-reference/bulk/bulk-market-forecasts"}]},{"group":"Datasets","expanded":true,"pages":[{"title":"Download Dataset","deprecated":null,"version":null,"sidebarTitle":"Download dataset","openapi":"/openapi/v2/schema.json post /datasets/download","href":"/v2/api-reference/datasets/download-dataset"}]}]}]}]},"basePath":"","title":"Bulk Property Forecasts - ApartmentIQ API","deploymentId":"dpl_7AgmPo2RyRWZ68ZGceW618SWGEAz","buildId":"dpl_7AgmPo2RyRWZ68ZGceW618SWGEAz","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-wzXgrCiA.js","snippetPresets-Ctn0LgL5.js","utils-knxdv-fi.js","style-to-object-BY3JEAdk.js","utils-Szn2cJIN.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CYggQ38U.js","conditional-requirements-CFM0id0Q.js","cloneDeep-a_SFy_bM.js","_Uint8Array-CYON-SEw.js","isObject-FP1Yky1u.js","ApiExamples-Bp2XNIJ2.js","usePlaygroundInputsStore-Bv5ea2yO.js","shallow-BeX-jZPB.js","isEqual-DiyXA5rL.js","CodeSnippets-DXnnQSz3.js","CodeSnippet-Ba_bs1zd.js","getApiPlaygroundDisplay-D0IrdxIN.js","Page-Dn3dap3J.js","DynamicMarkdown-T8UDalrO.js","SectionHeading-DANTRrnD.js","icon-Mqg-z9_o.js","MethodPill-gS6fR7OH.js","getPastedJson-B3wZ4biI.js","Check2Icon-BT0wGl3r.js","axios-CsQoIw0U.js","Markdown-DUz08Fig.js","AssistantPageLink-D3sNlIci.js","dist-BbIWfytJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}