Skip to main content

Python Command-line Tool

Overture's Python command-line tool helps you download data within a region of interest and converts it to several common geospatial file formats. This example shows how to use the tool to download Overture's land cover data in a Jupyter notebook.

note

This project is experimental and likely to change. See the overturemaps-py repository for timely updates.

Installation

pip install overturemaps

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

Right now there is only one option to the overturemaps utility: download. It will 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

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.

Next steps