Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Placestack Webhook API
summary: The Placestack API.
description: 'The Placestack API: US parcels, zoning and jurisdictions.
## Paths
Paths are singular nouns, such as `/v1/parcel` and `/v1/parcel/{parcel_id}`.
## Pagination
Lists return a page at a time. Send a page''s `next_cursor` as `cursor` to get the next one, and `size`
to set the page size. Where an endpoint takes `sort`, `sort=field` sorts ascending and `sort=-field`
descending.
## Errors
Errors are RFC 9457 problem details (`application/problem+json`) with `type`, `title`, `status`,
`detail`, `code` and `field`. Handle errors by `code`.
## Updates
Updates accept an `If-Match` header with the `ETag` from your last read. A stale `ETag` is refused
with `409 version_conflict`.
## Credits
A lookup costs one credit: a parcel by address, number, point or id, or the zoning at a place. A search
costs 1 credit per 20 results, and one zoning classification, permit or case costs one credit. The
same lookup is free again for 24 hours. Requests that return nothing are free, as are jurisdictions,
suggestions and account endpoints. `GET /v1/me` returns the credit balance.
## GeoJSON
`/v1/parcel`, `/v1/zoning` and `/v1/jurisdiction` return GeoJSON with `format=geojson` or
`Accept: application/geo+json`: a `FeatureCollection` for a list, a `Feature` for one object. The
boundary is the geometry and the object is the properties. `include=geometry` adds the boundary to
the JSON response instead.
## Webhooks
Deliveries are signed with Standard Webhooks headers (`webhook-id`, `webhook-timestamp`,
`webhook-signature`), so any Standard Webhooks library can verify them. An event can be delivered
more than once: deduplicate on `webhook-id`. `GET /event_type` lists the event types.
A `permit.created` or `case.created` event''s `data` holds the record''s `id` and `href`, and the
`monitor` and `list_item` ids it matched. Retrieve the record at `href`, which costs a credit.'
version: 0.0.0
servers:
- url: http://localhost:3030
description: Development.
tags:
# --- truncated at 32 KB (47 KB total) ---
# Full source: https://artifacts.apis.io/placestack-com/openapi/placestack-com-webhook-api-openapi.yml