Search Properties

Authorizations

Authorization

string

header

required

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

Body

application/json

account_id

integer

required

The ID of the account you're requesting data for.

Example:

9901947

property_filters

object

required

Filters to apply when selecting properties. At least one geographic filter (geo_boundary_ids or geometry) is required.

Option 1
Option 2

Show child attributes

property_filters.geo_boundary_ids

string[]

required

Array of geo boundary IDs to filter properties by. Properties within any of these boundaries will be included. You find these IDs by searching for the boundaries that you're interested in.

Example:

["123", "456"]

property_filters.geometry

object

GeoJSON Polygon or MultiPolygon geometry object to filter properties by spatial containment.

Show child attributes

property_filters.geometry.type

enum<string>

Available options:

Polygon,

MultiPolygon

Example:

"Polygon"

property_filters.geometry.coordinates

array

Coordinate array following GeoJSON specification (longitude, latitude pairs)

Example:

[
  [
    [-78.663, 35.821],
    [-78.663, 35.85],
    [-78.623, 35.85],
    [-78.623, 35.821],
    [-78.663, 35.821]
  ]
]

Example:

{
  "type": "Polygon",
  "coordinates": [
    [
      [-78.663, 35.821],
      [-78.663, 35.85],
      [-78.623, 35.85],
      [-78.623, 35.821],
      [-78.663, 35.821]
    ]
  ]
}

property_filters.year_built_gte

number

Minimum year the property was built.

Example:

2000

property_filters.year_built_lte

number

Maximum year the property was built.

Example:

2024

property_filters.total_units_gte

number

Minimum total number of units in the property.

Example:

50

property_filters.total_units_lte

number

Maximum total number of units in the property.

Example:

500

property_filters.number_of_stories_gte

number

Minimum number of stories/floors in the property buildings.

Example:

3

property_filters.number_of_stories_lte

number

Maximum number of stories/floors in the property buildings.

Example:

20

property_filters.property_class

enum<string>[]

Filter by property classification grade.

Available options:

A,

B,

C

Example:

["A", "B"]

property_filters.property_type

enum<string>[]

Filter by property type/category.

Available options:

conventional,

income_restricted,

section8,

senior_living,

student_housing,

build_to_rent

Example:

["conventional"]

property_filters.construction_state

enum<string>[]

Filter by current construction state/status.

Available options:

existing,

new_supply

Example:

["existing"]

property_filters.bedroom_count

array

Filter by number of bedrooms. 0 = studio, 1 = 1 bedroom, etc.

Example:

["1", "2"]

property_filters.bathroom_count

array

Filter by number of bathrooms.

Example:

["1", "2", "2.5"]

property_filters.rent_gte

number

Minimum average asking rent.

Example:

1000

property_filters.rent_lte

number

Maximum average asking rent.

Example:

3000

property_filters.ner_gte

number

Minimum average net effective rent after concessions.

Example:

950

property_filters.ner_lte

number

Maximum average net effective rent after concessions.

Example:

2800

property_filters.rent_per_sq_ft_gte

number

Minimum average asking rent per square foot.

Example:

1.5

property_filters.rent_per_sq_ft_lte

number

Maximum average asking rent per square foot.

Example:

3.5

property_filters.ner_per_sq_ft_gte

number

Minimum average net effective rent per square foot.

Example:

1.4

property_filters.ner_per_sq_ft_lte

number

Maximum average net effective rent per square foot.

Example:

3.25

property_filters.size_gte

number

Minimum average unit size in square feet.

Example:

500

property_filters.size_lte

number

Maximum average unit size in square feet.

Example:

2000

property_filters.concession_value_gte

number

Minimum average concession value in dollars.

Example:

100

property_filters.concession_value_lte

number

Maximum average concession value in dollars.

Example:

500

property_filters.concession_percent_gte

number

Minimum average concession as percentage of rent.

Required range: x <= 100

Example:

5

property_filters.concession_percent_lte

number

Maximum average concession as percentage of rent.

Required range: x <= 100

Example:

15

property_filters.occupancy_gte

number

Minimum occupancy percentage.

Required range: x <= 100

Example:

85

