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

--format: optional string

Response format: json (default), geojson, csv, ndjson

--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 forward geocoding results, ordered by relevance. Content-Type: application/geo+json.

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

Geocoding results ordered by relevance score

geometry: object { coordinates, type }

GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

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

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

Point: array of number

[longitude, latitude] or [longitude, latitude, elevation]

LineString or MultiPoint: array of array of number

Array of [lng, lat] positions

Polygon or MultiLineString: array of array of array of number

Array of linear rings / line strings

MultiPolygon: array of array of array of array of number

Array of polygons

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

Geometry type

"Point"

"LineString"

"Polygon"

"MultiPoint"

"MultiLineString"

"MultiPolygon"

properties: object { display_name, category, city, 18 more }

Geocoding result properties

display_name: string

Formatted address or place name

category: optional string

POI category (e.g. restaurant, cafe, park). Present for place results.

city: optional string

City or town name. Present for address results.

confidence: optional number

Interpolation confidence (0-1). Present only for interpolated results.

country: optional string

Country name. Present for reverse geocode address results.

country_code: optional string

ISO 3166-1 alpha-2 country code

distance_m: optional number

Distance from the query point in meters (reverse geocode / nearby only)

full_address: optional string

Complete formatted address from the database. Present for reverse geocode address results.

house_number: optional string

House or building number. Present for address and interpolated results.

interpolated: optional boolean

Whether this result was estimated by address interpolation rather than an exact database match.

name: optional string

Place name (raw). Present for reverse geocode place results.

osm_id: optional number

OpenStreetMap element ID (null for interpolated results)

osm_type: optional "node" or "way" or "relation"

OSM element type (node, way, relation)

"node"

"way"

"relation"

postcode: optional string

Postal code. Present for reverse geocode address results.

score: optional number

Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1.

source: optional "structured" or "bm25" or "fuzzy" or 3 more

Result source indicating how the result was found: structured (exact field match), bm25 (full-text search), fuzzy (trigram similarity), address (reverse geocode address), place (reverse geocode POI), interpolation (estimated from neighboring addresses)

"structured"

"bm25"

"fuzzy"

"address"

"place"

"interpolation"

state: optional string

State or province name. Present for reverse geocode address results.

street: optional string

Street name. Present for address and interpolated results.

subcategory: optional string

POI subcategory. Present for place results.

tags: optional map[string]

Raw OSM tags. Present for place results.

wikipedia: optional string

Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places.

type: "Feature"

"Feature"

type: "FeatureCollection"

"FeatureCollection"