Skip to main content
GET
Suggest Comps

Authorizations

Authorization
string
header
required

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

Path Parameters

property_id
integer
required

ApartmentIQ property ID of the subject property.

Query Parameters

account_id
required

ApartmentIQ account ID used to set the request account context.

limit
integer
default:25

Maximum number of suggestions.

Required range: 1 <= x <= 50
minimum_score
number
default:0.5

Lowest score to include.

Required range: x >= 0
comp_set_id
integer

An active comp set in the account that the user can open. Its comps are flagged with in_comp_set.

year_built_gte
integer
year_built_lte
integer
total_units_gte
integer
total_units_lte
integer
number_of_stories_gte
integer
number_of_stories_lte
integer
property_class
string

Comma-separated property classes: A, B, C, D. Uppercase only.

property_type
string

Comma-separated property types: conventional, student (or student_housing), senior (or senior_living), build_to_rent, affordable. Not case-sensitive. The list must include the subject property's own type. Suggestions report the short names.

amenity_ids
string

Comma-separated amenity IDs. A candidate must have all of them. See List Amenities.

Response

Ranked comp suggestions.

subject_property_id
integer
required
suggestions
object[]
required