Skip to main content
POST
Create Market Survey

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request contract for creating a market survey or research report. Integer fields also accept integer strings such as "300".

account_id
required

ApartmentIQ account ID used to set the request account context.

iq_property_id
integer
required

ApartmentIQ property ID of the subject property.

name
string

Name for the comp set. Leading and trailing spaces are removed. Must be unique in the account.

Required string length: 1 - 150
unit_count_override
integer

Unit count to use for the subject property when it differs from ApartmentIQ's count. It is saved for the property in the account, so it also applies outside this comp set. On a market survey, it is the unit count billed.

Required range: 1 <= x <= 100000
comp_property_ids
integer[]

Exact comps to use, skipping automatic comp selection. Must hold 1 to 50 IDs after the subject property and duplicates are removed.

Response

The market survey was created or reactivated.

A market survey or research report.

id
integer
required

Comp set ID.

name
string
required
category
enum<string>
required
Available options:
market_survey,
research_report
account_id
integer
required

ApartmentIQ account ID the comp set belongs to.

active
boolean
required
min_floorplan
integer
required

Lowest bedroom count included (0 is studio).

Required range: 0 <= x <= 5
max_floorplan
integer
required

Highest bedroom count included.

Required range: 0 <= x <= 5
target_comp_count
integer
required

The number of properties automatic comp selection fills the comp set to, counting the subject property. 10 means automatic selection adds up to 9 comps. A custom subject is not counted. It is not a limit: comps you add yourself can go past it.

Required range: x >= 0
subject_property
object | null
required

The comp set's subject property. When a comp set has more than one owned property, this is the one with the lowest ID.

comps
object[]
required

Comps sorted by score, highest first. Comps without a score come last.

app_url
string<uri>
required

Link to the comp set in ApartmentIQ.

reactivated
boolean
required

True when an existing deactivated market survey was reactivated instead of created. Always false for research reports.