Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Geocode

Forward geocode an address

geocode.forward(**kwargs) -> GeocodeResult { features, type }
GET/api/v1/geocode

Forward geocode an address

ParametersExpand Collapse
q: String

Address or place name

bbox: String

Bounding box filter: south,west,north,east

country_code: String

ISO 3166-1 alpha-2 country code filter

lang: String

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

lat: Float

Focus latitude

layer: String

Filter by layer: address, poi, or admin

limit: Integer

Maximum results (default 20, max 100)

lng: Float

Focus longitude

ReturnsExpand Collapse
class GeocodeResult { features, type }

GeoJSON FeatureCollection of geocoding results

features: Array[GeocodingFeature { geometry, properties, type } ]
geometry: GeoJsonGeometry { coordinates, type }
coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
Array[Float]
Array[Array[Float]]
Array[Array[Array[Float]]]
Array[Array[Array[Array[Float]]]]
type: :Point | :LineString | :Polygon | 3 more
One of the following:
:Point
:LineString
:Polygon
:MultiPoint
:MultiLineString
:MultiPolygon
properties: { country_code, display_name, distance_m, 4 more}
country_code: String

ISO 3166-1 alpha-2 country code

display_name: String

Formatted address or place name

distance_m: Float

Distance in meters

osm_id: Integer

OpenStreetMap ID

osm_type: String

OSM element type

score: Float

Match confidence score

source: String

Result source (address, place, interpolation)

type: :Feature
type: :FeatureCollection

Forward geocode an address

require "plaza"

plaza = Plaza::Client.new(
  api_key: "My API Key",
  environment: "local" # defaults to "production"
)

geocode_result = plaza.geocode.forward(q: "q")

puts(geocode_result)
Returns Examples