SHshovels
Decisions

Search Decisions

Changed on

Returns a list of zoning / land-use decisions matching the supplied filters. Decisions should meet ALL parameter filters (AND logic). Date range (decision_from/decision_to) and geo_id are required.

get/decisions/search

Request

  • Base URL
    https://api.shovels.ai/v2
  • Auth
    API key in header X-API-Key

Query parameters

cursorstring nullable

Cursor for pagination

sizeinteger
include_countboolean

Count first-page matches in the top-level total_count object: {"value": 970, "relation": "eq"}. "eq" means an exact count up to 10,000. Above 10,000, value is 10,000 and relation is "gte", meaning at least that many matches. total_count is null when false, when a cursor is supplied, or when the count query times out.

decision_fromstring date required

Return decisions with decision_date on or after this date. Date format: YYYY-MM-DD.

decision_tostring date required

Return decisions with decision_date on or before this date. Date format: YYYY-MM-DD.

geo_idstring required

Filter decisions by geographic area. Accepts:

  • US state code (e.g. CA)
  • Shovels geolocation ID for an address, city, county, or jurisdiction (e.g. a4xysKbZwqg)

ZIP and ZIP+4 inputs are not supported — the upstream rezone source emits no ZIP information, so decisions cannot be filtered by ZIP.

Resolve addresses and places to geolocation IDs via:

  • Search Addresses
  • Search Cities
  • Search Counties
  • Search Jurisdictions

Free-form text such as "123 Main St" is not accepted.

asset_classstring[] nullable

Filter by one or more asset classes (e.g. Residential, Commercial, Mixed-Use).

categorystring[] nullable

Filter by one or more decision categories (e.g. Rezoning, Variance).

subcategorystring[] nullable

Filter by one or more decision subcategories.

property_typestring[] nullable

Filter by one or more property types.

min_project_valueinteger nullable

Minimum project value in cents (inclusive).

max_project_valueinteger nullable

Maximum project value in cents (inclusive).

decision_qstring nullable

Full-text query against decision title and description, tokenized with PostgreSQL plainto_tsquery('english', ...).

Response

A list of decisions.

sizeinteger required

The number of items returned in the response.

next_cursorstring nullable required

The cursor for retrieving the next page of results.

Changes

  • 64df4c8074f5Revision changes
    • breaking

      for the query request parameter size, default value was changed from 50 to 10

  • 685b8866c451Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status