Service

Health checks and data versions. No key needed, and never charged.

Liveness

GET

https://api.waymatrix.io

/v2/health

Whether routing is up and ready for requests. It needs no key and is never charged.

Liveness › Responses

The engine is ready.

status

string

Liveness, headers only

HEAD

https://api.waymatrix.io

/v2/health

Identical to GET /v2/health without a body, for uptime monitors that send HEAD.

Liveness, headers only › Responses

The engine is ready.

No data returned

Engine and graph provenance

GET

https://api.waymatrix.io

/v2/status

Shows which version of the routing software is running, when the road graph was built, and the date of the OpenStreetMap data it was built from.

Reading the response

The services field is the routing software's own list of what it can do, passed through unchanged, so it names more than this API serves. snap, export and match appear in it but return 404 here, and export is never available.

To see what you can call, use profiles in this response and the endpoints in this reference.

Engine and graph provenance › Responses

Engine, graph and profile information.

Engine and graph provenance, headers only

HEAD

https://api.waymatrix.io

/v2/status

Identical to GET /v2/status without a body.

Engine and graph provenance, headers only › Responses

Engine, graph and profile information.

No data returned

Isochrones

Engine and graph provenance

GET

https://api.waymatrix.io

/v2/status

Shows which version of the routing software is running, when the road graph was built, and the date of the OpenStreetMap data it was built from.

Reading the response

To see what you can call, use profiles in this response and the endpoints in this reference.

Engine and graph provenance › Responses

Engine, graph and profile information.