Skip to main content

Getting Started

geocodeme.net is a geocoding and routing API on OpenStreetMap data: addresses → coordinates, coordinates → addresses, routes, isochrones, matrices and map tiles. No SDK required: just an API key and an HTTP client.

Key features​

  • Forward, reverse and autocomplete geocoding: Europe plus the five French overseas regions. See Geographic Coverage.
  • Routing, isochrones, matrices, map matching, snap-to-road and elevation: powered by the Valhalla engine, with the car, bike, foot, truck and moto profiles.
  • Sub-200 ms responses (p50): a 24-hour Redis cache sits in front of the engines, and quotas are expressed in weighted credits rather than raw request counts.
  • OpenStreetMap data replicated continuously, region by region, and served from infrastructure hosted in France.

Three steps to your first request​

  1. Get an API key: create an account, then generate a key from your Dashboard. Details in Authentication.
  2. Make your first request: a single curl call is enough (below).
  3. Explore the API Reference: every endpoint, parameter and response format lives in the API Reference.

First request​

Pass your key in the X-Api-Key header:

curl -H "X-Api-Key: gm_YOUR_API_KEY" \
  "https://api.geocodeme.net/v1/geocode?q=Alexanderplatz%2C%20Berlin&limit=1"

Read the response​

The API returns JSON: coordinates, a display name, a relevance score, and a meta block (timing, cache).

{
  "results": [
    {
      "lat": 52.5219,
      "lon": 13.4132,
      "name": "Alexanderplatz",
      "display_name": "Alexanderplatz, Mitte, Berlin, 10178, Deutschland",
      "type": "square",
      "importance": 0.61,
      "address": {
        "city": "Berlin",
        "state": "Berlin",
        "postcode": "10178",
        "country": "Deutschland",
        "country_code": "de"
      }
    }
  ],
  "attribution": "© OpenStreetMap contributors",
  "meta": {
    "took_ms": 142,
    "cache_hit": true
  }
}

Every endpoint follows the same envelope: a payload key (results, result, routes…), an attribution string, and a meta block. Field-by-field schemas are documented per endpoint; start with GET /v1/geocode.

Credit-based quotas

1 credit = one geocode, reverse, autocomplete or snap. A route or an elevation call costs 2, an isochrone 10; matrices and map matching are counted per started block of 25. Map tiles have their own counter and never eat into your credits. Free plan: 3,000 credits per day. Full table in Credits & Quotas.

OpenStreetMap attribution

Any map or result you display must credit © OpenStreetMap contributors, and © OpenMapTiles when you also serve our map tiles. It is the single obligation the ODbL license puts on you. See Licensing & Attribution.