Boundaries Layout

Field Name Description Data Type
successIndicates whether the request was successfully processed.boolean
paginationContains details about the pagination of the response, including page count and record limits.object
pageTotalTotal number of pages available in the response.number
limitMaximum number of records per page.number
offsetThe starting record number for the current page.number
dataAn array containing boundary details.object[]
idThe unique identifier for the LiveBy Boundary.string
addressThe geocoded address located near the center of the boundary shape.object
postcodeThe postal code of the area covered by the boundary.string
cityThe 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:
  • Includes cities, towns, boroughs, and townships.
  • Defined by government agencies and may not always match common usage boundaries.
  • Not all municipalities align with postal cities or neighborhoods.

Example: 
{"municipality": "San Francisco"}
 string
provinceThe name of the province or region the boundary belongs to.string
stateThe state name associated with the boundary.string
countyThe 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:
  • City (city) - Boundaries of hamlets, villages, towns, and cities.
  • Postal City (postal-city) - Post office coverage area for a city.
  • Municipalities (municipality) - Taxed municipalities with local governance.
  • Districts (district) - Larger boundaries covering multiple neighborhoods.
  • Neighborhoods (neighborhood) - Geographically defined residential or mixed-use parcels.
  • Micro Neighborhoods (micro-neighborhood) - Smaller polygons within broader neighborhoods.
  • Subdivisions (subdivision) - Multi-parcel allotments defined by local authorities.
  • Postal Codes (postal-code) - Service areas defined by postal codes.
  • School Districts (school-district) - Administrative school boundaries.
  • School Attendance Areas (school-attendance-area) - Geographic zones assigned to schools.
  • State/Province (area-level-1) - First-level administrative divisions (e.g., states, provinces).
  • County (area-level-2) - Second-level administrative divisions (e.g., counties, parishes).
 string
privateIndicates 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:
  • Active: The boundary is up-to-date and valid.
  • Deprecated: The boundary is outdated and may no longer be in use.
  • Pending Review: The boundary is under evaluation and may change.
  • Incomplete: The boundary exists but lacks full details.

Example Usage: 
{"status": "Active"}
 string
osmLevelThe OpenStreetMap (OSM) administrative level (1-11).number
name The official or commonly recognized name of the geographic boundary.

Usage:
  • Represents the name of the boundary for display and reference.
  • Can be the name of a city, neighborhood, postal zone, or other defined boundary.

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:
  • Municipalities: Derived from various city and town boundaries.
  • Service Areas: Created by combining different administrative boundaries.

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:
  • Optimizes map performance by allowing partial map rendering.
  • Helps in identifying and retrieving specific tile-based boundary data.

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:
  • Point: A single latitude and longitude coordinate used for labeling.
  • Polygon Centroid: The geometric center of the boundary, used for larger areas.
  • Optimized Point: A manually selected or algorithmically optimized location for better label placement.

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:
  • Point: Represented as a single coordinate (longitude, latitude).
  • Polygon: A closed shape with multiple points defining the boundary.
  • LineString: A sequence of connected points forming a path.
 object
geometry The geometric representation of the boundary in GeoJSON format.

Types:
  • Polygon: A closed shape defining a single geographic area.
  • MultiPolygon: A collection of multiple polygons, used for boundaries with islands or separated areas.
 object
censusId A unique identifier assigned to a geographical boundary in census data. Used for demographic and statistical analysis.

Usage:
  • Links boundary data to census statistics.
  • Used in urban planning and government reporting.
  • Maps to census-designated areas such as cities, counties, or school districts.

Example Format: 
{"censusId": "060750101001"}
Breakdown (U.S. FIPS Code Example):
  • First 2 digits = State Code
  • Next 3 digits = County Code
  • Remaining digits = Tract or Block Code
 string
createdAtThe timestamp indicating when the boundary record was created.date-time
updatedAtThe timestamp indicating the last update of the boundary record.date-time
Full Detail information Confidential. Not for Distribution.