Skip to main content

Autocomplete Boundary Search beta

GET 
/v4/boundaries/autocomplete

This endpoint is in beta and not yet ready for production. Check out the LiveBy API Beta Endpoints Program for more information.

This endpoint returns a list of boundaries based on search criteria.

Request​

Query Parameters

    search stringrequired

    The text search query you would like to use to search for boundaries. All searches are case-insensitive.

    layer string[]

    The layer or layers you seek to obtain boundary information from.

    Possible values: [city, postal-code, area-level-1, area-level-2, postal-city, district, neighborhood, micro-neighborhood, subdivision, school-district, school-attendance-area]

    Default value: [postal-code, neighborhood, district, city, area-level-1, area-level-2]

    area-level-1 string[]

    The first political subdivision of a country for which you seek to obtain boundary information from. Common equivalents are states or provinces. Use the full name.

    area-level-2 string[]

    The second political subdivision of a country which you seek to obtain boundary information from. Common equivalents are Counties or Parishes Use the full name. Not guaranteed in every country.

    Examples:

    Example: King

    mls string[]

    The MLS code you want associated boundary IDs from.

    Example: &mls=recolorado&mls=pikespeak
    latitude number

    The latitude used to sort-by distance

    longitude number

    The longitude used to sort-by distance

    sort-by string

    Sort by the following parameters. By default, they will be sorted in order of how well they match the search (score).

    Possible values: [score, name, layer, population, distance]

    Default value: score

    sort-direction string

    Direction to sort the results.

    Possible values: [asc, desc]

    Default value: desc

    limit number

    The number of records you would like returned. The default is 20, the maximum is 50.

    Default value: 20

    offset number

    Used for pagination, the number of records for the collection to skip.

    Default value: 0

Responses​

Schema

    success booleanrequired

    pagination

    object

    required

    pageTotal numberrequired
    limit numberrequired
    offset numberrequired

    data

    object[]

  • Array [

    • id stringrequired

    The LiveBy Boundary ID.

    layer stringrequired
    name stringrequired
    vectorTileId numberrequired

    boundingBox

    object

    required

    type stringrequired

    coordinates

    object

    required

    oneOf

  • Array [

    • type
    items number[]

    Possible values: >= 2, <= 2

  • ]

    • address

    object

    required

    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

  • ]