Fouten

Foutbody

Fouten komen terug met een HTTP-statuscode en een JSON-body.

{ "code": "...", "message": "..." }

code is een vaste identifier voor programma’s, message is een omschrijving voor mensen. Baseer je logica op de statuscode en code, niet op de tekst van message.

Statuscodes

Status Betekenis
400 countrycodes ontbreekt of is ongeldig op /search, of een land wordt niet ondersteund
401 De API-key ontbreekt, is onbekend, ingetrokken of verlopen
403 Het verzoek komt van buiten de IP-regels van de key
429 De rate limit is overschreden. Zie Rate limits
503 De dienst is tijdelijk niet beschikbaar. Probeer het later opnieuw

Een 400 wegens een ontbrekende countrycodes verwijst naar de documentatie. Voor een land dat nog niet wordt ondersteund kun je het aanvragen.

Gedeeltelijke resultaten

Een zoekopdracht over meerdere landen, of over een land dat uit meerdere shards bestaat, gaat naar alle betrokken shards. Elke shard heeft een vaste timeout. Reageert een shard niet op tijd, dan krijg je nog steeds de resultaten van de andere, en bevat de response de header X-Partial-Result met de ontbrekende shards.

X-Partial-Result: de-south

De body van de response houdt het gewone Nominatim-formaat. Is volledigheid belangrijk, controleer dan op deze header en probeer het verzoek opnieuw.