Skip to main content

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​

Schema

    success booleanrequired

    data

    object

    id stringrequired

    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.

    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 stringrequired
    private booleanrequired
    status stringrequired
    osmLevel numbernullablerequired

    Possible values: >= 1 and <= 11

    name stringrequired
    virtualLayers string[]required

    labelLocation

    object

    required

    type stringrequired
    coordinates number[]required

    Possible values: >= 2, <= 2

    Example: [-96.662575133,40.79944225]

    boundingBox

    object

    required

    type stringrequired

    coordinates

    object

    required

    oneOf

  • Array [

    • type
    items number[]

    Possible values: >= 2, <= 2

  • ]

    • 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.

    type stringrequired

    coordinates

    object

    required

    oneOf

  • Array [

    • type
    items array[]

    Possible values: >= 2, <= 2

  • ]

    • associatedBoundaries

    object[]

    required

  • Array [

    • layer stringrequired
    osmLevel numbernullablerequired

    Possible values: >= 1 and <= 11

    boundaryId stringrequired
    name stringrequired

  • ]

    • censusId stringnullablerequired
    createdAt date-timerequired
    updatedAt date-timerequired