API Reference
The geocodeme.net API is available at https://api.geocodeme.net/v1. All endpoints are versioned under the /v1 prefix. Breaking changes to the behaviour documented here will be introduced under a new version prefix (e.g. /v2). A correction that brings an endpoint back in line with this documentation is not one of them; it ships on /v1 and is announced in the changelog.
All requests require an API key. Pass it via the X-Api-Key header or the api_key query parameter. See Authentication for details.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/geocode | Forward geocoding: convert an address into GPS coordinates |
| GET | /v1/reverse | Reverse geocoding: convert GPS coordinates into an address |
| POST | /v1/match | Map matching: snap a GPS trace to the road network |
| GET | /v1/nearest | Snap to road: find the nearest road segment for a coordinate |
| GET | /v1/autocomplete | Search-as-you-type place search (1 credit) |
| GET | /v1/route | Point-to-point routing with turn-by-turn steps (2 credits) |
| GET | /v1/isochrone | Reachability polygons: "what can I reach in N minutes?" (10 credits, Startup+) |
| POST | /v1/matrix | Travel time/distance matrices up to 100×100 (Startup+) |
| GET | /v1/elevation | Terrain elevation and profiles (2 credits, Startup+) |
| POST | /v1/batch/geocode | Async batch geocoding up to 10,000 addresses (Growth+) |
Quick Links
- Authentication: API key formats and authentication methods
- Credits & quotas: Per-endpoint credit weights and plan capabilities
- Rate Limiting: Per-second rate limits and credit quotas by plan tier
- Error Codes: Complete error reference with HTTP status codes and examples
Try it Live
No API key required to get started: the Playground embeds a public, rate-limited demo key (10 requests per minute). This key is intentionally client-side and cannot be used for production workloads. For higher limits, enter your own API key in the Playground.
Open the Interactive Playground →
All endpoints return responses in JSON by default. The /v1/geocode and /v1/reverse endpoints support a format=geojson parameter for GeoJSON output. The /v1/match and /v1/nearest endpoints do not support the format parameter.
The OpenAPI specification for the public endpoints is available at /openapi.json; import it into Postman, Insomnia, or your favorite code generator.