Forward geocode an address

$ plaza geocode forward

GET/api/v1/geocode

ParametersExpand Collapse

--q: string

Address or place name

--bbox: optional string

Bounding box filter: south,west,north,east

--country-code: optional string

ISO 3166-1 alpha-2 country code filter

--lang: optional string

Language code for localized names (e.g. en, de, fr)

--lat: optional number

Focus latitude

--layer: optional string

Filter by layer: address, poi, or admin

--limit: optional number

Maximum results (default 20, max 100)

--lng: optional number

Focus longitude

ReturnsExpand Collapse

geocode_result: object { features, type }

GeoJSON FeatureCollection of geocoding results

features: array of GeocodingFeature { geometry, properties, type }

geometry: object { coordinates, type }

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

union_member_0: array of number

union_member_1: array of array of number

union_member_2: array of array of array of number

union_member_3: array of array of array of array of number

type: "Point" or "LineString" or "Polygon" or 3 more

"Point"

"LineString"

"Polygon"

"MultiPoint"

"MultiLineString"

"MultiPolygon"

properties: object { country_code, display_name, distance_m, 4 more }

country_code: optional string

ISO 3166-1 alpha-2 country code

display_name: optional string

Formatted address or place name

distance_m: optional number

Distance in meters

osm_id: optional number

OpenStreetMap ID

osm_type: optional string

OSM element type

score: optional number

Match confidence score

source: optional string

Result source (address, place, interpolation)

type: "Feature"

"Feature"

type: "FeatureCollection"

"FeatureCollection"