Skip to main content
GET
Get Market Narrative

Authorizations

Authorization
string
header
required

Enter a Bearer token obtained via the OAuth client credentials flow or from the Access Tokens tab in your account settings.

Query Parameters

account_id
integer
required

ID of the ApartmentIQ account.

geo_boundary_id
integer
required

ID of the geographic boundary to retrieve the narrative for. Find IDs using the Search Geo Boundaries endpoint.

Response

Successfully retrieved market narrative.

data
object[]
required

Array of market narrative resources. Contains at most one narrative (the most recent available for the geo boundary), or an empty array if no narrative exists.