List Properties

curl "https://app.withforerunner.com/api/v1/properties?page=1" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl "https://app.withforerunner.com/api/v1/properties?parcelId=12-34-567-890" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl "https://app.withforerunner.com/api/v1/properties?geometry=%7B%22type%22%3A%20%22Polygon%22%2C%20%22coordinates%22%3A%20%5B%5B%5B-73.98836883114409%2C%2040.67402149000125%5D%2C%20%5B-73.98836883114409%2C%2040.66928110727923%5D%2C%20%5B-73.98070752927185%2C%2040.66928110727923%5D%2C%20%5B-73.98070752927185%2C%2040.67402149000125%5D%2C%20%5B-73.98836883114409%2C%2040.67402149000125%5D%5D%5D%7D" \
  -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": []
}

endpoint

/api/v1/properties

Retrieve a paginated list of properties with optional filtering.

Query Parameters

string

Restricts the resulting properties to those associated with the parcel with the given parcelId. Cannot be used together with geometry.

enum

Accepts true or false. Controls visibility filtering. Omitting returns both public and private properties.

number

Positive, non-zero integer for pagination. See Pagination.

string

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.

Example GeoJSON Polygon

{
  "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

Array of property objects (up to 25 per page)

Show Property object properties

string

UUID uniquely identifying the property

string | null

The property’s fully qualified address. Some properties may not have addresses.

string | null

The URL for the property’s public profile page. Null if the property is hidden from the public.

string

Internal profile page URL requiring Forerunner platform account access

[number, number]

Two-element array [latitude, longitude] in EPSG:4326 format

object | null

Associated parcel object; some properties lack parcels

Show Parcel object properties

string

UUID uniquely identifying the parcel

string | null

The parcel’s id - often used to uniquely identify parcels within external, non-Forerunner systems.

string | null

The parcel’s fully qualified address. Some parcels may not have addresses.

object

Pagination information. See Pagination.

array

Array of error objects. See Errors.

curl "https://app.withforerunner.com/api/v1/properties?page=1" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl "https://app.withforerunner.com/api/v1/properties?parcelId=12-34-567-890" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl "https://app.withforerunner.com/api/v1/properties?geometry=%7B%22type%22%3A%20%22Polygon%22%2C%20%22coordinates%22%3A%20%5B%5B%5B-73.98836883114409%2C%2040.67402149000125%5D%2C%20%5B-73.98836883114409%2C%2040.66928110727923%5D%2C%20%5B-73.98070752927185%2C%2040.66928110727923%5D%2C%20%5B-73.98070752927185%2C%2040.67402149000125%5D%2C%20%5B-73.98836883114409%2C%2040.67402149000125%5D%5D%5D%7D" \
  -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": []
}

Overview

⌘I

Getting started

API reference

Integration

Query Parameters

Response

​Query Parameters

​Response

Query Parameters

Response