API Reference

Gross Yield

get
https://api.parcllabs.com/v1/rental_market_metrics//gross_yield

Gets the percent gross yield for a specified <parcl_id>. At the market level, identified by <parcl_id>, gross yield is calculated by dividing the annual median rental income—derived from multiplying the monthly median new rental listing price by 12—by its median new listings for sale price.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

A unique id for a given geographic market in the Parcl Labs API. Parcl_ids are unique and independent of each other, without any hierarchical structure. For example, the parcl_id for Brooklyn, NY bears no relationship to the parcl_id for the New York Metropolitan Statistical Area (MSA), even though Brooklyn is a part of the New York MSA.

Query Params
string
enum
Defaults to ALL_PROPERTIES

The type of property the data is associated with. Allows for filtering based on property type

Allowed:
date

Specifies the beginning of the query period, inclusive, in ISO 8601 format, i.e. YYYY-MM-DD. Defaults to NULL

date

Specifies the end of the query period, inclusive, in ISO 8601 format, i.e. YYYY-MM-DD. Defaults to NULL

integer
1 to 1000
Defaults to 12

Page size limit

integer
≥ 0
Defaults to 0

Page offset

Responses

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago