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 market row.
Available options:
rent_growth_yoy,
rent_growth_yoy_downside,
rent_growth_yoy_upside,
rent_growth_yoy_bed_0,
rent_growth_yoy_bed_0_downside,
rent_growth_yoy_bed_0_upside,
rent_growth_yoy_bed_1,
rent_growth_yoy_bed_1_downside,
rent_growth_yoy_bed_1_upside,
rent_growth_yoy_bed_2,
rent_growth_yoy_bed_2_downside,
rent_growth_yoy_bed_2_upside,
rent_growth_yoy_bed_3,
rent_growth_yoy_bed_3_downside,
rent_growth_yoy_bed_3_upside,
rent_growth_yoy_class_a,
rent_growth_yoy_class_a_downside,
rent_growth_yoy_class_a_upside,
rent_growth_yoy_class_b,
rent_growth_yoy_class_b_downside,
rent_growth_yoy_class_b_upside,
rent_growth_yoy_class_c,
rent_growth_yoy_class_c_downside,
rent_growth_yoy_class_c_upside,
occupancy,
occupancy_downside,
occupancy_upside,
absorption,
absorption_downside,
absorption_upside,
deliveries,
deliveries_downside,
deliveries_upside
geo_filters
object
Market selection filters. Omit to page through all supported market boundaries.
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 markets per page. Values above 100 are capped at 100. Interval-based rows expand each matched market into one row per period, so the number of rows returned can be greater than per_page.
Required range: 1 <= x <= 100
Response
Bulk market forecast rows and pagination metadata.
Paginated market forecast export results.
rows
object[]
required
Market forecast rows for the matched markets on the current page. Each matched market 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 market identity fields, an output period, and any requested forecast fields.
Show child attributes
pagination
object
required
Pagination details for matched markets, 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-market-forecasts","slug":"/v2/api-reference/bulk/bulk-market-forecasts","pageMetadata":{"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","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 code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n }, {Note, Warning} = _components;\n if (!Note) _missingMdxReference(\"Note\", true);\n if (!Warning) _missingMdxReference(\"Warning\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve bulk market forecast rows for geographic boundaries using optional geography filters, requested forecast fields, and pagination.\"\n }), \"\\n\", _jsx(Warning, {\n children: \"Requires Explore Pro access.\"\n }), \"\\n\", _jsxs(Note, {\n children: [_jsx(_components.code, {\n children: \"property_filters\"\n }), \" and \", _jsx(_components.code, {\n children: \"filters\"\n }), \" are not supported.\"]\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 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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Bulk"],"summary":"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>","operationId":"createV2MarketsBulkForecasts","requestBody":"5a4187b6-b3e2-44ca-bccb-e10c57dcdded","responses":{"200":"6a90c610-b375-44bd-b396-5a31249a81a9","400":"4fb759d1-d325-4a12-a950-6f466ee1900a","401":"1687b29c-f31b-4381-932d-490c42c24752","403":"0c658722-cdf1-428d-85e0-aab94798c2bc","429":"a4351a68-2b40-4afb-9fae-f77abc099ad2","500":"d4d9f4ae-5683-4fb2-b21c-34a29902c0b5"},"x-mint":{"href":"/v2/api-reference/bulk/bulk-market-forecasts"},"method":"post","type":"path","servers":["def266db-b426-422c-8a18-ce77be7a68b8"],"security":["3efcaff5-2dc6-4d5d-bb85-05579ed7f33d"],"path":"/markets/bulk_forecasts","baseUrlOptions":["https://data.apartmentiq.io/apartmentiq/api/v2"],"title":"Bulk Market 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_yoy","rent_growth_yoy_downside","rent_growth_yoy_upside","rent_growth_yoy_bed_0","rent_growth_yoy_bed_0_downside","rent_growth_yoy_bed_0_upside","rent_growth_yoy_bed_1","rent_growth_yoy_bed_1_downside","rent_growth_yoy_bed_1_upside","rent_growth_yoy_bed_2","rent_growth_yoy_bed_2_downside","rent_growth_yoy_bed_2_upside","rent_growth_yoy_bed_3","rent_growth_yoy_bed_3_downside","rent_growth_yoy_bed_3_upside","rent_growth_yoy_class_a","rent_growth_yoy_class_a_downside","rent_growth_yoy_class_a_upside","rent_growth_yoy_class_b","rent_growth_yoy_class_b_downside","rent_growth_yoy_class_b_upside","rent_growth_yoy_class_c","rent_growth_yoy_class_c_downside","rent_growth_yoy_class_c_upside","occupancy","occupancy_downside","occupancy_upside","absorption","absorption_downside","absorption_upside","deliveries","deliveries_downside","deliveries_upside"],"uniqueKey":"fields.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueItems":true,"description":"Forecast metric field names to include in each market row.","uniqueKey":"fields","typeLabel":"enum\u003cstring>[]"},"geo_filters":{"type":"object","description":"Market selection filters. Omit to page through all supported market boundaries.","properties":{"geo_boundary_ids":{"type":"array","items":{"oneOf":[{"type":"integer","uniqueKey":"geo_filters.geo_boundary_ids.items.[INDEX].oneOf.0","typeLabel":"integer"},{"type":"string","uniqueKey":"geo_filters.geo_boundary_ids.items.[INDEX].oneOf.1","typeLabel":"string"}],"uniqueKey":"geo_filters.geo_boundary_ids.items.[INDEX]","typeLabel":"integer | string"},"description":"Specific geo boundary IDs to include.","uniqueKey":"geo_filters.geo_boundary_ids","typeLabel":"(integer | string)[]"},"inside_geo_boundary_ids":{"type":"array","items":{"oneOf":[{"type":"integer","uniqueKey":"geo_filters.inside_geo_boundary_ids.items.[INDEX].oneOf.0","typeLabel":"integer"},{"type":"string","uniqueKey":"geo_filters.inside_geo_boundary_ids.items.[INDEX].oneOf.1","typeLabel":"string"}],"uniqueKey":"geo_filters.inside_geo_boundary_ids.items.[INDEX]","typeLabel":"integer | string"},"description":"Geo boundaries whose linked children should be included. A child is linked to every boundary it intersects or borders, so a submarket at the edge of one MSA is also included under the neighboring MSA.","uniqueKey":"geo_filters.inside_geo_boundary_ids","typeLabel":"(integer | string)[]"},"geo_types":{"type":"array","items":{"type":"string","enum":["Custom","MSA","BespokeSubmarket","CensusPlace","Neighborhood","County","ZipCode","State"],"uniqueKey":"geo_filters.geo_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Frontend geo types to include. Valid values: `Custom`, `MSA`, `BespokeSubmarket`, `CensusPlace`, `Neighborhood`, `County`, `ZipCode`, `State`.","uniqueKey":"geo_filters.geo_types","typeLabel":"enum\u003cstring>[]"}},"additionalProperties":false,"uniqueKey":"geo_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 markets per page. Values above 100 are capped at 100. Interval-based rows expand each matched market 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":"quarter","geo_filters":{"geo_types":["MSA"]},"fields":["rent_growth_yoy","occupancy"],"page":1,"per_page":25},"examples":{"Example":{"title":"Example","value":{"account_id":"{account_id}","time_period":"next_12_months","interval":"quarter","geo_filters":{"geo_types":["MSA"]},"fields":["rent_growth_yoy","occupancy"],"page":1,"per_page":25}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"6a90c610-b375-44bd-b396-5a31249a81a9":{"description":"Bulk market forecast rows and pagination metadata.","content":{"application/json":{"schema":{"type":"object","description":"Paginated market forecast export results.","properties":{"rows":{"type":"array","items":{"type":"object","description":"Market identity fields plus requested forecast fields for an output period.","properties":{"name":{"type":"string","description":"Display name for the market or geography.","isRequired":true,"uniqueKey":"rows.items.[INDEX].name","typeLabel":"string"},"geo_boundary_id":{"type":"integer","description":"ApartmentIQ geo-boundary ID for the market row.","isRequired":true,"uniqueKey":"rows.items.[INDEX].geo_boundary_id","typeLabel":"integer"},"geo_type":{"type":"string","description":"ApartmentIQ geography type, such as MSA, Submarket, Zip, or Custom.","isRequired":true,"uniqueKey":"rows.items.[INDEX].geo_type","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"},"msa_name":{"oneOf":[{"type":"string","description":"Names of the MSAs, including Micro Areas, whose boundaries intersect or border the market, joined with `; `. A market next to another metro lists more than one, and the first name listed is not the primary MSA. Returned for non-MSA market rows when available.","uniqueKey":"rows.items.[INDEX].msa_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Names of the MSAs, including Micro Areas, whose boundaries intersect or border the market, joined with `; `. A market next to another metro lists more than one, and the first name listed is not the primary MSA. Returned for non-MSA market rows when available.","uniqueKey":"rows.items.[INDEX].msa_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].msa_name","typeLabel":"string | null"},"submarket_name":{"oneOf":[{"type":"string","description":"Names of the submarkets whose boundaries intersect or border the zip code, joined with `; `; the first name listed is not the primary submarket. Returned for zip code market rows when available.","uniqueKey":"rows.items.[INDEX].submarket_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Names of the submarkets whose boundaries intersect or border the zip code, joined with `; `; the first name listed is not the primary submarket. Returned for zip code market rows when available.","uniqueKey":"rows.items.[INDEX].submarket_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].submarket_name","typeLabel":"string | null"},"rent_growth_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_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_yoy.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy","typeLabel":"number | null"},"rent_growth_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_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_yoy_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_downside","typeLabel":"number | null"},"rent_growth_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_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_yoy_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_upside","typeLabel":"number | null"},"rent_growth_yoy_bed_0":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for studio units. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_0.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for studio units. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_0.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_0","typeLabel":"number | null"},"rent_growth_yoy_bed_0_downside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for studio units downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_0_downside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for studio units downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_0_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_0_downside","typeLabel":"number | null"},"rent_growth_yoy_bed_0_upside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for studio units upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_0_upside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for studio units upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_0_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_0_upside","typeLabel":"number | null"},"rent_growth_yoy_bed_1":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for one-bedroom units. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_1.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for one-bedroom units. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_1.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_1","typeLabel":"number | null"},"rent_growth_yoy_bed_1_downside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for one-bedroom units downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_1_downside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for one-bedroom units downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_1_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_1_downside","typeLabel":"number | null"},"rent_growth_yoy_bed_1_upside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for one-bedroom units upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_1_upside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for one-bedroom units upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_1_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_1_upside","typeLabel":"number | null"},"rent_growth_yoy_bed_2":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for two-bedroom units. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_2.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for two-bedroom units. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_2","typeLabel":"number | null"},"rent_growth_yoy_bed_2_downside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for two-bedroom units downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_2_downside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for two-bedroom units downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_2_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_2_downside","typeLabel":"number | null"},"rent_growth_yoy_bed_2_upside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for two-bedroom units upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_2_upside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for two-bedroom units upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_2_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_2_upside","typeLabel":"number | null"},"rent_growth_yoy_bed_3":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for three-bedroom units. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_3.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for three-bedroom units. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_3.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_3","typeLabel":"number | null"},"rent_growth_yoy_bed_3_downside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for three-bedroom units downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_3_downside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for three-bedroom units downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_3_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_3_downside","typeLabel":"number | null"},"rent_growth_yoy_bed_3_upside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for three-bedroom units upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_3_upside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for three-bedroom units upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_3_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_bed_3_upside","typeLabel":"number | null"},"rent_growth_yoy_class_a":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for Class A properties. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_a.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for Class A properties. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_a.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_a","typeLabel":"number | null"},"rent_growth_yoy_class_a_downside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for Class A properties downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_a_downside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for Class A properties downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_a_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_a_downside","typeLabel":"number | null"},"rent_growth_yoy_class_a_upside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for Class A properties upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_a_upside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for Class A properties upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_a_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_a_upside","typeLabel":"number | null"},"rent_growth_yoy_class_b":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for Class B properties. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_b.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for Class B properties. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_b.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_b","typeLabel":"number | null"},"rent_growth_yoy_class_b_downside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for Class B properties downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_b_downside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for Class B properties downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_b_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_b_downside","typeLabel":"number | null"},"rent_growth_yoy_class_b_upside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for Class B properties upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_b_upside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for Class B properties upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_b_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_b_upside","typeLabel":"number | null"},"rent_growth_yoy_class_c":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for Class C properties. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_c.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for Class C properties. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_c.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_c","typeLabel":"number | null"},"rent_growth_yoy_class_c_downside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for Class C properties downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_c_downside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for Class C properties downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_c_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_c_downside","typeLabel":"number | null"},"rent_growth_yoy_class_c_upside":{"oneOf":[{"type":"number","description":"Forecasted year-over-year asking rent growth rate for Class C properties upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_c_upside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted year-over-year asking rent growth rate for Class C properties upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_c_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].rent_growth_yoy_class_c_upside","typeLabel":"number | null"},"occupancy":{"oneOf":[{"type":"number","description":"Forecasted occupancy percentage. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].occupancy.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted occupancy percentage. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].occupancy.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].occupancy","typeLabel":"number | null"},"occupancy_downside":{"oneOf":[{"type":"number","description":"Forecasted occupancy percentage downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].occupancy_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_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].occupancy_downside","typeLabel":"number | null"},"occupancy_upside":{"oneOf":[{"type":"number","description":"Forecasted occupancy percentage upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].occupancy_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_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].occupancy_upside","typeLabel":"number | null"},"absorption":{"oneOf":[{"type":"number","description":"Forecasted absorbed unit count. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].absorption.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted absorbed unit count. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].absorption.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].absorption","typeLabel":"number | null"},"absorption_downside":{"oneOf":[{"type":"number","description":"Forecasted absorbed unit count downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].absorption_downside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted absorbed unit count downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].absorption_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].absorption_downside","typeLabel":"number | null"},"absorption_upside":{"oneOf":[{"type":"number","description":"Forecasted absorbed unit count upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].absorption_upside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted absorbed unit count upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].absorption_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].absorption_upside","typeLabel":"number | null"},"deliveries":{"oneOf":[{"type":"number","description":"Forecasted delivered unit count. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].deliveries.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted delivered unit count. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].deliveries.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].deliveries","typeLabel":"number | null"},"deliveries_downside":{"oneOf":[{"type":"number","description":"Forecasted delivered unit count downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].deliveries_downside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted delivered unit count downside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].deliveries_downside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].deliveries_downside","typeLabel":"number | null"},"deliveries_upside":{"oneOf":[{"type":"number","description":"Forecasted delivered unit count upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].deliveries_upside.oneOf.0","typeLabel":"number"},{"type":"null","description":"Forecasted delivered unit count upside scenario. Returned when requested; null when forecast data is unavailable.","uniqueKey":"rows.items.[INDEX].deliveries_upside.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].deliveries_upside","typeLabel":"number | null"}},"required":["name","geo_boundary_id","geo_type","period"],"additionalProperties":false,"uniqueKey":"rows.items.[INDEX]","typeLabel":"object"},"description":"Market forecast rows for the matched markets on the current page. Each matched market 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 market 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 markets, not the expanded interval-period rows.","isRequired":true,"uniqueKey":"pagination","typeLabel":"object"}},"required":["rows","pagination"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"rows":[{"name":"Madison, WI Metro Area","geo_boundary_id":4127,"geo_type":"MSA","msa_name":null,"submarket_name":null,"period":"2026-Q3","rent_growth_yoy":0.0211,"rent_growth_yoy_downside":0.0098,"rent_growth_yoy_upside":0.0342,"rent_growth_yoy_bed_0":0.0184,"rent_growth_yoy_bed_0_downside":0.0065,"rent_growth_yoy_bed_0_upside":0.031,"rent_growth_yoy_bed_1":0.0202,"rent_growth_yoy_bed_1_downside":0.0089,"rent_growth_yoy_bed_1_upside":0.0331,"rent_growth_yoy_bed_2":0.0237,"rent_growth_yoy_bed_2_downside":0.0114,"rent_growth_yoy_bed_2_upside":0.0376,"rent_growth_yoy_bed_3":0.0196,"rent_growth_yoy_bed_3_downside":0.0071,"rent_growth_yoy_bed_3_upside":0.0324,"rent_growth_yoy_class_a":0.0252,"rent_growth_yoy_class_a_downside":0.0128,"rent_growth_yoy_class_a_upside":0.0394,"rent_growth_yoy_class_b":0.0201,"rent_growth_yoy_class_b_downside":0.0087,"rent_growth_yoy_class_b_upside":0.0322,"rent_growth_yoy_class_c":0.0157,"rent_growth_yoy_class_c_downside":0.0038,"rent_growth_yoy_class_c_upside":0.0289,"occupancy":0.9433,"occupancy_downside":0.9275,"occupancy_upside":0.9581,"absorption":148,"absorption_downside":96,"absorption_upside":201,"deliveries":132,"deliveries_downside":74,"deliveries_upside":186},{"name":"Downtown Madison","geo_boundary_id":90114,"geo_type":"Submarket","msa_name":"Madison, WI Metro Area","submarket_name":null,"period":"2026-Q3","rent_growth_yoy":0.0289,"rent_growth_yoy_downside":0.0142,"rent_growth_yoy_upside":0.0441,"rent_growth_yoy_bed_0":0.0251,"rent_growth_yoy_bed_0_downside":0.0107,"rent_growth_yoy_bed_0_upside":0.0402,"rent_growth_yoy_bed_1":0.0278,"rent_growth_yoy_bed_1_downside":0.0131,"rent_growth_yoy_bed_1_upside":0.0435,"rent_growth_yoy_bed_2":0.0314,"rent_growth_yoy_bed_2_downside":0.0168,"rent_growth_yoy_bed_2_upside":0.0479,"rent_growth_yoy_bed_3":null,"rent_growth_yoy_bed_3_downside":null,"rent_growth_yoy_bed_3_upside":null,"rent_growth_yoy_class_a":0.0335,"rent_growth_yoy_class_a_downside":0.0188,"rent_growth_yoy_class_a_upside":0.0502,"rent_growth_yoy_class_b":0.0246,"rent_growth_yoy_class_b_downside":0.0104,"rent_growth_yoy_class_b_upside":0.0395,"rent_growth_yoy_class_c":null,"rent_growth_yoy_class_c_downside":null,"rent_growth_yoy_class_c_upside":null,"occupancy":0.9504,"occupancy_downside":0.9312,"occupancy_upside":0.9648,"absorption":32,"absorption_downside":18,"absorption_upside":47,"deliveries":24,"deliveries_downside":0,"deliveries_upside":42}],"pagination":{"current_page":1,"total_pages":4,"total_count":100,"per_page":25}},"examples":{"Example":{"title":"Example","value":{"rows":[{"name":"Madison, WI Metro Area","geo_boundary_id":4127,"geo_type":"MSA","msa_name":null,"submarket_name":null,"period":"2026-Q3","rent_growth_yoy":0.0211,"rent_growth_yoy_downside":0.0098,"rent_growth_yoy_upside":0.0342,"rent_growth_yoy_bed_0":0.0184,"rent_growth_yoy_bed_0_downside":0.0065,"rent_growth_yoy_bed_0_upside":0.031,"rent_growth_yoy_bed_1":0.0202,"rent_growth_yoy_bed_1_downside":0.0089,"rent_growth_yoy_bed_1_upside":0.0331,"rent_growth_yoy_bed_2":0.0237,"rent_growth_yoy_bed_2_downside":0.0114,"rent_growth_yoy_bed_2_upside":0.0376,"rent_growth_yoy_bed_3":0.0196,"rent_growth_yoy_bed_3_downside":0.0071,"rent_growth_yoy_bed_3_upside":0.0324,"rent_growth_yoy_class_a":0.0252,"rent_growth_yoy_class_a_downside":0.0128,"rent_growth_yoy_class_a_upside":0.0394,"rent_growth_yoy_class_b":0.0201,"rent_growth_yoy_class_b_downside":0.0087,"rent_growth_yoy_class_b_upside":0.0322,"rent_growth_yoy_class_c":0.0157,"rent_growth_yoy_class_c_downside":0.0038,"rent_growth_yoy_class_c_upside":0.0289,"occupancy":0.9433,"occupancy_downside":0.9275,"occupancy_upside":0.9581,"absorption":148,"absorption_downside":96,"absorption_upside":201,"deliveries":132,"deliveries_downside":74,"deliveries_upside":186},{"name":"Downtown Madison","geo_boundary_id":90114,"geo_type":"Submarket","msa_name":"Madison, WI Metro Area","submarket_name":null,"period":"2026-Q3","rent_growth_yoy":0.0289,"rent_growth_yoy_downside":0.0142,"rent_growth_yoy_upside":0.0441,"rent_growth_yoy_bed_0":0.0251,"rent_growth_yoy_bed_0_downside":0.0107,"rent_growth_yoy_bed_0_upside":0.0402,"rent_growth_yoy_bed_1":0.0278,"rent_growth_yoy_bed_1_downside":0.0131,"rent_growth_yoy_bed_1_upside":0.0435,"rent_growth_yoy_bed_2":0.0314,"rent_growth_yoy_bed_2_downside":0.0168,"rent_growth_yoy_bed_2_upside":0.0479,"rent_growth_yoy_bed_3":null,"rent_growth_yoy_bed_3_downside":null,"rent_growth_yoy_bed_3_upside":null,"rent_growth_yoy_class_a":0.0335,"rent_growth_yoy_class_a_downside":0.0188,"rent_growth_yoy_class_a_upside":0.0502,"rent_growth_yoy_class_b":0.0246,"rent_growth_yoy_class_b_downside":0.0104,"rent_growth_yoy_class_b_upside":0.0395,"rent_growth_yoy_class_c":null,"rent_growth_yoy_class_c_downside":null,"rent_growth_yoy_class_c_upside":null,"occupancy":0.9504,"occupancy_downside":0.9312,"occupancy_upside":0.9648,"absorption":32,"absorption_downside":18,"absorption_upside":47,"deliveries":24,"deliveries_downside":0,"deliveries_upside":42}],"pagination":{"current_page":1,"total_pages":4,"total_count":100,"per_page":25}}}},"exampleType":"examples"}},"exampleType":"examples"},"4fb759d1-d325-4a12-a950-6f466ee1900a":{"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"},"1687b29c-f31b-4381-932d-490c42c24752":{"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"},"0c658722-cdf1-428d-85e0-aab94798c2bc":{"description":"Forbidden - The user lacks account access or Explore Pro access.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"a4351a68-2b40-4afb-9fae-f77abc099ad2":{"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"},"d4d9f4ae-5683-4fb2-b21c-34a29902c0b5":{"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 Market 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-market-forecasts","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T16:34:09.299Z","originalFileLocation":"v2/api-reference/bulk/bulk-market-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 market forecast rows for geographic boundaries using optional geography filters, requested forecast fields, and pagination. Requires Explore Pro access. property_filters and filters are not supported.\">\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 Market Forecasts - ApartmentIQ API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve bulk market forecast rows for geographic boundaries using optional geography filters, requested forecast fields, and pagination. Requires Explore Pro access. property_filters and filters are not supported.\">\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-market-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+Market+Forecasts\u0026amp;description=Retrieve+bulk+market+forecast+rows+for+geographic+boundaries+using+optional+geography+filters%2C+requested+forecast+fields%2C+and+pagination.%0A%0A%3CWarning%3ERequires+Exp\u0026amp;theme=dc0e3ba1149aaeec6590ba45\u0026amp;signature=fbd02a2759e753c22f0d1924f237b6c3b9c9bbe8aa4df7a2dbfa94a97d4e2ec4\">\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 Market Forecasts - ApartmentIQ API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve bulk market forecast rows for geographic boundaries using optional geography filters, requested forecast fields, and pagination. Requires Explore Pro access. property_filters and filters are not supported.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://apartmentiq-c1886649.mintlify.site/_mintlify/api/og/v2?division=Bulk\u0026amp;title=Bulk+Market+Forecasts\u0026amp;description=Retrieve+bulk+market+forecast+rows+for+geographic+boundaries+using+optional+geography+filters%2C+requested+forecast+fields%2C+and+pagination.%0A%0A%3CWarning%3ERequires+Exp\u0026amp;theme=dc0e3ba1149aaeec6590ba45\u0026amp;signature=fbd02a2759e753c22f0d1924f237b6c3b9c9bbe8aa4df7a2dbfa94a97d4e2ec4\">\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-market-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-market-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-market-forecasts#webpage\",\"url\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-market-forecasts\",\"name\":\"Bulk Market Forecasts\",\"description\":\"Retrieve bulk market forecast rows for geographic boundaries using optional geography filters, requested forecast fields, and pagination. Requires Explore Pro access. property_filters and filters are not supported.\",\"dateModified\":\"2026-11-03T16:34:09.299Z\",\"isPartOf\":{\"@id\":\"https://developers.apartmentiq.io#website\"},\"breadcrumb\":{\"@id\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-market-forecasts#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-market-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 Market Forecasts\",\"item\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-market-forecasts\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-market-forecasts#apireference\",\"headline\":\"Bulk Market Forecasts\",\"name\":\"Bulk Market Forecasts\",\"description\":\"Retrieve bulk market forecast rows for geographic boundaries using optional geography filters, requested forecast fields, and pagination. Requires Explore Pro access. property_filters and filters are not supported.\",\"url\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-market-forecasts\",\"mainEntityOfPage\":{\"@id\":\"https://developers.apartmentiq.io/v2/api-reference/bulk/bulk-market-forecasts#webpage\"},\"dateModified\":\"2026-11-03T16:34:09.299Z\",\"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-market-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","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","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"},{"title":"Bulk Market Forecasts","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","description":"Request a complete ApartmentIQ dataset snapshot in Parquet or CSV format.\n\n\u003cWarning>This API is not available to all customers. Please reach out to your account representative if you would like to learn more.\u003c/Warning>\n\n## How downloads work\n\nBy default, the endpoint returns JSON containing the selected dataset, file type, snapshot date, and a private, pre-signed download URL that expires after five minutes. Set \u003ccode>redirect_to_download\u003c/code> to \u003ccode>true\u003c/code> to receive a \u003ccode>303 See Other\u003c/code> redirect to the download URL instead.\n\nIf you omit \u003ccode>date\u003c/code>, the endpoint returns the newest available dataset.\n\nDatasets refresh in the early morning, EST. Exact refresh timing can vary. Properties, Organizations, and Organization Properties datasets refresh daily, and the Contacts dataset refreshes monthly on the 5th day of the month.\n\n## Properties dataset\n\nOne row per property visible in ApartmentIQ Explore, using the requested snapshot date.\n\n| Field | Parquet type | Meaning |\n|---|---|---|\n| \u003ccode>property_name\u003c/code> | string | Property display name. |\n| \u003ccode>market_name\u003c/code> | string | ApartmentIQ market name. |\n| \u003ccode>submarket_name\u003c/code> | string | ApartmentIQ submarket name. |\n| \u003ccode>property_id\u003c/code> | int64 | ApartmentIQ property ID. |\n| \u003ccode>address\u003c/code> | string | Street address. |\n| \u003ccode>city\u003c/code> | string | City. |\n| \u003ccode>state\u003c/code> | string | State abbreviation. |\n| \u003ccode>zip_code\u003c/code> | string | Postal code. |\n| \u003ccode>latitude\u003c/code> | double | Latitude rounded to six decimal places. |\n| \u003ccode>longitude\u003c/code> | double | Longitude rounded to six decimal places. |\n| \u003ccode>unified_status\u003c/code> | string | Current ApartmentIQ property status. |\n| \u003ccode>unit_count\u003c/code> | int64 | Known number of units. |\n| \u003ccode>number_of_stories\u003c/code> | int64 | Known number of stories. |\n| \u003ccode>year_built\u003c/code> | int64 | Year built. |\n| \u003ccode>year_renovated\u003c/code> | int64 | Year most recently renovated. |\n| \u003ccode>property_class\u003c/code> | string | ApartmentIQ property class. |\n| \u003ccode>property_type\u003c/code> | string | ApartmentIQ property type. |\n| \u003ccode>property_website\u003c/code> | string | Property website URL. |\n| \u003ccode>on_revenue_management_tool\u003c/code> | boolean | Whether ApartmentIQ identifies the property as using a revenue management tool. |\n| \u003ccode>management_company_names\u003c/code> | string | Current management company names, encoded as a pipe-delimited scalar list. |\n| \u003ccode>management_change_date\u003c/code> | string | Most recent management change date in YYYY-MM-DD format, or an empty string. |\n| \u003ccode>previous_management_company_names\u003c/code> | string | Management company names before the most recent change, encoded as a pipe-delimited scalar list. |\n| \u003ccode>ownership_company_names\u003c/code> | string | Current ownership company names, encoded as a pipe-delimited scalar list. |\n| \u003ccode>ownership_change_date\u003c/code> | string | Most recent ownership change date in YYYY-MM-DD format, or an empty string. |\n| \u003ccode>previous_ownership_company_names\u003c/code> | string | Ownership company names before the most recent change, encoded as a pipe-delimited scalar list. |\n| \u003ccode>rent\u003c/code> | double | Average asking rent over the trailing 30 days. |\n| \u003ccode>rent_0_bed\u003c/code> | double | Average studio asking rent over the trailing 30 days. |\n| \u003ccode>rent_1_bed\u003c/code> | double | Average one-bedroom asking rent over the trailing 30 days. |\n| \u003ccode>rent_2_bed\u003c/code> | double | Average two-bedroom asking rent over the trailing 30 days. |\n| \u003ccode>rent_3_bed\u003c/code> | double | Average three-bedroom asking rent over the trailing 30 days. |\n| \u003ccode>ner\u003c/code> | double | Average net effective rent after concessions over the trailing 30 days. |\n| \u003ccode>ner_0_bed\u003c/code> | double | Average studio net effective rent over the trailing 30 days. |\n| \u003ccode>ner_1_bed\u003c/code> | double | Average one-bedroom net effective rent over the trailing 30 days. |\n| \u003ccode>ner_2_bed\u003c/code> | double | Average two-bedroom net effective rent over the trailing 30 days. |\n| \u003ccode>ner_3_bed\u003c/code> | double | Average three-bedroom net effective rent over the trailing 30 days. |\n| \u003ccode>rent_psf\u003c/code> | double | Average asking rent per square foot over the trailing 30 days. |\n| \u003ccode>rent_0_bed_psf\u003c/code> | double | Average studio asking rent per square foot over the trailing 30 days. |\n| \u003ccode>rent_1_bed_psf\u003c/code> | double | Average one-bedroom asking rent per square foot over the trailing 30 days. |\n| \u003ccode>rent_2_bed_psf\u003c/code> | double | Average two-bedroom asking rent per square foot over the trailing 30 days. |\n| \u003ccode>rent_3_bed_psf\u003c/code> | double | Average three-bedroom asking rent per square foot over the trailing 30 days. |\n| \u003ccode>ner_psf\u003c/code> | double | Average net effective rent per square foot over the trailing 30 days. |\n| \u003ccode>ner_0_bed_psf\u003c/code> | double | Average studio net effective rent per square foot over the trailing 30 days. |\n| \u003ccode>ner_1_bed_psf\u003c/code> | double | Average one-bedroom net effective rent per square foot over the trailing 30 days. |\n| \u003ccode>ner_2_bed_psf\u003c/code> | double | Average two-bedroom net effective rent per square foot over the trailing 30 days. |\n| \u003ccode>ner_3_bed_psf\u003c/code> | double | Average three-bedroom net effective rent per square foot over the trailing 30 days. |\n| \u003ccode>rent_growth_rate_yoy\u003c/code> | double | Year-over-year asking rent growth rate. |\n| \u003ccode>ner_growth_rate_yoy\u003c/code> | double | Year-over-year net effective rent growth rate. |\n| \u003ccode>concession_value\u003c/code> | double | Average concession value over the trailing 30 days. |\n| \u003ccode>concession_percent\u003c/code> | double | Average concession as a share of rent over the trailing 30 days. |\n| \u003ccode>days_on_market\u003c/code> | double | Average days on market for available units over the trailing 30 days. |\n| \u003ccode>occupancy_percent\u003c/code> | double | Average occupancy share over the trailing 30 days. |\n| \u003ccode>leased_percent\u003c/code> | double | Average leased share over the trailing 30 days. |\n| \u003ccode>exposure_percent\u003c/code> | double | Average share of units exposed for lease over the trailing 30 days. |\n\n## Organizations dataset\n\nOne row per stakeholder organization associated with at least one property. Profile fields describe the organization, while property and unit counts reflect the requested snapshot date. Breakdown fields are flattened into fixed scalar columns.\n\n| Field | Parquet type | Meaning |\n|---|---|---|\n| \u003ccode>id\u003c/code> | int64 | ApartmentIQ stakeholder entity ID. |\n| \u003ccode>name\u003c/code> | string | Organization display name. |\n| \u003ccode>entity_type\u003c/code> | string | Stakeholder entity type, such as Property Manager or Owner. |\n| \u003ccode>image_url\u003c/code> | string | Organization logo or image URL. |\n| \u003ccode>website_url\u003c/code> | string | Organization website URL. |\n| \u003ccode>domain_name\u003c/code> | string | Organization domain name. |\n| \u003ccode>linkedin_url\u003c/code> | string | Organization LinkedIn URL. |\n| \u003ccode>description\u003c/code> | string | Organization description. |\n| \u003ccode>company_entity_type\u003c/code> | string | Company entity classification. |\n| \u003ccode>company_legal_type\u003c/code> | string | Company legal structure. |\n| \u003ccode>year_founded\u003c/code> | string | Year the organization was founded. |\n| \u003ccode>phone_number\u003c/code> | string | Organization phone number. |\n| \u003ccode>employee_count_range\u003c/code> | string | Known employee count range. |\n| \u003ccode>headquarters_address\u003c/code> | string | Headquarters street address. |\n| \u003ccode>headquarters_city\u003c/code> | string | Headquarters city. |\n| \u003ccode>headquarters_state\u003c/code> | string | Headquarters state. |\n| \u003ccode>headquarters_zip_code\u003c/code> | string | Headquarters postal code. |\n| \u003ccode>headquarters_country\u003c/code> | string | Headquarters country. |\n| \u003ccode>property_count\u003c/code> | int64 | Number of associated properties on the snapshot date. |\n| \u003ccode>total_unit_count\u003c/code> | int64 | Total units across associated properties on the snapshot date. |\n| \u003ccode>units_by_property_class_a_unit_count\u003c/code> | int64 | Units in associated class A properties. |\n| \u003ccode>units_by_property_class_b_unit_count\u003c/code> | int64 | Units in associated class B properties. |\n| \u003ccode>units_by_property_class_c_unit_count\u003c/code> | int64 | Units in associated class C properties. |\n| \u003ccode>units_by_property_class_d_unit_count\u003c/code> | int64 | Units in associated class D properties. |\n| \u003ccode>units_by_property_type_conventional_unit_count\u003c/code> | int64 | Units in associated conventional properties. |\n| \u003ccode>units_by_property_type_student_unit_count\u003c/code> | int64 | Units in associated student housing properties. |\n| \u003ccode>units_by_property_type_senior_unit_count\u003c/code> | int64 | Units in associated senior living properties. |\n| \u003ccode>units_by_property_type_build_to_rent_unit_count\u003c/code> | int64 | Units in associated build-to-rent properties. |\n| \u003ccode>units_by_property_type_affordable_unit_count\u003c/code> | int64 | Units in associated income-restricted properties. |\n\n## Organization Properties dataset\n\nUse this dataset to connect properties to their current organizations without matching organization names. Each row links one property to one organization, so a property associated with multiple organizations appears in multiple rows. Join \u003ccode>property_id\u003c/code> to \u003ccode>properties.property_id\u003c/code> and \u003ccode>organization_id\u003c/code> to \u003ccode>organizations.id\u003c/code>. Use \u003ccode>organizations.entity_type\u003c/code> to determine each organization's role. Historical organization relationships are not included.\n\n| Field | Parquet type | Meaning |\n|---|---|---|\n| \u003ccode>property_id\u003c/code> | int64 | ApartmentIQ property ID. Joins to \u003ccode>property_id\u003c/code> in the Properties dataset. |\n| \u003ccode>organization_id\u003c/code> | int64 | ApartmentIQ stakeholder entity ID. Joins to \u003ccode>id\u003c/code> in the Organizations dataset. |\n\n## Contacts dataset\n\nOne row per contact and linked stakeholder organization. A person linked to multiple qualifying organizations can appear once for each organization.\n\n| Field | Parquet type | Meaning |\n|---|---|---|\n| \u003ccode>name\u003c/code> | string | Contact name. |\n| \u003ccode>job_title\u003c/code> | string | Contact job title. |\n| \u003ccode>linkedin_url\u003c/code> | string | Contact LinkedIn URL. |\n| \u003ccode>email_address\u003c/code> | string | Contact email address. |\n| \u003ccode>phone_number\u003c/code> | string | Contact phone number. |\n| \u003ccode>stakeholder_entity_id\u003c/code> | int64 | ApartmentIQ stakeholder entity ID for the linked organization. |\n| \u003ccode>stakeholder_entity_name\u003c/code> | string | Display name of the linked stakeholder organization. |","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 Market 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"]}