v9.1.0

Added

This release adds supports for new structured geocoding properties!

Instead of the "address" field, you can now search for the street, house number, and unit separately.
This gives you more control, skipping the parser guesswork.

Full Changelog: v9.0.0...v9.1.0

v9.0.0

Added

Traffic-influenced routing is now available for cars, busses, taxis, and trucks!
Traffic-influenced routing profiles come in two variants:

• Adaptive traffic profiles use either current conditions or predictive data,
  automatically selecting the best one given your request parameters.
• Premium traffic profiles use both current conditions and predictive data
  to give you the best ETAs, isochrones, and routes.

We've also expanded the routing API with even more flexibility:

• Time-dependent routing: the new traffic profiles assume "departing now" by default.
  But you can also specify departure or arrival at a specific time.
  For time/distance matrix calculations, you can even specify this at the individual source/target level.
• Penalties (routing is allowed, but discouraged, so that these features can be avoided)
  • Private access roads
  • Alleys
  • (Rail) ferries
  • Elevator use
  • Use of residential, service, or other undesirable roads by heavy vehicles
• Hard exclusions
  • Cash-only tolls
  • Unpaved roads
• Time vs distance preference: you can specify a percentage weight between the two instead of the default (time-based) or purely shortest
• Truck axle restrictions

Finally, we've launched version 2 of our time zone API!
There is no significant difference in the functionality,
but we've rectified a long-standing point of confusion with how we communicated offsets from standard time.

Changed

A number of properties throughout the codebase are now strongly typed.
They used to be strings that accepted any value, but now TypeScript will check that the values are valid.
(The TypeScript OpenAPI generator recently added this capability.)
These are technically breaking changes, but should not break any code
unless you were using an invalid value.

Additionally, we have removed some properties from routing endpoints that had no effect.
For example, the Nearest Roads API does not return directions,
but it still accepted a directions type parameter.

Full Changelog: v8.1.0...v9.0.0

v8.1.0

Enhancements

• Add support for reverse search operations in the bulk geocoding API.

Full Changelog: v8.0.1...v8.1.0

v8.0.1

Version 7.0.1 - 2025-06-12

Fixed

• Add two missing OSRM maneuver types which were mistakenly omitted.

Full Changelog: v8.0.0...v8.0.1

v8.0.0

Added

• Support for the v2 search (forward geocoding) endpoint! The new API includes better structure, more details, and better address formatting.

- const res = await api.search({
+ const res = await api.searchV2({
    text: 'Telliskivi 60a/3, Tallinn, Estonia'
  });

For an overview of the structural changes we've made in the V2 API,
refer to the migration guide.

Fixed

• Potentially breaking change: The maneuvers property on route responses was previously marked as required.
  However, it is possible to explicitly request routes with this field removed.
  These would fail validation and the whole request would end with an exception
  in the API client.
  This has been fixed in this version, so the property is optional.

Full Changelog: v7.3.0...v8.0.0

v7.3.0

Version 7.3.0 - 2025-06-03

Added

• New fields to the time zone API responses including localized timestamps in several standard formats.

Fixed

• Fix a bug which caused structured search bulk requests to incorrectly spell the postalcode field.

Full Changelog: v7.2.0...v7.3.0

v7.2.0

Added

• Add documentation for the geocoding metadata query field.

Fixed

• Removed boundary circle properties that were mistakenly added.
  They did not behave as expected, so this is a bug fix despite being a code-breaking change if you used it.
• Added missing water layers to context.

Full Changelog: v7.1.0...v7.2.0

v7.1.0

Added

• Support for the v2 reverse geocoding endpoint! The new API includes better structure, more details, and better address formatting.

- const res = await api.reverse({
+ const res = await api.reverseV2({
    pointLat: 48.848268,
    pointLon: 2.294471 
  });

For an overview of the structural changes we've made in the V2 API,
refer to the migration guide.

Fixed

• Added the wheelchair property to the OSM addendum model (it was in the API response, but not explicitly modeled).
• Fix the types of the Natural Earth and Karmashapes identifiers

Full Changelog: v7.0.0...v7.1.0

v7.0.0

Version 7.0.0 - 2025-04-07

Added

• Support for the v2 autocomplete and place details APIs!
• BREAKING: We have renamed the Place Details method to clarify its purpose.

If you want to keep using the v1 endpoint, you can amend your code like so:

- const res = await api.place({ ids: ["whosonfirst:locality:123"] });
+ const res = await api.placeDetails({ ids: ["whosonfirst:locality:123"] });

To upgrade to the v2 Place Details endpoint, which features improved address formatting,
use the new V2 method:

- const res = await api.place({ ids: ["whosonfirst:locality:123"] });
+ const res = await api.placeDetailsV2({ ids: ["whosonfirst:locality:123"] });

TypeScript users will receive errors at build time to keep breakage obvious.

For an overview of the structural changes we've made in the V2 API,
refer to the migration guide.

Full Changelog: v6.0.0...v7.0.0

v6.0.0

Added

• BREAKING: Renamed models containing Valhalla and Pelias in their names to be generic. These now have rout(e|ing) or geocod(e|ing) prefixes.
• Explicitly documented more properties to the geocoding feature model.
• Adds support for the foursquare data source.
• Documents the elevation_interval parameter on certain routing requests.

Full Changelog: v5.0.0...v6.0.0