property_filters.occupancy_lte

number

Maximum occupancy percentage.

Required range: x <= 100

Example:

98

property_filters.leased_percent_gte

number

Minimum percentage of units leased.

Required range: x <= 100

Example:

90

property_filters.leased_percent_lte

number

Maximum percentage of units leased.

Required range: x <= 100

Example:

100

property_filters.exposure_gte

number

Minimum exposure percentage (units available for lease).

Required range: x <= 100

Example:

2

property_filters.exposure_lte

number

Maximum exposure percentage (units available for lease).

Required range: x <= 100

Example:

15

Response

Successfully retrieved property data. Returns properties in JSON:API format with comprehensive property details.

data

object[]

required

Array of property data in JSON:API format

Show child attributes

data.id

string

required

The property ID as a string

Example:

"99030676"

data.type

enum<string>

required

Resource type, always 'properties'

Available options:

properties

Example:

"properties"

data.attributes

object

required

Property attributes including physical characteristics, metrics, and ownership data

Show child attributes

data.attributes.collected_at

string<date>

Date when the data was collected

Example:

"2024-01-15"

data.attributes.msa_name

string | null

Metropolitan Statistical Area name

Example:

"Raleigh-Cary, NC"

data.attributes.property_name

string

Name of the property

Example:

"The Heights at Main Street"

data.attributes.property_id

integer

Unique property identifier

Example:

123456

data.attributes.property_url

string<uri> | null

URL to the property's detail page

Example:

"https://example.com/property/123456"

data.attributes.address

string

Street address of the property

Example:

"123 Main Street"

data.attributes.city

string

City where the property is located

Example:

"Raleigh"

data.attributes.state

string

State abbreviation

Example:

"NC"

data.attributes.zip

string

ZIP code

Example:

"27605"

data.attributes.latitude

number<float>

Geographic latitude coordinate

Example:

35.8234

data.attributes.longitude

number<float>

Geographic longitude coordinate

Example:

-78.6382

data.attributes.unit_count

integer | null

Total number of units in the property

Example:

250

data.attributes.year_built

integer | null

Year the property was constructed

Example:

2018

data.attributes.year_renovated

integer | null

Year of most recent renovation

Example:

2022

data.attributes.construction_status

enum<string> | null

Current construction status

Available options:

existing,

new_supply

Example:

"existing"

data.attributes.property_class

enum<string> | null

Property classification grade

Available options:

A,

B,

C

Example:

"A"

data.attributes.management_company_name

string | null

Name of the property management company

Example:

"Premium Property Management"

data.attributes.property_type

enum<string> | null

Type of property

Available options:

conventional,

income_restricted,

section8,

senior_living,

student_housing,

build_to_rent

Example:

"conventional"

data.attributes.building_type

enum<string> | null

Building configuration type

Available options:

Garden Style,

Mid-Rise,

High-Rise

Example:

"Mid-Rise"

data.attributes.building_count

integer | null

Number of buildings on the property

Example:

3

data.attributes.rentable_building_area_sq_ft

integer | null

Total rentable square footage

Example:

225000

data.attributes.land_area_sq_ft

integer | null

Total land area in square feet

Example:

435600

data.attributes.units_per_acre

number<float> | null

Density measured as units per acre

Example:

25.2

data.attributes.number_of_stories

integer | null

Maximum number of stories in any building

Example:

5

data.attributes.average_unit_size

integer | null

Average unit size in square feet

Example:

900

data.attributes.transit_score

integer | null

Transit accessibility score (0-100)

Required range: 0 <= x <= 100

Example:

45

data.attributes.walk_score

integer | null

Walkability score (0-100)

Required range: 0 <= x <= 100

Example:

72

data.attributes.ownership_company_1_name

string | null

Primary ownership company name (requires tier_one_data_access)

Example:

"ABC Real Estate Holdings"

data.attributes.ownership_company_1_ownership_type

string | null

Type of ownership for primary company (requires tier_one_data_access)

Example:

"Private"

data.attributes.ownership_company_2_name

string | null

Secondary ownership company name (requires tier_one_data_access)

Example:

"XYZ Real Estate Holdings"

