Searching for properties

POST https://api.reonomy.com/v2/search/summaries

This endpoint returns the property IDs and coordinates of properties that meet certain criteria, for example, properties in New York City of at least 100,000 square feet. This endpoint is used when you search for properties using the filter options in the Reonomy app.

To use this endpoint, include a settings object in the request body specifying the search parameters, as shown in the example. For a list of all available settings attributes, see POST /search/summaries.

Note: If you want to specify a range (for example, properties between 100,000 and 250,000 square feet), you can specify min and max values.

When you make a request to POST /search/summaries, the response includes:

• A count of the total number of matching properties
• An items list with information about each of the first n matching items, including the property ID (id) and the property's latitude and longitude (location). Use the Map tab to see where the properties are located.

By default, you'll get the first 10 matching items. Use the limit attribute in the request body to request up to 10,000 matching items. This example uses "limit": 100.

To request additional matching items beyond the first 10 (or the limit you specified), re-run the request with the search_token as a query parameter. See Pagination below for details.

You can use the id as the path parameter in GET /property/{property_id}, or you can pass a list of IDs to POST /property/bulk to get information about matching properties (see Getting property details for more information). Click the IDs tab to view a list with just the property IDs that you can use with POST /v2/property/bulk.

If you use the Reonomy web app, you can import an existing web app search to use as the POST /search/summaries request body:

1. On the Reonomy web app Search page, select a search from your "Saved Searches" or "Recent Searches."
2. Copy the URL from the browser address bar.
3. Paste the URL into the field below. You'll see the search query in the example code on the right.

After importing a web app search, you can run the search query and see the response by clicking the ► RUN button in the code example component above.

POST /search/summaries returns the first 10 matching items, or the number you requested using the limit parameter (maximum 10,000).

To request additional matching items, re-run the search request but include the search_token returned in the response as a query parameter, as shown in the example.

You can rerun the request with the search token multiple times until you've received all the matching items (the count value in the response).

Note: The search token expires 30 seconds after executing the initial search. The API returns HTTP status code 400 if the search token has expired.

To try an asset type search, select one or more asset categories or land use code descriptions below. If you want to narrow your search by geography, enter one or more FIPS codes in the fips field. If you've entered your API access token, you can use the ► RUN button to run your request against the Reonomy API and see the response.

The default response includes the count of properties that match the search criteria, as well as the property ID and update information for the first 10 items.

If you run the query and get an AuthorizationException, use the Access Token button in the top navigation bar to set your API access token.

Certain fields within thesettings object let you specify date ranges, for example:

• master_update_time: The last time any of the property data was updated.
• sale_update_time: The last time sale information was updated
• foreclosure_aution_date: The foreclosure auction date

For these date fields, there are various ways to specify date ranges:

• You can specify a min (earliest) date and a max (most recent) date, for example:

  "master_update_time": {
    "min": "1970-01-10",
    "max": "2010-05-01"
  }
  

• You can specify relative dates using relative_min (earliest) and relative_max (most recent), for example, between 100 days ago and 50 days ago:

  "sale_update_time": {
    "relative_min": -100,
    "relative_max": -50,
  }
  

• When specifying a range, setting inclusive to false (the default is true) returns properties outside the specified range:

  "mtg_update_time": {
    "inclusive": false,
    "min": "2019-01-01",
    "max": "2019-12-31"
  }
  

Click the name field below to see the available sort fields. If you've entered your API access token, click the ► RUN button to see how changing the sort and order fields affects the response.

Given the limited information in the POST /search/summaries response, it won't be obvious that the results are sorted. If you extract the resulting property IDs and pass them to POST /v2/property/bulk, you can confirm they are sorted.

You can also sort the search results by distance from a specified point. To do this, enter the point's latitude and longitude in the sort parameter's location field. Then select location in the name field. Setting the order to asc will sort the results with the property closest to the specified point first.

Results are returned based on the distance from the specified point.

To try a radius search, select one or more asset_category types, and enter the point coordinates and search radius into the circles fields below. If you've entered your API access token, you can use the ► RUN button to run your request against the Reonomy API and see the response.

The POST /v2/search/summaries endpoint returns:

• A count of the total number of matching properties.
• An items array with information about each of the first 10 matching items, including the property ID (id).

You can use the id as the path parameter in GET /property/{property_id} to get property data for each matching property. See Getting property details for more information.

The POST /v2/search/summaries endpoint returns:

• A count of the total number of matching properties.
• An items array with information about each of the first 10 matching items, including the property ID (id).

You can use the id as the path parameter in GET /property/{property_id} to get property data for each matching property. See Getting property details for more information.

The POST /v2/search/summaries endpoint returns:

• A count of the total number of matching properties.
• An items array with information about each of the first 10 matching items, including the property ID (id).

You can use the id as the path parameter in GET /property/{property_id} to get property data for each matching property. See Getting property details for more information.

There are three ways you can search using this endpoint:

• By address, using the property's street address (as shown in the example).
• By location, using the property's latitude and longitude.
• By place, using the property's name (for well known places like the Empire State Building).

You must specify a params object in the request body, and the params object must include an address object, a location object, or a place object. See the following sections for details:

• Searching by address
• Searching by location
• Searching by place

If there's a match, the API returns a params object with the data you provided, plus the following response attributes:

• property_id: The matching property's Reonomy ID
• shape_id: Not used
• status: OK if the search returned a match; PARTIAL or MISS otherwise (see Missing properties)
• status_code: null if the search returned a match; see Missing properties for other status codes

To search for a property using its street address, specify an address object in the request body's params parameter, as shown in the example. If there are multiple properties at the same address, the API returns the property on the largest parcel. The address object supports the attributes shown below.

To search for a property using its latitude/longitude, specify a location object in the request body's params parameter, as shown in the example.

The API lets you locate properties by place name. To search by place name, specify a place object in the request body's params parameter, as shown in the example.

To try a bounding box search, enter the coordinates of the bottom right and top left corners below. The prefilled values define the bounding box shown in the example (a location in New York City), but you can edit these or enter any values you want. If you've entered your API access token, you can use the ► RUN button to run your request against the Reonomy API and see the response.

The POST /v2/search/parcel-shapes endpoint returns:

• A count of the total number of parcels (tax lots) intersecting with or close to the search bounding box.
• An items array with the GeoJSON geometry definitions for each parcel. By default you get the first 10 items. The limit set for this example is 100.

Within the response, the geometry specifies a list of coordinate pairs defining the vertices of the parcel according to the GeoJSON specification:

• The GeoJSON tab displays the parcel geometries as a GeoJSON FeatureCollection that includes the search bounding box as the first feature. You can copy and paste the GeoJSON into a tool like geojson.io.
• The Map tab displays the parcel shapes on a map, with the search bounding box displayed in pink.

The POST /v2/search/parcel-shapes endpoint returns:

• A count of the total number of parcels (tax lots) contained by or intersecting with the search bounding box.
• An items array with the GeoJSON geometry definitions for each parcel. By default you get the first 10 items. The limit set for this example is 100.

The Response tabs on the right include two additional tabs for viewing the API response:

• The GeoJSON tab displays the parcel geometries as a GeoJSON FeatureCollection that includes the search bounding box as the first feature. You can copy and paste the GeoJSON into a tool like geojson.io.
• The Map tab displays the parcel shapes on a map, with the search bounding box displayed in pink.

Note that the API response does not include the property IDs associated with the parcels. To find property IDs, use one of the other search methods described on this page.