overpass 0.8.2

A Python interface to the OpenStreetMap Overpass API

Overpass API python wrapper

Overpass API for Python.

Install it

pip install overpass

Roadmap

0.8 is the final release in the 0.8 series. It will receive bug fixes and security updates only. No new features will be added to 0.8.

We are actively working toward 1.0, which will be a significant modernization: new OverpassClient API, structured result objects, a typed query builder, richer exceptions, and a migration from requests to httpx. See the 1.0 design document for the full picture.

We would love your input. If you use this library, please read the design doc and open an issue with feedback — what works for your use case, what doesn't, and what we may have missed.

Supported Python Versions

This project is tested and supported on Python 3.10 through 3.14.

Development

Use uv for local development:

uv sync --extra dev
scripts/check

DEVELOPMENT.md contains the full contributor command reference, including live API test instructions. RELEASE.md contains the release checklist.

Migrating to 1.0

v1.0 is not released yet. Development has started and you are more than welcome to contribute! See DEVELOPMENT.md for details.

The 0.8.x line is the compatibility and deprecation path for the upcoming 1.0 release. As of version 0.8.1, the DeprecationWarning is emitted when code uses APIs that are removed or renamed in 1.0, including API, MapQuery, WayQuery, Utils.to_overpass_id, uppercase API.Get/API.Search, legacy exception names, and API.get() arguments that are replaced by the new query/result model.

See DESIGN-1.0.md for the planned 1.0 API and compatibility mapping. In particular, Utils.to_overpass_id(..., area=True) has no 1.0 replacement because Overpass API 0.7.57+ no longer supports legacy way-derived 2400xxx area IDs; query closed ways directly instead.

Usage

API() constructor

First, create an API object.

import overpass
api = overpass.API(user_agent = "Application Name ([e-mail])")

New In 0.8.2: a User-Agent must now be included for a request to the Overpass API to be accepted. For backward compatibility reasons, a default fallback User-Agent Unknown overpass-api-python-wrapper application will be sent. Please set your own applicable User-Agent for your application. If you do not, you may find your application blocked from accessing the Overpass API.

The API constructor takes several parameters, all-but-one optional:

user_agent (Required)

user_agent is required. The Overpass public servers are shared infrastructure; identifying your client is basic etiquette and helps server operators reach you if your queries are causing problems.

endpoint

The default endpoint is https://overpass-api.de/api/interpreter but you can pass in another instance:

api = overpass.API(endpoint="https://overpass.myserver/interpreter")

timeout

The default timeout is 25 seconds, but you can set it to whatever you want.

api = overpass.API(timeout=600)

debug

Setting this to True will get you debug output.

Getting data from Overpass: get()

Most users will only ever need to use the get() method. There are some convenience query methods for common queries as well, see below.

response = api.get('node["name"="Salt Lake City"]')

response will be a dictionary representing the JSON output you would get from the Overpass API directly.

Note that the Overpass query passed to get() should not contain any out or other meta statements. See verbosity below for how to control the output.

Another example:

>>> [(feature["properties"]["name"], feature["id"]) for feature in response["features"]]
[("Salt Lake City", 150935219), ("Salt Lake City", 585370637)]

You can find more examples in the examples/ directory of this repository.

The get() method takes a few parameters, all optional having sensible defaults.

verbosity

You can set the verbosity of the Overpass query out directive using the same keywords Overpass does. In order of increased verbosity: ids, skel, body, tags, meta. As is the case with the Overpass API itself, body is the default.

>>> import overpass
>>> api = overpass.API()
>>> data = api.get('way(42.819,-73.881,42.820,-73.880);(._;>;)', verbosity='geom')
>>> [f for f in data.features  if f.geometry['type'] == "LineString"]

(from a question on GIS Stackexchange)

responseformat

You can set the response type of your query using get()'s responseformat parameter to GeoJSON (geojson, the default), plain JSON (json), CSV (csv), and OSM XML (xml).

response = api.get('node["name"="Salt Lake City"]', responseformat="xml")

If you choose csv, you will need to specify which fields you want, as described here in the Overpass QL documentation. An example:

response = api.get('node["name"="Springfield"]["place"]', responseformat="csv(name,::lon,::lat)")

The response will be a list of lists:

[
    ['name', '@lon', '@lat'],
    ['Springfield', '-3.0645656', '56.2952787'],
    ['Springfield', '0.4937446', '51.7487585'],
    ['Springfield', '-2.4194716', '53.5732892'],
    ['Springfield', '25.5454526', '-33.9814866'],
    ....
]

build

We will construct a valid Overpass QL query from the parameters you set by default. This means you don't have to include 'meta' statements like [out:json], [timeout:60], [out body], etcetera. You just supply the meat of the query, the part that actually tells Overpass what to query for. If for whatever reason you want to override this and supply a full, valid Overpass QL query, you can set build to False to make the API not do any pre-processing.

date

You can query the data as it was on a given date. You can give either a standard ISO date alone (YYYY-MM-DD) or a full overpass date and time (YYYY-MM-DDTHH:MM:SSZ, i.e. 2020-04-28T00:00:00Z). You can also directly pass a date or datetime object from the datetime library.

Pre-cooked Queries: MapQuery, WayQuery

In addition to just sending your query and parse the result, overpass provides shortcuts for often used map queries. To use them, just pass them like to normal query to the API.

MapQuery

This is a shorthand for a complete ways and relations query in a bounding box (the 'map call'). You just pass the bounding box to the constructor:

MapQuery = overpass.MapQuery(50.746,7.154,50.748,7.157)
response = api.get(MapQuery)

WayQuery

This is shorthand for getting a set of ways and their child nodes that satisfy certain criteria. Pass the criteria as a Overpass QL stub to the constructor:

way_query = overpass.WayQuery('["name"="Highway 51"]')
response = api.get(way_query)

Testing

Run the default hermetic test suite with:

uv run python -W default -m pytest

Run all required local validation, matching hosted Forgejo/Codeberg CI, with:

scripts/check

Live API coverage is opt-in only and is not part of required validation:

USE_LIVE_API=true uv run python -m pytest -m live_api

FAQ

I need help or have an idea for a feature

Create a new issue.

Where did the CLI tool go?

The command line tool was deprecated in version 0.4.0.

See also

There are other python modules that do similar things.

• https://github.com/mocnik-science/osm-python-tools
• https://github.com/DinoTools/python-overpy