Search Boundaries
GET/v4/boundaries
Get a list of boundaries based on search criteria.
Request
Query Parameters
- Denver
- Los Angeles
- Saint Louis
- Salt Lake City
- Coeur D Alene
- King
- Miami-Dade
- Los Alamos
- name
- layer
- updated-at
The name of the boundary you seek to obtain boundary information from. This can be a full state name (eg. Nebraska), city name, neighborhood name, postal code, etc.
The country for which you seek to obtain boundary information from. Default is USA.
The city used by the post office for which you seek to obtain boundary information from. Use the full name. All abbreviations should be spelt out entirely EG: St. Louis ⇒ Saint Louis, L.A. ⇒ Los Angeles, Coeur D'Alene ⇒ Coeur D Alene.
Example: Denver
Example: Los Angeles
Example: Saint Louis
Example: Salt Lake City
Example: Coeur D Alene
The layer or layers you seek to obtain boundary information from.
LiveBy providers many layers of boundaries. We also provide virtual layers. Virtual layers are layers that are made from other layers. See our virtual layers guide for more information.
The available boundary layers are as follows:
Layer | Value | Description | Virtual |
---|---|---|---|
Cities, Towns, or equivalent | city | Boundaries of hamlets, villages, towns, cities, and census-designated places. | No |
Postal City | postal-city | Boundaries the post office covers for a city. See Cities vs Postal Cities for more information on the differences between communities and postal cities. | No |
Municipalities | municipality | Only municipalities that have taxes, addresses, mayors, etc. | Yes |
Districts | district | Larger boundaries covering multiple smaller neighborhoods in metropolitan areas. | No |
Neighborhoods | neighborhood | Geographically bound collections of residential or mixed-use parcels. | No |
Micro Neighborhoods | micro-neighborhood | Smaller polygons within broader neighborhood boundaries. | No |
Subdivisions | subdivision | Multi-parcel allotments defined by local municipalities. | No |
Postal Codes | postal-code | Service areas of postal codes across countries. | No |
School Districts | school-district | Single-purpose governmental units operating schools at the local level. | No |
School Attendance Areas | school-attendance-area | Geographic extent served by a local school for student assignment. | No |
State, Province, or equivalent | area-level-1 | First administrative subdivision of a country. These commonly have that name of State or Province or District. | No |
County, Parish, or equivalent | area-level-2 | Second administrative subdivision. These are commonly called counties. Not available in all countries. | No |
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.
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.
Example: King
Example: Miami-Dade
Example: Los Alamos
The MLS code you want associated boundary IDs from.
The latitude for which you seek to obtain boundary information from. This will use a default radius of 10 miles. If you would like to change the radius, use the radius argument.
The longitude for which you seek to obtain boundary information from. This will use a default radius of 10 miles. If you would like to change the radius, use the radius argument.
If you are using the coordinates argument, you may change the radius of your search. The default radius is 10 miles. You may use decimals as well. If you would like to get only boundaries that intersect the exact point, set the radius to 0.
Default value: 10
The east edge of a bounding box to return results from. All four directions (west, south, north, and east) are required if creating a bounding box. These are coordinates that will be used to search for boundaries. Only boundaries that touch this bounding box will be returned. If the coordinates parameter is used, this parameter is ignored.
The west edge of a bounding box to return results from. All four directions (west, south, north, and east) are required if creating a bounding box. These are coordinates that will be used to search for boundaries. Only boundaries that touch this bounding box will be returned. If the coordinates parameter is used, this parameter is ignored.
The south edge of a bounding box to return results from. All four directions (west, south, north, and east) are required if creating a bounding box. These are coordinates that will be used to search for boundaries. Only boundaries that touch this bounding box will be returned. If the coordinates parameter is used, this parameter is ignored.
The north edge of a bounding box to return results from. All four directions (west, south, north, and east) are required if creating a bounding box. These are coordinates that will be used to search for boundaries. Only boundaries that touch this bounding box will be returned. If the coordinates parameter is used, this parameter is ignored.
The postal code for which you seek to obtain boundary information from.
The number of records you would like returned. The default is 20, the maximum is 500.
Default value: 20
Used for pagination, the number of records for the collection to skip.
Default value: 0
Sort by the following parameters.
Possible values: [name
, layer
, updated-at
]
Filtering by intersection-boundary-id will return boundaries that intersect with that boundary. Example: Neighborhoods in Denver, Colorado could be found by using a intersection-boundary-id filter with the id for the city of Denver and layer filter of "neighborhood"
Include the geometry of the boundary in the response. This will increase the response time and the size of the response.
Default value: false
Responses
- 200
- 401
- 403
- 429
- 500
- 504
- application/json
- Schema
- Example (from schema)
Schema
Array [
- Polygon
- LineString
- Point
Array [
]
Array [
]
Array [
]
- MultiPolygon
- Polygon
Array [
]
Array [
]
]
pagination
object
required
data
object[]
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.
Possible values: >= 1
and <= 11
labelLocation
object
required
Possible values: >= 2
, <= 2
[-96.662575133,40.79944225]
boundingBox
object
required
coordinates
object
required
oneOf
Possible values: >= 2
, <= 2
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.
coordinates
object
required
oneOf
Possible values: >= 2
, <= 2
Possible values: >= 2
, <= 2
{
"success": true,
"pagination": {
"pageTotal": 0,
"limit": 0,
"offset": 0
},
"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
]
]
]
]
},
"censusId": "string",
"createdAt": "2024-07-29T15:51:28.071Z",
"updatedAt": "2024-07-29T15:51:28.071Z"
}
]
}
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
Service Unavailable