Retrieve a paginated list of properties with optional filtering.
Query Parameters
Restricts the resulting properties to those associated with the parcel with the given parcelId. Cannot be used together with geometry.
Accepts true or false. Controls visibility filtering. Omitting returns both public and private properties.
Positive, non-zero integer for pagination. See Pagination .
URI-encoded GeoJSON Polygon geometry to filter properties by spatial intersection. Only properties whose coordinates fall within the polygon will be returned. Cannot be used together with parcelId. {
"type" : "Polygon" ,
"coordinates" : [
[
[ -73.98836883114409 , 40.67402149000125 ],
[ -73.98836883114409 , 40.66928110727923 ],
[ -73.98070752927185 , 40.66928110727923 ],
[ -73.98070752927185 , 40.67402149000125 ],
[ -73.98836883114409 , 40.67402149000125 ]
]
]
}
Response
Array of property objects (up to 25 per page) Show Property object properties
UUID uniquely identifying the property
The property’s fully qualified address. Some properties may not have addresses.
The URL for the property’s public profile page. Null if the property is hidden from the public.
Internal profile page URL requiring Forerunner platform account access
Two-element array [latitude, longitude] in EPSG:4326 format
Associated parcel object; some properties lack parcels Show Parcel object properties
UUID uniquely identifying the parcel
The parcel’s id - often used to uniquely identify parcels within external, non-Forerunner systems.
The parcel’s fully qualified address. Some parcels may not have addresses.
Array of error objects. See Errors .
cURL - Basic List
cURL - Filter by Parcel
cURL - Geospatial Query
curl "https://app.withforerunner.com/api/v1/properties?page=1" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"properties" : [
{
"id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ,
"address" : "123 Main St, Springfield, IL 62701" ,
"publicURL" : "https://app.withforerunner.com/public/properties/a1b2c3d4-e5f6-7890-abcd-ef1234567890" ,
"url" : "https://app.withforerunner.com/properties/a1b2c3d4-e5f6-7890-abcd-ef1234567890" ,
"coordinates" : [ 39.7817 , -89.6501 ],
"parcel" : {
"id" : "f1e2d3c4-b5a6-7890-dcba-098765432109" ,
"parcelId" : "12-34-567-890" ,
"address" : "123 Main St, Springfield, IL 62701"
}
}
],
"pageInfo" : {
"page" : 1 ,
"pageSize" : 25 ,
"totalCount" : 1043 ,
"totalPages" : 42
},
"errors" : []
}