Skip to main content

Python tools for interacting with Overture Maps (overturemaps.org) data.

Project description

PyPi

overturemaps-py

Official Python command-line tool of the Overture Maps Foundation

Overture Maps provides free and open geospatial map data, from many different sources and normalized to a common schema. This tool helps to download Overture data within a region of interest and converts it to a few different file formats. For more information about accessing Overture Maps data, see our official documentation site https://docs.overturemaps.org.

Note: This repository and project are experimental. Things are likely change including the user interface until a stable release, but we will keep the documentation here up-to-date.

Quick Start

Download the building footprints for the specific bounding box as GeoJSON and save to a file named "boston.geojson"

overturemaps download --bbox=-71.068,42.353,-71.058,42.363 -f geojson --type=building -o boston.geojson

Usage

download

Download Overture Maps data with an optional bounding box into the specified file format. When specifying a bounding box, only the minimum data is transferred. The result is streamed out and can handle arbitrarily large bounding boxes.

Command-line options:

  • --bbox (optional): west, south, east, north longitude and latitude coordinates. When omitted the entire dataset for the specified type will be downloaded
  • -f (required: one of "geojson", "geojsonseq", "geoparquet"): output format
  • --output/-o (optional): Location of output file. When omitted output will be written to stdout.
  • --type/-t (required): The Overture map data type to be downloaded. Examples of types are building for building footprints, place for POI places data, etc. Run overturemaps download --help for the complete list of allowed types
  • --connect_timeout (optional): Socket connection timeout, in seconds. If omitted, the AWS SDK default value is used (typically 1 second).
  • --request_timeout (optional): Socket read timeouts on Windows and macOS, in seconds. If omitted, the AWS SDK default value is used (typically 3 seconds). This option is ignored on non-Windows, non-macOS systems.
  • --stac/--no-stac (optional): By default, the reader uses Overture's STAC catalog to speed up queries to the latest release. If the --no-stac flag is present, the CLI will use the S3 path for the latest release directly.

This downloads data directly from Overture's S3 bucket without interacting with any other servers. By including bounding box extents on each row in the Overture distribution, the underlying Parquet readers use the Parquet summary statistics to download the minimum amount of data necessary to extract data from the desired region.

To help find bounding boxes of interest, we like this bounding box tool from Klokantech. Choose the CSV format and copy the value directly into the --bbox field here.

gers [UUID]

Look up an ID in the GERS Registry. If the feature is present in the latest release, it will download the feature and write it out in the specified format.

Command-line options:

  • -f ("geojson", "geojsonseq", "geoparquet"): output format, defaults to geojsonseq for a single feature on one line.
  • --output/-o (optional): Location of output file. When omitted output will be written to stdout.
  • --connect_timeout (optional): Socket connection timeout, in seconds. If omitted, the AWS SDK default value is used (typically 1 second).
  • --request_timeout (optional): Socket read timeouts on Windows and macOS, in seconds. If omitted, the AWS SDK default value is used (typically 3 seconds). This option is ignored on non-Windows, non-macOS systems.

Python API

overturemaps is also a Python library. Import directly from overturemaps to query Overture data without using the CLI.

Arrow / pyarrow

record_batch_reader returns a pyarrow.RecordBatchReader — a streaming cursor over the data. This is the lowest-level entry point and works with any Arrow-compatible tool.

from overturemaps import record_batch_reader

bbox = (-71.068, 42.353, -71.058, 42.363)  # xmin, ymin, xmax, ymax
reader = record_batch_reader("building", bbox=bbox)

if reader is not None:
    table = reader.read_all()
    print(table.schema)

GeoDataFrame (geopandas)

geodataframe loads data directly into a geopandas.GeoDataFrame. Requires geopandas to be installed (pip install overturemaps[geopandas] or pip install geopandas).

from overturemaps import geodataframe

bbox = (-71.068, 42.353, -71.058, 42.363)
gdf = geodataframe("building", bbox=bbox)
print(gdf.head())

Writing to a file format

Use get_writer and copy from overturemaps.writers to write data to GeoJSON, GeoJSONSeq, or GeoParquet without the CLI:

from overturemaps import record_batch_reader
from overturemaps.writers import copy, get_writer

bbox = (-71.068, 42.353, -71.058, 42.363)
reader = record_batch_reader("building", bbox=bbox)

with get_writer("geojson", "boston.geojson", schema=reader.schema) as writer:
    copy(reader, writer)

Supported format strings: "geojson", "geojsonseq", "geoparquet".

Installation

overturemaps is available via Homebrew:

brew install overturemaps

To install overturemaps from PyPi using pip:

pip install overturemaps

overturemaps is also on conda-forge and can be installed using conda, mamba, or pixi. To install overturemaps using conda:

conda install -c conda-forge overturemaps

If you have uv installed, you can run overturemaps with uvx without installing it:

uvx overturemaps download --bbox=-71.068,42.353,-71.058,42.363 -f geojson --type=building -o boston.parquet

Performance

Benchmarks using synthetic data on Apple M-series hardware:

Output format Geometry Rows Time
GeoJSON Points 10 000 31 ms
GeoJSON Polygons 10 000 44 ms
GeoParquet network/disk bound

To run the benchmarks locally:

uv sync --group dev
pytest benchmarks/ -v

Development

uv sync
uv run pytest tests/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

overturemaps-1.0.0.tar.gz (107.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

overturemaps-1.0.0-py3-none-any.whl (25.3 kB view details)

Uploaded Python 3

File details

Details for the file overturemaps-1.0.0.tar.gz.

File metadata

  • Download URL: overturemaps-1.0.0.tar.gz
  • Upload date:
  • Size: 107.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for overturemaps-1.0.0.tar.gz
Algorithm Hash digest
SHA256 2fb9f5d37e2a215259cc1994ddcdf3f312f54f0491aee5457ce48aa9c0514240
MD5 7ed2c182bace93a7db97e5d2fbac353b
BLAKE2b-256 d0658327d6961f9e5f526e899d1db376c277094c36f20f23d1a278b66e6939a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for overturemaps-1.0.0.tar.gz:

Publisher: publish-pypi.yml on OvertureMaps/overturemaps-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file overturemaps-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: overturemaps-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 25.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for overturemaps-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7a621f15f59065168775a5c48e552865dffed97c057a5391484aa9a35cdcf19
MD5 a56e03d5f9efd4812de1219d877a0c92
BLAKE2b-256 28ad909077d40eee47a3fa4e808005557d05d83f578ff2f8d3baa82c384c6e2f

See more details on using hashes here.

Provenance

The following attestation bundles were made for overturemaps-1.0.0-py3-none-any.whl:

Publisher: publish-pypi.yml on OvertureMaps/overturemaps-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page