# Geocode ## Forward geocode an address `geocode.forward(**kwargs) -> GeocodeResult` **get** `/api/v1/geocode` Forward geocode an address ### Parameters - `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 ### Returns - `class GeocodeResult` GeoJSON FeatureCollection of forward geocoding results, ordered by relevance. Content-Type: `application/geo+json`. - `features: Array[GeocodingFeature]` Geocoding results ordered by relevance score - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array[Float]` [longitude, latitude] or [longitude, latitude, elevation] - `Array[Array[Float]]` Array of [lng, lat] positions - `Array[Array[Array[Float]]]` Array of linear rings / line strings - `Array[Array[Array[Array[Float]]]]` Array of polygons - `type: :Point | :LineString | :Polygon | 3 more` Geometry type - `:Point` - `:LineString` - `:Polygon` - `:MultiPoint` - `:MultiLineString` - `:MultiPolygon` - `properties: { display_name, category, city, 18 more}` Geocoding result properties - `display_name: String` Formatted address or place name - `category: String` POI category (e.g. restaurant, cafe, park). Present for place results. - `city: String` City or town name. Present for address results. - `confidence: Float` Interpolation confidence (0-1). Present only for interpolated results. - `country: String` Country name. Present for reverse geocode address results. - `country_code: String` ISO 3166-1 alpha-2 country code - `distance_m: Float` Distance from the query point in meters (reverse geocode / nearby only) - `full_address: String` Complete formatted address from the database. Present for reverse geocode address results. - `house_number: String` House or building number. Present for address and interpolated results. - `interpolated: bool` Whether this result was estimated by address interpolation rather than an exact database match. - `name: String` Place name (raw). Present for reverse geocode place results. - `osm_id: Integer` OpenStreetMap element ID (null for interpolated results) - `osm_type: :node | :way | :relation` OSM element type (node, way, relation) - `:node` - `:way` - `:relation` - `postcode: String` Postal code. Present for reverse geocode address results. - `score: Float` Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1. - `source: :structured | :bm25 | :fuzzy | 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: String` State or province name. Present for reverse geocode address results. - `street: String` Street name. Present for address and interpolated results. - `subcategory: String` POI subcategory. Present for place results. - `tags: Hash[Symbol, String]` Raw OSM tags. Present for place results. - `wikipedia: String` Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places. - `type: :Feature` - `:Feature` - `type: :FeatureCollection` - `:FeatureCollection` ### Example ```ruby 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) ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "display_name": "221B Baker Street, London, NW1 6XE, United Kingdom", "category": "restaurant", "city": "London", "confidence": 0, "country": "United Kingdom", "country_code": "GB", "distance_m": 0, "full_address": "221B Baker Street, London, NW1 6XE, United Kingdom", "house_number": "221B", "interpolated": true, "name": "Eiffel Tower", "osm_id": 21154906, "osm_type": "node", "postcode": "NW1 6XE", "score": 0, "source": "structured", "state": "England", "street": "Baker Street", "subcategory": "italian", "tags": { "foo": "string" }, "wikipedia": "en:Eiffel Tower" }, "type": "Feature" } ], "type": "FeatureCollection" } ``` ## Forward geocode an address `geocode.forward_post(**kwargs) -> GeocodeResult` **post** `/api/v1/geocode` Forward geocode an address ### Parameters - `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 ### Returns - `class GeocodeResult` GeoJSON FeatureCollection of forward geocoding results, ordered by relevance. Content-Type: `application/geo+json`. - `features: Array[GeocodingFeature]` Geocoding results ordered by relevance score - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array[Float]` [longitude, latitude] or [longitude, latitude, elevation] - `Array[Array[Float]]` Array of [lng, lat] positions - `Array[Array[Array[Float]]]` Array of linear rings / line strings - `Array[Array[Array[Array[Float]]]]` Array of polygons - `type: :Point | :LineString | :Polygon | 3 more` Geometry type - `:Point` - `:LineString` - `:Polygon` - `:MultiPoint` - `:MultiLineString` - `:MultiPolygon` - `properties: { display_name, category, city, 18 more}` Geocoding result properties - `display_name: String` Formatted address or place name - `category: String` POI category (e.g. restaurant, cafe, park). Present for place results. - `city: String` City or town name. Present for address results. - `confidence: Float` Interpolation confidence (0-1). Present only for interpolated results. - `country: String` Country name. Present for reverse geocode address results. - `country_code: String` ISO 3166-1 alpha-2 country code - `distance_m: Float` Distance from the query point in meters (reverse geocode / nearby only) - `full_address: String` Complete formatted address from the database. Present for reverse geocode address results. - `house_number: String` House or building number. Present for address and interpolated results. - `interpolated: bool` Whether this result was estimated by address interpolation rather than an exact database match. - `name: String` Place name (raw). Present for reverse geocode place results. - `osm_id: Integer` OpenStreetMap element ID (null for interpolated results) - `osm_type: :node | :way | :relation` OSM element type (node, way, relation) - `:node` - `:way` - `:relation` - `postcode: String` Postal code. Present for reverse geocode address results. - `score: Float` Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1. - `source: :structured | :bm25 | :fuzzy | 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: String` State or province name. Present for reverse geocode address results. - `street: String` Street name. Present for address and interpolated results. - `subcategory: String` POI subcategory. Present for place results. - `tags: Hash[Symbol, String]` Raw OSM tags. Present for place results. - `wikipedia: String` Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places. - `type: :Feature` - `:Feature` - `type: :FeatureCollection` - `:FeatureCollection` ### Example ```ruby require "plaza" plaza = Plaza::Client.new( api_key: "My API Key", environment: "local" # defaults to "production" ) geocode_result = plaza.geocode.forward_post(q: "q") puts(geocode_result) ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "display_name": "221B Baker Street, London, NW1 6XE, United Kingdom", "category": "restaurant", "city": "London", "confidence": 0, "country": "United Kingdom", "country_code": "GB", "distance_m": 0, "full_address": "221B Baker Street, London, NW1 6XE, United Kingdom", "house_number": "221B", "interpolated": true, "name": "Eiffel Tower", "osm_id": 21154906, "osm_type": "node", "postcode": "NW1 6XE", "score": 0, "source": "structured", "state": "England", "street": "Baker Street", "subcategory": "italian", "tags": { "foo": "string" }, "wikipedia": "en:Eiffel Tower" }, "type": "Feature" } ], "type": "FeatureCollection" } ``` ## Reverse geocode a coordinate `geocode.reverse(**kwargs) -> ReverseGeocodeResult` **get** `/api/v1/geocode/reverse` Reverse geocode a coordinate ### Parameters - `lang: String` Language code for localized names (e.g. en, de, fr) - `lat: Float` Legacy shorthand. Latitude. Use near param instead. - `layer: String` Filter by layer: house or poi - `limit: Integer` Maximum results (default 1, max 20) - `lng: Float` Legacy shorthand. Longitude. Use near param instead. - `near: String` Point geometry for reverse geocode (lat,lng or GeoJSON). Alternative to lat/lng params. - `radius: Integer` Search radius in meters (default 200, max 5000) ### Returns - `class ReverseGeocodeResult` GeoJSON FeatureCollection of reverse geocoding results, ordered by distance from the query point. Content-Type: `application/geo+json`. - `features: Array[GeocodingFeature]` Reverse geocoding results ordered by distance - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array[Float]` [longitude, latitude] or [longitude, latitude, elevation] - `Array[Array[Float]]` Array of [lng, lat] positions - `Array[Array[Array[Float]]]` Array of linear rings / line strings - `Array[Array[Array[Array[Float]]]]` Array of polygons - `type: :Point | :LineString | :Polygon | 3 more` Geometry type - `:Point` - `:LineString` - `:Polygon` - `:MultiPoint` - `:MultiLineString` - `:MultiPolygon` - `properties: { display_name, category, city, 18 more}` Geocoding result properties - `display_name: String` Formatted address or place name - `category: String` POI category (e.g. restaurant, cafe, park). Present for place results. - `city: String` City or town name. Present for address results. - `confidence: Float` Interpolation confidence (0-1). Present only for interpolated results. - `country: String` Country name. Present for reverse geocode address results. - `country_code: String` ISO 3166-1 alpha-2 country code - `distance_m: Float` Distance from the query point in meters (reverse geocode / nearby only) - `full_address: String` Complete formatted address from the database. Present for reverse geocode address results. - `house_number: String` House or building number. Present for address and interpolated results. - `interpolated: bool` Whether this result was estimated by address interpolation rather than an exact database match. - `name: String` Place name (raw). Present for reverse geocode place results. - `osm_id: Integer` OpenStreetMap element ID (null for interpolated results) - `osm_type: :node | :way | :relation` OSM element type (node, way, relation) - `:node` - `:way` - `:relation` - `postcode: String` Postal code. Present for reverse geocode address results. - `score: Float` Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1. - `source: :structured | :bm25 | :fuzzy | 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: String` State or province name. Present for reverse geocode address results. - `street: String` Street name. Present for address and interpolated results. - `subcategory: String` POI subcategory. Present for place results. - `tags: Hash[Symbol, String]` Raw OSM tags. Present for place results. - `wikipedia: String` Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places. - `type: :Feature` - `:Feature` - `type: :FeatureCollection` - `:FeatureCollection` ### Example ```ruby require "plaza" plaza = Plaza::Client.new( api_key: "My API Key", environment: "local" # defaults to "production" ) reverse_geocode_result = plaza.geocode.reverse puts(reverse_geocode_result) ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "display_name": "221B Baker Street, London, NW1 6XE, United Kingdom", "category": "restaurant", "city": "London", "confidence": 0, "country": "United Kingdom", "country_code": "GB", "distance_m": 0, "full_address": "221B Baker Street, London, NW1 6XE, United Kingdom", "house_number": "221B", "interpolated": true, "name": "Eiffel Tower", "osm_id": 21154906, "osm_type": "node", "postcode": "NW1 6XE", "score": 0, "source": "structured", "state": "England", "street": "Baker Street", "subcategory": "italian", "tags": { "foo": "string" }, "wikipedia": "en:Eiffel Tower" }, "type": "Feature" } ], "type": "FeatureCollection" } ``` ## Reverse geocode a coordinate `geocode.reverse_post(**kwargs) -> ReverseGeocodeResult` **post** `/api/v1/geocode/reverse` Reverse geocode a coordinate ### Parameters - `lang: String` Language code for localized names (e.g. en, de, fr) - `lat: Float` Legacy shorthand. Latitude. Use near param instead. - `layer: String` Filter by layer: house or poi - `limit: Integer` Maximum results (default 1, max 20) - `lng: Float` Legacy shorthand. Longitude. Use near param instead. - `near: String` Point geometry for reverse geocode (lat,lng or GeoJSON). Alternative to lat/lng params. - `radius: Integer` Search radius in meters (default 200, max 5000) ### Returns - `class ReverseGeocodeResult` GeoJSON FeatureCollection of reverse geocoding results, ordered by distance from the query point. Content-Type: `application/geo+json`. - `features: Array[GeocodingFeature]` Reverse geocoding results ordered by distance - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array[Float]` [longitude, latitude] or [longitude, latitude, elevation] - `Array[Array[Float]]` Array of [lng, lat] positions - `Array[Array[Array[Float]]]` Array of linear rings / line strings - `Array[Array[Array[Array[Float]]]]` Array of polygons - `type: :Point | :LineString | :Polygon | 3 more` Geometry type - `:Point` - `:LineString` - `:Polygon` - `:MultiPoint` - `:MultiLineString` - `:MultiPolygon` - `properties: { display_name, category, city, 18 more}` Geocoding result properties - `display_name: String` Formatted address or place name - `category: String` POI category (e.g. restaurant, cafe, park). Present for place results. - `city: String` City or town name. Present for address results. - `confidence: Float` Interpolation confidence (0-1). Present only for interpolated results. - `country: String` Country name. Present for reverse geocode address results. - `country_code: String` ISO 3166-1 alpha-2 country code - `distance_m: Float` Distance from the query point in meters (reverse geocode / nearby only) - `full_address: String` Complete formatted address from the database. Present for reverse geocode address results. - `house_number: String` House or building number. Present for address and interpolated results. - `interpolated: bool` Whether this result was estimated by address interpolation rather than an exact database match. - `name: String` Place name (raw). Present for reverse geocode place results. - `osm_id: Integer` OpenStreetMap element ID (null for interpolated results) - `osm_type: :node | :way | :relation` OSM element type (node, way, relation) - `:node` - `:way` - `:relation` - `postcode: String` Postal code. Present for reverse geocode address results. - `score: Float` Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1. - `source: :structured | :bm25 | :fuzzy | 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: String` State or province name. Present for reverse geocode address results. - `street: String` Street name. Present for address and interpolated results. - `subcategory: String` POI subcategory. Present for place results. - `tags: Hash[Symbol, String]` Raw OSM tags. Present for place results. - `wikipedia: String` Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places. - `type: :Feature` - `:Feature` - `type: :FeatureCollection` - `:FeatureCollection` ### Example ```ruby require "plaza" plaza = Plaza::Client.new( api_key: "My API Key", environment: "local" # defaults to "production" ) reverse_geocode_result = plaza.geocode.reverse_post puts(reverse_geocode_result) ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "display_name": "221B Baker Street, London, NW1 6XE, United Kingdom", "category": "restaurant", "city": "London", "confidence": 0, "country": "United Kingdom", "country_code": "GB", "distance_m": 0, "full_address": "221B Baker Street, London, NW1 6XE, United Kingdom", "house_number": "221B", "interpolated": true, "name": "Eiffel Tower", "osm_id": 21154906, "osm_type": "node", "postcode": "NW1 6XE", "score": 0, "source": "structured", "state": "England", "street": "Baker Street", "subcategory": "italian", "tags": { "foo": "string" }, "wikipedia": "en:Eiffel Tower" }, "type": "Feature" } ], "type": "FeatureCollection" } ``` ## Autocomplete a partial address `geocode.autocomplete(**kwargs) -> AutocompleteResult` **get** `/api/v1/geocode/autocomplete` Autocomplete a partial address ### Parameters - `q: String` Partial address query - `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 10, max 20) - `lng: Float` Focus longitude ### Returns - `class AutocompleteResult` GeoJSON FeatureCollection of autocomplete suggestions for partial address input. Optimized for low-latency type-ahead UIs. Content-Type: `application/geo+json`. - `features: Array[GeocodingFeature]` Autocomplete suggestions ordered by relevance - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array[Float]` [longitude, latitude] or [longitude, latitude, elevation] - `Array[Array[Float]]` Array of [lng, lat] positions - `Array[Array[Array[Float]]]` Array of linear rings / line strings - `Array[Array[Array[Array[Float]]]]` Array of polygons - `type: :Point | :LineString | :Polygon | 3 more` Geometry type - `:Point` - `:LineString` - `:Polygon` - `:MultiPoint` - `:MultiLineString` - `:MultiPolygon` - `properties: { display_name, category, city, 18 more}` Geocoding result properties - `display_name: String` Formatted address or place name - `category: String` POI category (e.g. restaurant, cafe, park). Present for place results. - `city: String` City or town name. Present for address results. - `confidence: Float` Interpolation confidence (0-1). Present only for interpolated results. - `country: String` Country name. Present for reverse geocode address results. - `country_code: String` ISO 3166-1 alpha-2 country code - `distance_m: Float` Distance from the query point in meters (reverse geocode / nearby only) - `full_address: String` Complete formatted address from the database. Present for reverse geocode address results. - `house_number: String` House or building number. Present for address and interpolated results. - `interpolated: bool` Whether this result was estimated by address interpolation rather than an exact database match. - `name: String` Place name (raw). Present for reverse geocode place results. - `osm_id: Integer` OpenStreetMap element ID (null for interpolated results) - `osm_type: :node | :way | :relation` OSM element type (node, way, relation) - `:node` - `:way` - `:relation` - `postcode: String` Postal code. Present for reverse geocode address results. - `score: Float` Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1. - `source: :structured | :bm25 | :fuzzy | 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: String` State or province name. Present for reverse geocode address results. - `street: String` Street name. Present for address and interpolated results. - `subcategory: String` POI subcategory. Present for place results. - `tags: Hash[Symbol, String]` Raw OSM tags. Present for place results. - `wikipedia: String` Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places. - `type: :Feature` - `:Feature` - `type: :FeatureCollection` - `:FeatureCollection` ### Example ```ruby require "plaza" plaza = Plaza::Client.new( api_key: "My API Key", environment: "local" # defaults to "production" ) autocomplete_result = plaza.geocode.autocomplete(q: "q") puts(autocomplete_result) ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "display_name": "221B Baker Street, London, NW1 6XE, United Kingdom", "category": "restaurant", "city": "London", "confidence": 0, "country": "United Kingdom", "country_code": "GB", "distance_m": 0, "full_address": "221B Baker Street, London, NW1 6XE, United Kingdom", "house_number": "221B", "interpolated": true, "name": "Eiffel Tower", "osm_id": 21154906, "osm_type": "node", "postcode": "NW1 6XE", "score": 0, "source": "structured", "state": "England", "street": "Baker Street", "subcategory": "italian", "tags": { "foo": "string" }, "wikipedia": "en:Eiffel Tower" }, "type": "Feature" } ], "type": "FeatureCollection" } ``` ## Autocomplete a partial address `geocode.autocomplete_post(**kwargs) -> AutocompleteResult` **post** `/api/v1/geocode/autocomplete` Autocomplete a partial address ### Parameters - `q: String` Partial address query - `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 10, max 20) - `lng: Float` Focus longitude ### Returns - `class AutocompleteResult` GeoJSON FeatureCollection of autocomplete suggestions for partial address input. Optimized for low-latency type-ahead UIs. Content-Type: `application/geo+json`. - `features: Array[GeocodingFeature]` Autocomplete suggestions ordered by relevance - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array[Float]` [longitude, latitude] or [longitude, latitude, elevation] - `Array[Array[Float]]` Array of [lng, lat] positions - `Array[Array[Array[Float]]]` Array of linear rings / line strings - `Array[Array[Array[Array[Float]]]]` Array of polygons - `type: :Point | :LineString | :Polygon | 3 more` Geometry type - `:Point` - `:LineString` - `:Polygon` - `:MultiPoint` - `:MultiLineString` - `:MultiPolygon` - `properties: { display_name, category, city, 18 more}` Geocoding result properties - `display_name: String` Formatted address or place name - `category: String` POI category (e.g. restaurant, cafe, park). Present for place results. - `city: String` City or town name. Present for address results. - `confidence: Float` Interpolation confidence (0-1). Present only for interpolated results. - `country: String` Country name. Present for reverse geocode address results. - `country_code: String` ISO 3166-1 alpha-2 country code - `distance_m: Float` Distance from the query point in meters (reverse geocode / nearby only) - `full_address: String` Complete formatted address from the database. Present for reverse geocode address results. - `house_number: String` House or building number. Present for address and interpolated results. - `interpolated: bool` Whether this result was estimated by address interpolation rather than an exact database match. - `name: String` Place name (raw). Present for reverse geocode place results. - `osm_id: Integer` OpenStreetMap element ID (null for interpolated results) - `osm_type: :node | :way | :relation` OSM element type (node, way, relation) - `:node` - `:way` - `:relation` - `postcode: String` Postal code. Present for reverse geocode address results. - `score: Float` Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1. - `source: :structured | :bm25 | :fuzzy | 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: String` State or province name. Present for reverse geocode address results. - `street: String` Street name. Present for address and interpolated results. - `subcategory: String` POI subcategory. Present for place results. - `tags: Hash[Symbol, String]` Raw OSM tags. Present for place results. - `wikipedia: String` Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places. - `type: :Feature` - `:Feature` - `type: :FeatureCollection` - `:FeatureCollection` ### Example ```ruby require "plaza" plaza = Plaza::Client.new( api_key: "My API Key", environment: "local" # defaults to "production" ) autocomplete_result = plaza.geocode.autocomplete_post(q: "q") puts(autocomplete_result) ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "display_name": "221B Baker Street, London, NW1 6XE, United Kingdom", "category": "restaurant", "city": "London", "confidence": 0, "country": "United Kingdom", "country_code": "GB", "distance_m": 0, "full_address": "221B Baker Street, London, NW1 6XE, United Kingdom", "house_number": "221B", "interpolated": true, "name": "Eiffel Tower", "osm_id": 21154906, "osm_type": "node", "postcode": "NW1 6XE", "score": 0, "source": "structured", "state": "England", "street": "Baker Street", "subcategory": "italian", "tags": { "foo": "string" }, "wikipedia": "en:Eiffel Tower" }, "type": "Feature" } ], "type": "FeatureCollection" } ``` ## Batch geocode multiple addresses `geocode.batch(**kwargs) -> GeocodeBatchResponse` **post** `/api/v1/geocode/batch` Batch geocode multiple addresses ### Parameters - `addresses: Array[String]` ### Returns - `class GeocodeBatchResponse` Batch geocoding result. Each entry in `results` is a FeatureCollection corresponding to the input address at the same index. Order is preserved. - `count: Integer` Number of addresses processed (always equals length of results) - `results: Array[GeocodeResult]` Array of FeatureCollections, one per input address. Empty FeatureCollections indicate no match. - `features: Array[GeocodingFeature]` Geocoding results ordered by relevance score - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array[Float]` [longitude, latitude] or [longitude, latitude, elevation] - `Array[Array[Float]]` Array of [lng, lat] positions - `Array[Array[Array[Float]]]` Array of linear rings / line strings - `Array[Array[Array[Array[Float]]]]` Array of polygons - `type: :Point | :LineString | :Polygon | 3 more` Geometry type - `:Point` - `:LineString` - `:Polygon` - `:MultiPoint` - `:MultiLineString` - `:MultiPolygon` - `properties: { display_name, category, city, 18 more}` Geocoding result properties - `display_name: String` Formatted address or place name - `category: String` POI category (e.g. restaurant, cafe, park). Present for place results. - `city: String` City or town name. Present for address results. - `confidence: Float` Interpolation confidence (0-1). Present only for interpolated results. - `country: String` Country name. Present for reverse geocode address results. - `country_code: String` ISO 3166-1 alpha-2 country code - `distance_m: Float` Distance from the query point in meters (reverse geocode / nearby only) - `full_address: String` Complete formatted address from the database. Present for reverse geocode address results. - `house_number: String` House or building number. Present for address and interpolated results. - `interpolated: bool` Whether this result was estimated by address interpolation rather than an exact database match. - `name: String` Place name (raw). Present for reverse geocode place results. - `osm_id: Integer` OpenStreetMap element ID (null for interpolated results) - `osm_type: :node | :way | :relation` OSM element type (node, way, relation) - `:node` - `:way` - `:relation` - `postcode: String` Postal code. Present for reverse geocode address results. - `score: Float` Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1. - `source: :structured | :bm25 | :fuzzy | 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: String` State or province name. Present for reverse geocode address results. - `street: String` Street name. Present for address and interpolated results. - `subcategory: String` POI subcategory. Present for place results. - `tags: Hash[Symbol, String]` Raw OSM tags. Present for place results. - `wikipedia: String` Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places. - `type: :Feature` - `:Feature` - `type: :FeatureCollection` - `:FeatureCollection` ### Example ```ruby require "plaza" plaza = Plaza::Client.new( api_key: "My API Key", environment: "local" # defaults to "production" ) response = plaza.geocode.batch(addresses: ["string"]) puts(response) ``` #### Response ```json { "count": 0, "results": [ { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "display_name": "221B Baker Street, London, NW1 6XE, United Kingdom", "category": "restaurant", "city": "London", "confidence": 0, "country": "United Kingdom", "country_code": "GB", "distance_m": 0, "full_address": "221B Baker Street, London, NW1 6XE, United Kingdom", "house_number": "221B", "interpolated": true, "name": "Eiffel Tower", "osm_id": 21154906, "osm_type": "node", "postcode": "NW1 6XE", "score": 0, "source": "structured", "state": "England", "street": "Baker Street", "subcategory": "italian", "tags": { "foo": "string" }, "wikipedia": "en:Eiffel Tower" }, "type": "Feature" } ], "type": "FeatureCollection" } ] } ``` ## Domain Types ### Autocomplete Result - `class AutocompleteResult` GeoJSON FeatureCollection of autocomplete suggestions for partial address input. Optimized for low-latency type-ahead UIs. Content-Type: `application/geo+json`. - `features: Array[GeocodingFeature]` Autocomplete suggestions ordered by relevance - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array[Float]` [longitude, latitude] or [longitude, latitude, elevation] - `Array[Array[Float]]` Array of [lng, lat] positions - `Array[Array[Array[Float]]]` Array of linear rings / line strings - `Array[Array[Array[Array[Float]]]]` Array of polygons - `type: :Point | :LineString | :Polygon | 3 more` Geometry type - `:Point` - `:LineString` - `:Polygon` - `:MultiPoint` - `:MultiLineString` - `:MultiPolygon` - `properties: { display_name, category, city, 18 more}` Geocoding result properties - `display_name: String` Formatted address or place name - `category: String` POI category (e.g. restaurant, cafe, park). Present for place results. - `city: String` City or town name. Present for address results. - `confidence: Float` Interpolation confidence (0-1). Present only for interpolated results. - `country: String` Country name. Present for reverse geocode address results. - `country_code: String` ISO 3166-1 alpha-2 country code - `distance_m: Float` Distance from the query point in meters (reverse geocode / nearby only) - `full_address: String` Complete formatted address from the database. Present for reverse geocode address results. - `house_number: String` House or building number. Present for address and interpolated results. - `interpolated: bool` Whether this result was estimated by address interpolation rather than an exact database match. - `name: String` Place name (raw). Present for reverse geocode place results. - `osm_id: Integer` OpenStreetMap element ID (null for interpolated results) - `osm_type: :node | :way | :relation` OSM element type (node, way, relation) - `:node` - `:way` - `:relation` - `postcode: String` Postal code. Present for reverse geocode address results. - `score: Float` Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1. - `source: :structured | :bm25 | :fuzzy | 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: String` State or province name. Present for reverse geocode address results. - `street: String` Street name. Present for address and interpolated results. - `subcategory: String` POI subcategory. Present for place results. - `tags: Hash[Symbol, String]` Raw OSM tags. Present for place results. - `wikipedia: String` Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places. - `type: :Feature` - `:Feature` - `type: :FeatureCollection` - `:FeatureCollection` ### Geocode Result - `class GeocodeResult` GeoJSON FeatureCollection of forward geocoding results, ordered by relevance. Content-Type: `application/geo+json`. - `features: Array[GeocodingFeature]` Geocoding results ordered by relevance score - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array[Float]` [longitude, latitude] or [longitude, latitude, elevation] - `Array[Array[Float]]` Array of [lng, lat] positions - `Array[Array[Array[Float]]]` Array of linear rings / line strings - `Array[Array[Array[Array[Float]]]]` Array of polygons - `type: :Point | :LineString | :Polygon | 3 more` Geometry type - `:Point` - `:LineString` - `:Polygon` - `:MultiPoint` - `:MultiLineString` - `:MultiPolygon` - `properties: { display_name, category, city, 18 more}` Geocoding result properties - `display_name: String` Formatted address or place name - `category: String` POI category (e.g. restaurant, cafe, park). Present for place results. - `city: String` City or town name. Present for address results. - `confidence: Float` Interpolation confidence (0-1). Present only for interpolated results. - `country: String` Country name. Present for reverse geocode address results. - `country_code: String` ISO 3166-1 alpha-2 country code - `distance_m: Float` Distance from the query point in meters (reverse geocode / nearby only) - `full_address: String` Complete formatted address from the database. Present for reverse geocode address results. - `house_number: String` House or building number. Present for address and interpolated results. - `interpolated: bool` Whether this result was estimated by address interpolation rather than an exact database match. - `name: String` Place name (raw). Present for reverse geocode place results. - `osm_id: Integer` OpenStreetMap element ID (null for interpolated results) - `osm_type: :node | :way | :relation` OSM element type (node, way, relation) - `:node` - `:way` - `:relation` - `postcode: String` Postal code. Present for reverse geocode address results. - `score: Float` Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1. - `source: :structured | :bm25 | :fuzzy | 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: String` State or province name. Present for reverse geocode address results. - `street: String` Street name. Present for address and interpolated results. - `subcategory: String` POI subcategory. Present for place results. - `tags: Hash[Symbol, String]` Raw OSM tags. Present for place results. - `wikipedia: String` Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places. - `type: :Feature` - `:Feature` - `type: :FeatureCollection` - `:FeatureCollection` ### Geocoding Feature - `class GeocodingFeature` GeoJSON Feature representing a geocoding result. The geometry is always a Point. Properties include the formatted display name, OSM metadata, confidence score, and source type. - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array[Float]` [longitude, latitude] or [longitude, latitude, elevation] - `Array[Array[Float]]` Array of [lng, lat] positions - `Array[Array[Array[Float]]]` Array of linear rings / line strings - `Array[Array[Array[Array[Float]]]]` Array of polygons - `type: :Point | :LineString | :Polygon | 3 more` Geometry type - `:Point` - `:LineString` - `:Polygon` - `:MultiPoint` - `:MultiLineString` - `:MultiPolygon` - `properties: { display_name, category, city, 18 more}` Geocoding result properties - `display_name: String` Formatted address or place name - `category: String` POI category (e.g. restaurant, cafe, park). Present for place results. - `city: String` City or town name. Present for address results. - `confidence: Float` Interpolation confidence (0-1). Present only for interpolated results. - `country: String` Country name. Present for reverse geocode address results. - `country_code: String` ISO 3166-1 alpha-2 country code - `distance_m: Float` Distance from the query point in meters (reverse geocode / nearby only) - `full_address: String` Complete formatted address from the database. Present for reverse geocode address results. - `house_number: String` House or building number. Present for address and interpolated results. - `interpolated: bool` Whether this result was estimated by address interpolation rather than an exact database match. - `name: String` Place name (raw). Present for reverse geocode place results. - `osm_id: Integer` OpenStreetMap element ID (null for interpolated results) - `osm_type: :node | :way | :relation` OSM element type (node, way, relation) - `:node` - `:way` - `:relation` - `postcode: String` Postal code. Present for reverse geocode address results. - `score: Float` Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1. - `source: :structured | :bm25 | :fuzzy | 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: String` State or province name. Present for reverse geocode address results. - `street: String` Street name. Present for address and interpolated results. - `subcategory: String` POI subcategory. Present for place results. - `tags: Hash[Symbol, String]` Raw OSM tags. Present for place results. - `wikipedia: String` Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places. - `type: :Feature` - `:Feature` ### Reverse Geocode Result - `class ReverseGeocodeResult` GeoJSON FeatureCollection of reverse geocoding results, ordered by distance from the query point. Content-Type: `application/geo+json`. - `features: Array[GeocodingFeature]` Reverse geocoding results ordered by distance - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array[Float]` [longitude, latitude] or [longitude, latitude, elevation] - `Array[Array[Float]]` Array of [lng, lat] positions - `Array[Array[Array[Float]]]` Array of linear rings / line strings - `Array[Array[Array[Array[Float]]]]` Array of polygons - `type: :Point | :LineString | :Polygon | 3 more` Geometry type - `:Point` - `:LineString` - `:Polygon` - `:MultiPoint` - `:MultiLineString` - `:MultiPolygon` - `properties: { display_name, category, city, 18 more}` Geocoding result properties - `display_name: String` Formatted address or place name - `category: String` POI category (e.g. restaurant, cafe, park). Present for place results. - `city: String` City or town name. Present for address results. - `confidence: Float` Interpolation confidence (0-1). Present only for interpolated results. - `country: String` Country name. Present for reverse geocode address results. - `country_code: String` ISO 3166-1 alpha-2 country code - `distance_m: Float` Distance from the query point in meters (reverse geocode / nearby only) - `full_address: String` Complete formatted address from the database. Present for reverse geocode address results. - `house_number: String` House or building number. Present for address and interpolated results. - `interpolated: bool` Whether this result was estimated by address interpolation rather than an exact database match. - `name: String` Place name (raw). Present for reverse geocode place results. - `osm_id: Integer` OpenStreetMap element ID (null for interpolated results) - `osm_type: :node | :way | :relation` OSM element type (node, way, relation) - `:node` - `:way` - `:relation` - `postcode: String` Postal code. Present for reverse geocode address results. - `score: Float` Relevance score (higher is better). Incorporates text match quality, spatial proximity boost, and popularity signals. Not bounded to 0-1. - `source: :structured | :bm25 | :fuzzy | 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: String` State or province name. Present for reverse geocode address results. - `street: String` Street name. Present for address and interpolated results. - `subcategory: String` POI subcategory. Present for place results. - `tags: Hash[Symbol, String]` Raw OSM tags. Present for place results. - `wikipedia: String` Wikipedia article reference (e.g. en:Eiffel Tower). Present for notable places. - `type: :Feature` - `:Feature` - `type: :FeatureCollection` - `:FeatureCollection`