LocAPI
Documentation menu

Versioning

The version is in the path: /v1. Within v1 the contract only grows; it never breaks.

What can change in v1#

  • New optional parameters.
  • New fields in responses.
  • New values in fields such as outcome, precision and billingClass.
  • New endpoints and new countries.

What your client should do#

  • Ignore fields you do not know.
  • Treat an unknown value as “not one I handle”, not as an error.
  • Branch on code in errors, never on title or detail.
  • Store the address you received, not the id: ids expire.

Breaking changes#

A change that would break a client comes as a new version (/v2), next to v1.