Documentation menu

← Jurisdictions

API reference

Get a jurisdiction

GET/v1/jurisdiction/{jurisdiction_id}

A jurisdiction, with its fips, every identifier it holds, within, the jurisdictions that contain it, and coverage, what is held for it.

Its id does not change when its name or boundary does.

Parameters

path

jurisdiction_idrequiredstring
The jurisdiction's id.

Responses

200
Jurisdiction
Successful Response
401
ProblemDetail
credential_missing, credential_invalid or credential_expired: send a live API key as Authorization: Bearer <key>.
402
ProblemDetail
quota_exhausted: the balance can't cover the call. Nothing was charged and nothing was returned.
403
ProblemDetail
scope_missing, person_required or entitlement_missing: this credential or plan can't do this. detail says which.
404
empty
no_such_resource: no jurisdiction has this id.
409
ProblemDetail
version_conflict: the record changed since you read it. Read it again and resend.
422
ProblemDetail
parameter_invalid, id_malformed or a cursor code: a parameter's value isn't one this operation takes.
429
ProblemDetail
rate_limited: wait for Retry-After, then send it again. Not charged.
501
empty
not_available: no jurisdictions are published yet.

Example request

curl -X GET 'https://api.placestack.com/v1/jurisdiction/jurisdiction_id_123' \
  -H 'Authorization: Bearer $PLACESTACK_API_KEY'

Example response

{
  "object": "jurisdiction",
  "id": "jur_01h455vb4pex5vsknk084sn02q",
  "name": "<Name>",
  "legal_name": "string",
  "type": "<Type>",
  "tier": "national",
  "country": "<Country>",
  "lifecycle_status": "<Lifecycle Status>",
  "fips": {
    "level": "state",
    "code": "<Code>",
    "state": "<State>",
    "county": "string"
  },
  "identifier": [
    {
      "scheme": "<Scheme>",
      "value": "<Value>"
    }
  ],
  "within": [
    {
      "id": "jur_01h455vb4pex5vsknk084sn02q",
      "name": "<Name>",
      "tier": "national",
      "type": "<Type>",
      "partial": true,
      "fips": "string"
    }
  ],
  "land_area_m2": 1,
  "water_area_m2": 1,
  "centroid": {
    "lat": 1.25,
    "lon": 1.25
  },
  "coverage": {
    "parcel": "<Held>"
  },
  "href": "<Href>"
}

The rest of jurisdiction.

Next

Webhooks

webhook.