Boundaries Layout
Field Name | Description | Data Type |
---|---|---|
success | Indicates whether the request was successfully processed. | boolean |
pagination | Contains details about the pagination of the response, including page count and record limits. | object |
pageTotal | Total number of pages available in the response. | number |
limit | Maximum number of records per page. | number |
offset | The starting record number for the current page. | number |
data | An array containing boundary details. | object[] |
id | The unique identifier for the LiveBy Boundary. | string |
address | The geocoded address located near the center of the boundary shape. | object |
postcode | The postal code of the area covered by the boundary. | string |
city | The name of the city where the boundary is located. | string |
municipality |
A legally recognized administrative division within a state or province that has local governance authority, such as taxation, zoning, and public services.
Key Characteristics:
Example: {"municipality": "San Francisco"} |
string |
province | The name of the province or region the boundary belongs to. | string |
state | The state name associated with the boundary. | string |
county | The county name where the boundary is situated. | string |
layer |
The layer or layers used to obtain boundary information. LiveBy provides multiple layers, including standard and virtual layers.
Available Layers:
|
string |
private | Indicates whether the boundary is private and restricted to authorized users. | boolean |
status |
Indicates the availability and accuracy of the boundary data. The status helps in determining whether a boundary is valid, deprecated, or needs review.
Possible Status Values:
Example Usage: {"status": "Active"} |
string |
osmLevel | The OpenStreetMap (OSM) administrative level (1-11). | number |
name |
The official or commonly recognized name of the geographic boundary.
Usage:
Example: {"name": "Manhattan"} |
string |
virtualLayers |
A set of derived or aggregated layers created from existing boundary layers. These layers do not exist as physical boundaries but are constructed dynamically.
Examples of Virtual Layers:
Example Format: {"virtualLayers": ["municipality", "district"]} |
string[] |
vectorTileId |
A numerical identifier representing a geographic area within vector tile mapping systems. Used for efficient rendering and retrieval of map data.
Usage:
Example Format: {"vectorTileId": 12345678} |
number |
labelLocation |
The recommended location to place a label for the boundary on a map. This is typically the centroid of the boundary or another optimized point ensuring proper placement of labels.
Types:
Example Format: {"labelLocation": {"latitude": 40.7128, "longitude": -74.0060}} |
object |
boundingBox |
A rectangular bounding box that encloses the boundary geometry. This helps define the extent of the shape and is useful for map rendering.
Types:
|
object |
geometry |
The geometric representation of the boundary in GeoJSON format.
Types:
|
object |
censusId |
A unique identifier assigned to a geographical boundary in census data. Used for demographic and statistical analysis.
Usage:
Example Format: {"censusId": "060750101001"}Breakdown (U.S. FIPS Code Example):
|
string |
createdAt | The timestamp indicating when the boundary record was created. | date-time |
updatedAt | The timestamp indicating the last update of the boundary record. | date-time |