LocAPI
Documentation menu

OpenAPI

The contract as OpenAPI 3.1, generated from the running code. It needs no key: https://api.locapi.eu/openapi/v1.json.

Shell
curl https://api.locapi.eu/openapi/v1.json -o locapi-v1.json

What it contains#

  • The 4 public endpoints: /v1/address/lookup, /v1/address/resolve, /v1/address/suggest, /v1/usage.
  • Parameters, response shapes and the error statuses per endpoint.
  • The X-Api-Key security scheme.

Using it#

Use it to generate a client or to validate responses. The rules that a schema cannot express, such as which parameters are required per country and what is billed, are in this documentation.