data.attributes.ownership_company_2_ownership_type

string | null

Type of ownership for secondary company (requires tier_one_data_access)

Example:

"Public"

data.attributes.ownership_company_3_name

string | null

Tertiary ownership company name (requires tier_one_data_access)

Example:

"123 Real Estate Holdings"

data.attributes.ownership_company_3_ownership_type

string | null

Type of ownership for tertiary company (requires tier_one_data_access)

Example:

"Institutional"

data.attributes.ownership_company_4_name

string | null

Quaternary ownership company name (requires tier_one_data_access)

Example:

"456 Real Estate Holdings"

data.attributes.ownership_company_4_ownership_type

string | null

Type of ownership for quaternary company (requires tier_one_data_access)

Example:

"Private"

data.attributes.owned_since_date

string<date> | null

Date when current owner acquired the property (requires tier_one_data_access)

Example:

"2015-03-15"

data.attributes.last_sale_price

number | null

Most recent sale price in dollars (requires tier_two_data_access)

Example:

45000000

data.attributes.last_sale_price_status

string | null

Status or verification level of the sale price (requires tier_two_data_access)

Example:

"closed"

data.attributes.asking_rent

number<float> | null

Average asking rent across all unit types (last 30 days)

Example:

1850

data.attributes.asking_rent_psf

number<float> | null

Average asking rent per square foot (last 30 days)

Example:

2.06

data.attributes.net_effective_rent

number<float> | null

Average net effective rent after concessions (last 30 days)

Example:

1795

data.attributes.net_effective_rent_psf

number<float> | null

Average net effective rent per square foot (last 30 days)

Example:

1.99

data.attributes.exposure_percent

number<float> | null

Percentage of units available for lease (last 30 days)

Example:

8.5

data.attributes.advertised_occupancy_percent

number<float> | null

Advertised occupancy percentage (last 30 days)

Example:

94.2

data.attributes.leased_percent

number<float> | null

Percentage of units leased (last 30 days)

Example:

95.6

data.attributes.available_unit_count_0_bed

integer | null

Number of available studio units (last 30 days)

Example:

2

data.attributes.available_unit_count_1_bed

integer | null

Number of available 1-bedroom units (last 30 days)

Example:

5

data.attributes.available_unit_count_2_bed

integer | null

Number of available 2-bedroom units (last 30 days)

Example:

8

data.attributes.available_unit_count_3_bed

integer | null

Number of available 3-bedroom units (last 30 days)

Example:

3

data.attributes.available_unit_count_4_bed

integer | null

Number of available 4+ bedroom units (last 30 days)

Example:

0

data.attributes.leased_unit_count_0_bed

integer | null

Number of leased studio units (last 30 days)

Example:

2

data.attributes.leased_unit_count_1_bed

integer | null

Number of leased 1-bedroom units (last 30 days)

Example:

5

data.attributes.leased_unit_count_2_bed

integer | null

Number of leased 2-bedroom units (last 30 days)

Example:

8

data.attributes.leased_unit_count_3_bed

integer | null

Number of leased 3-bedroom units (last 30 days)

Example:

3

data.attributes.leased_unit_count_4_bed

integer | null

Number of leased 4+ bedroom units (last 30 days)

Example:

0

data.attributes.asking_rent_0_bed

number<float> | null

Average asking rent for studio units (last 30 days)

Example:

1450

data.attributes.asking_rent_1_bed

number<float> | null

Average asking rent for 1-bedroom units (last 30 days)

Example:

1450

data.attributes.asking_rent_2_bed

number<float> | null

Average asking rent for 2-bedroom units (last 30 days)

Example:

1950

data.attributes.asking_rent_3_bed

number<float> | null

Average asking rent for 3-bedroom units (last 30 days)

Example:

2450

data.attributes.asking_rent_4_bed

number<float> | null

Average asking rent for 4+ bedroom units (last 30 days)

Example:

2450

data.attributes.asking_rent_psf_0_bed

number<float> | null

Average asking rent per square foot for studio units (last 30 days)

Example:

2.07

data.attributes.asking_rent_psf_1_bed

number<float> | null

