API reference
Parcels
Get the recorded rules for one parcel.
Get parcel restrictions
GET /v1/parcels/{apn}/restrictionsReturns every rule linked to a parcel, and the documents the rules came from.
Path parameters
| Parameter | Type | Description |
|---|---|---|
apn | string | The assessor's parcel number, digits only |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
county | string | Yes | County name, for example Franklin |
state | string | No | Two-letter state code. The default is WA |
Example
curl "https://api.setback.io/v1/parcels/118112024/restrictions?county=Franklin" \
-H "Authorization: Bearer YOUR_API_KEY"Response
A real response, cut to one rule:
{
"parcel": {
"apn": "118112024",
"county": "Franklin",
"state": "WA"
},
"restrictions": [
{
"fact_type": "min_lease_term",
"value": { "value": "thirty (30) days" },
"confidence": 0.95,
"status": "extracted",
"page_number": 7,
"document_id": "e4354cfb-7fa7-4f35-ba2f-01a1857c446b",
"quote": "Not less than the whole of any Lot or Living Unit may be leased or rented, nor shall any Lot or Living Unit be leased or rented for a period of fewer than thirty (30) days.",
"quote_marks": [[155, 171]]
}
],
"document_ids": ["e4354cfb-7fa7-4f35-ba2f-01a1857c446b"]
}page_number is the page of the recorded document that holds the rule. Get the document with GET /v1/documents/{id}.
quote is the covenant sentence the rule came from, as read from the scan. quote_marks are [start, end] ranges of the rule's own words inside quote. Each range counts in UTF-16 code units, the same as JavaScript string indexes. Both fields are left out when we could not read the wording with confidence.
Errors
| Status | When |
|---|---|
400 | county is missing |
404 | No covered document links to this parcel |