List Competitive Sets

curl --request GET \
  --url https://data.apartmentiq.io/apartmentiq/api/v1/accounts/{account_id}/comp_sets \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 11848667,
      "type": "comp_set",
      "attributes": {
        "name": "Bowery Bayside Market",
        "min_floorplan": 0,
        "max_floorplan": 2,
        "image": "https://apartmentiq-assets.rentable.co/images/accounts/9901947/comp-sets/11848667.jpg",
        "market_survey": true,
        "category": "market_survey",
        "custom_property": false,
        "value_add": false,
        "addresses": [
          "6301 S Westshore Blvd Tampa FL 33616"
        ],
        "owned_property_addresses": [
          {
            "id": 99000673,
            "address": "6301 S Westshore Blvd",
            "city": "Tampa",
            "state": "FL",
            "zip_code": "33616"
          }
        ],
        "subject_property_ids": [
          "99000673"
        ],
        "created_at": "2024-02-13T12:00:00Z",
        "show_recommendations_link": true
      }
    }
  ]
}

GET

accounts

{account_id}

comp_sets

List Competitive Sets

curl --request GET \
  --url https://data.apartmentiq.io/apartmentiq/api/v1/accounts/{account_id}/comp_sets \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 11848667,
      "type": "comp_set",
      "attributes": {
        "name": "Bowery Bayside Market",
        "min_floorplan": 0,
        "max_floorplan": 2,
        "image": "https://apartmentiq-assets.rentable.co/images/accounts/9901947/comp-sets/11848667.jpg",
        "market_survey": true,
        "category": "market_survey",
        "custom_property": false,
        "value_add": false,
        "addresses": [
          "6301 S Westshore Blvd Tampa FL 33616"
        ],
        "owned_property_addresses": [
          {
            "id": 99000673,
            "address": "6301 S Westshore Blvd",
            "city": "Tampa",
            "state": "FL",
            "zip_code": "33616"
          }
        ],
        "subject_property_ids": [
          "99000673"
        ],
        "created_at": "2024-02-13T12:00:00Z",
        "show_recommendations_link": true
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

account_id

integer

required

ID of the ApartmentIQ account to get the list of comp sets for.

Response

A Map with a data attribute that contains an array of all comp sets the user has access to in the given account.

data

object[]

Show child attributes

data.id

integer

required

ID of the comp set.

Example:

11848667

data.type

string

required

Type of data returned in the response.

Example:

"comp_set"

data.attributes

object

required

Container for comp set attributes and metadata.

Show child attributes

data.attributes.name

string

Name of the comp set.

Example:

"Bowery Bayside Market"

data.attributes.min_floorplan

integer

Minimum floorplan size to include in the comp set data, where 0 is a studio and 5 is a 5 bedroom unit.

Example:

0

data.attributes.max_floorplan

integer

Maximum floorplan size to include in the comp set data, where 0 is a studio and 5 is a 5 bedroom unit.

Example:

2

data.attributes.image

string

URL of the image representing the comp set.

Example:

"https://apartmentiq-assets.rentable.co/images/accounts/9901947/comp-sets/11848667.jpg"

data.attributes.market_survey

boolean

Whether the comp set is a Market Survey or a Research Report.

Example:

true

data.attributes.category

string

The comp set category: market_survey, research_report, or legacy_research_report.

Example:

"market_survey"

data.attributes.custom_property

boolean

Whether or not the comp set contains custom property.

Example:

false

data.attributes.value_add

boolean

Whether or not the comp set is set to include value add properties.

Example:

false

data.attributes.addresses

string[]

List of street addresses of subject properties in the comp set.

Example:

["6301 S Westshore Blvd Tampa FL 33616"]

data.attributes.owned_property_addresses

object[]

List of street addresses of subject properties in the comp set broken up by part

Show child attributes

data.attributes.owned_property_addresses.id

integer

data.attributes.owned_property_addresses.address

string

data.attributes.owned_property_addresses.city

string

data.attributes.owned_property_addresses.state

string

data.attributes.owned_property_addresses.zip_code

string

Example:

[
  {
    "id": 99000673,
    "address": "6301 S Westshore Blvd",
    "city": "Tampa",
    "state": "FL",
    "zip_code": "33616"
  }
]

data.attributes.subject_property_ids

string[]

List of IDs of subject properties in the comp set.

Example:

["99000673"]

data.attributes.created_at

string<date-time>

Date the comp set was created, in ISO 8601 format.

Example:

"2024-02-13T12:00:00Z"

data.attributes.show_recommendations_link

boolean

Indicates if the market survey has recommendations enabled.

Example:

true

Data Sync Get Market Survey Data

⌘I

Overview

Use Cases

API Reference

List Competitive Sets

Authorizations

Path Parameters

Response