Get Boundary

GET 
/v4/boundaries/:id

This endpoint returns a single LiveBy Boundary based on a LiveBy Boundary ID. It includes the geometry for the boundary.

Request

Path Parameters

id stringrequired

The LiveBy Boundary ID obtained from the /v4/boundaries endpoint.

Responses

200

application/json

Schema

Schema

successbooleanrequired

data

object

idstringrequired

The LiveBy Boundary ID.

address

object

required

This is a geocoded point near the center of the shape. While the query parameters specify area-level-1 as a standard field, this address uses the local name for area names E.G. state, county, province, village.

postcodestring

citystring

municipalitystring

villagestring

districtstring

subdistrictstring

archipelagostring

territorystring

islandstring

provincestring

statestring

countystring

townshipstring

regionstring

townstring

localitystring

layerstringrequired

privatebooleanrequired

statusstringrequired

osmLevelnumbernullablerequired

Possible values: >= 1 and <= 11

namestringrequired

virtualLayersstring[]required

vectorTileIdnumberrequired

labelLocation

object

required

typestringrequired

coordinatesnumber[]required

Possible values: >= 2, <= 2

Example: [-96.662575133,40.79944225]

boundingBox

object

required

typestringrequired

coordinates

object

required

oneOf

Polygon

Array [

type

itemsnumber[]

Possible values: >= 2, <= 2

]

LineString

Array [

type

minItems

maxItems

itemsnumber

]

Point

Array [

number

]

geometry

object

The geometry for the boundary. This propertye is only included when includeGeometries is set to true when calling the /v4/boundaries endpoint. It is always returned when calling the /v4/boundaries/:id endpoint.

typestringrequired

coordinates

object

required

oneOf

MultiPolygon

Array [

type

itemsarray[]

Possible values: >= 2, <= 2

]

Polygon

Array [

type

itemsnumber[]

Possible values: >= 2, <= 2

]

associatedBoundaries

object[]

required

Array [

layerstringrequired

osmLevelnumbernullablerequired

Possible values: >= 1 and <= 11

boundaryIdstringrequired

namestringrequired

]

censusIdstringnullablerequired

createdAtdate-timerequired

updatedAtdate-timerequired

Example (from schema)

{
  "success": true,
  "data": {
    "id": "string",
    "address": {
      "postcode": "string",
      "city": "string",
      "municipality": "string",
      "village": "string",
      "district": "string",
      "subdistrict": "string",
      "archipelago": "string",
      "territory": "string",
      "island": "string",
      "province": "string",
      "state": "string",
      "county": "string",
      "township": "string",
      "region": "string",
      "town": "string",
      "locality": "string"
    },
    "layer": "string",
    "private": true,
    "status": "string",
    "osmLevel": 0,
    "name": "string",
    "virtualLayers": [
      "string"
    ],
    "vectorTileId": 0,
    "labelLocation": {
      "type": "string",
      "coordinates": [
        -96.662575133,
        40.79944225
      ]
    },
    "boundingBox": {
      "type": "string",
      "coordinates": [
        [
          [
            0
          ]
        ]
      ]
    },
    "geometry": {
      "type": "string",
      "coordinates": [
        [
          [
            [
              0
            ]
          ]
        ]
      ]
    },
    "associatedBoundaries": [
      {
        "layer": "string",
        "osmLevel": 0,
        "boundaryId": "string",
        "name": "string"
      }
    ],
    "censusId": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  }
}

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

504

Service Unavailable