Compatibility: Google and Nominatim
Change the base URL and keep your client code. This page lists what is supported, from the API specification (OpenAPI 1.0.0).
Google Geocoding mode
| Element | Support |
|---|---|
| Path | /compat/google/maps/api/geocode/json |
| Forward geocoding | `address` (up to 512 characters) |
| Reverse geocoding | `latlng`, as `lat,lng` |
| Filters | `components`: only `country:XX` is honoured; `language` and `region` accepted |
| Response fields | status, error_message, results[].formatted_address, place_id, types, partial_match, address_components, geometry.location, geometry.location_type, geometry.viewport |
| Errors | Google-shaped `status` (OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED, INVALID_REQUEST, UNKNOWN_ERROR), HTTP 200 |
| Place IDs | Present in the shape; values are Addrova identifiers |
| Addrova extension | `attribution` array of sources and licences |
Nominatim mode
| Element | Support |
|---|---|
| Search | /compat/nominatim/search with `q`, `format` (json or jsonv2, default jsonv2), `limit` (1 to 40, default 10), `countrycodes` (comma-separated ISO codes), `addressdetails` (0 or 1, default 0) |
| Reverse | /compat/nominatim/reverse with `lat`, `lon`, `format`, `addressdetails` (default 1) |
| Response fields | place_id, licence, lat, lon, display_name, category (jsonv2) or class (json), type, importance, address, boundingbox |
| Reverse without result | {"error": "Unable to geocode"} |
| Out of scope | Map tiles, lookup of OSM objects |
Authentication on compatibility routes
| Method | How |
|---|---|
| Query parameter | `key=ADDROVA_KEY`, accepted on /compat routes only, for drop-in compatibility. It is never logged. |
| Header | `X-API-Key`, or the key as a bearer token |