Average asking rent per square foot for 1-bedroom units (last 30 days)

Example:

2.07

data.attributes.asking_rent_psf_2_bed

number<float> | null

Average asking rent per square foot for 2-bedroom units (last 30 days)

Example:

1.95

data.attributes.asking_rent_psf_3_bed

number<float> | null

Average asking rent per square foot for 3-bedroom units (last 30 days)

Example:

1.88

data.attributes.asking_rent_psf_4_bed

number<float> | null

Average asking rent per square foot for 4+ bedroom units (last 30 days)

Example:

1.88

data.attributes.concession_percent_0_bed

number<float> | null

Average concession percentage for studio units (last 30 days)

Example:

2.5

data.attributes.concession_percent_1_bed

number<float> | null

Average concession percentage for 1-bedroom units (last 30 days)

Example:

2.5

data.attributes.concession_percent_2_bed

number<float> | null

Average concession percentage for 2-bedroom units (last 30 days)

Example:

3

data.attributes.concession_percent_3_bed

number<float> | null

Average concession percentage for 3-bedroom units (last 30 days)

Example:

2

data.attributes.concession_percent_4_bed

number<float> | null

Average concession percentage for 4+ bedroom units (last 30 days)

Example:

2

data.attributes.concession_value_0_bed

number<float> | null

Average concession value in dollars for studio units (last 30 days)

Example:

1200

data.attributes.concession_value_1_bed

number<float> | null

Average concession value in dollars for 1-bedroom units (last 30 days)

Example:

1300

data.attributes.concession_value_2_bed

number<float> | null

Average concession value in dollars for 2-bedroom units (last 30 days)

Example:

1800

data.attributes.concession_value_3_bed

number<float> | null

Average concession value in dollars for 3-bedroom units (last 30 days)

Example:

2400

data.attributes.concession_value_4_bed

number<float> | null

Average concession value in dollars for 4+ bedroom units (last 30 days)

Example:

2400

data.attributes.net_effective_rent_0_bed

number<float> | null

Average net effective rent for studio units (last 30 days)

Example:

1300

data.attributes.net_effective_rent_1_bed

number<float> | null

Average net effective rent for 1-bedroom units (last 30 days)

Example:

1414

data.attributes.net_effective_rent_2_bed

number<float> | null

Average net effective rent for 2-bedroom units (last 30 days)

Example:

1892

data.attributes.net_effective_rent_3_bed

number<float> | null

Average net effective rent for 3-bedroom units (last 30 days)

Example:

2401

data.attributes.net_effective_rent_4_bed

number<float> | null

Average net effective rent for 4+ bedroom units (last 30 days)

Example:

2400

data.attributes.net_effective_rent_psf_0_bed

number<float> | null

Average net effective rent per square foot for studio units (last 30 days)

Example:

1.95

data.attributes.net_effective_rent_psf_1_bed

number<float> | null

Average net effective rent per square foot for 1-bedroom units (last 30 days)

Example:

1.95

data.attributes.net_effective_rent_psf_2_bed

number<float> | null

Average net effective rent per square foot for 2-bedroom units (last 30 days)

Example:

1.88

data.attributes.net_effective_rent_psf_3_bed

number<float> | null

Average net effective rent per square foot for 3-bedroom units (last 30 days)

Example:

1.88

data.attributes.net_effective_rent_psf_4_bed

number<float> | null

Average net effective rent per square foot for 4+ bedroom units (last 30 days)

Example:

1.88

data.attributes.days_on_market_0_bed

integer | null

Average days on market for studio units (last 30 days)

Example:

15

data.attributes.days_on_market_1_bed

integer | null

Average days on market for 1-bedroom units (last 30 days)

Example:

15

data.attributes.days_on_market_2_bed

integer | null

Average days on market for 2-bedroom units (last 30 days)

Example:

22

data.attributes.days_on_market_3_bed

integer | null

Average days on market for 3-bedroom units (last 30 days)

Example:

28

data.attributes.days_on_market_4_bed

integer | null

Average days on market for 4+ bedroom units (last 30 days)

Example:

28

Overview

Use Cases

API Reference

Authorizations

Body

Response