osm module¶

The address to geocode and use as the central point around which to get the geometries.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

Distance in meters. Defaults to 1000.

A GeoDataFrame of OSM entities.

Northern latitude of bounding box.

Southern latitude of bounding box.

Eastern longitude of bounding box.

Western longitude of bounding box.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

A GeoDataFrame of OSM entities.

Query string(s) or structured dict(s) to geocode.

Which geocoding result to use. if None, auto-select the first (Multi)Polygon or raise an error if OSM doesn't return one. to get the top match regardless of geometry type, set which_result=1. Defaults to None.

If True, handle query as an OSM ID for lookup rather than text search. Defaults to False.

Distance to buffer around the place geometry, in meters. Defaults to None.

A GeoPandas GeoDataFrame.

Query string(s) or structured dict(s) to geocode.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

Which geocoding result to use. if None, auto-select the first (Multi)Polygon or raise an error if OSM doesn't return one. to get the top match regardless of geometry type, set which_result=1. Defaults to None.

Distance to buffer around the place geometry, in meters. Defaults to None.

A GeoDataFrame of OSM entities.

The (lat, lng) center point around which to get the geometries.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

Distance in meters. Defaults to 1000.

A GeoDataFrame of OSM entities.

Geographic boundaries to fetch geometries within

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

A GeoDataFrame of OSM entities.

File path to file containing OSM XML data

Optional geographic boundary to filter objects. Defaults to None.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

A GeoDataFrame of OSM entities.

The address to geocode and use as the central point around which to get the geometries.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

File path to the output GeoJSON. Defaults to None.

Distance in meters. Defaults to 1000.

A GeoJSON dictionary of OSM entities.

Northern latitude of bounding box.

Southern latitude of bounding box.

Eastern longitude of bounding box.

Western longitude of bounding box.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

File path to the output GeoJSON.

A GeoJSON dictionary of OSM entities.

Query string(s) or structured dict(s) to geocode.

File path to the output GeoJSON.

Which geocoding result to use. if None, auto-select the first (Multi)Polygon or raise an error if OSM doesn't return one. to get the top match regardless of geometry type, set which_result=1. Defaults to None.

If True, handle query as an OSM ID for lookup rather than text search. Defaults to False.

Distance to buffer around the place geometry, in meters. Defaults to None.

A GeoJSON dictionary of OSM entities.

Query string(s) or structured dict(s) to geocode.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

File path to the output shapefile.

Which geocoding result to use. if None, auto-select the first (Multi)Polygon or raise an error if OSM doesn't return one. to get the top match regardless of geometry type, set which_result=1. Defaults to None.

Distance to buffer around the place geometry, in meters. Defaults to None.

A GeoJSON dictionary of OSM entities.

The (lat, lng) center point around which to get the geometries.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

File path to the output shapefile.

Distance in meters. Defaults to 1000.

A GeoJSON dictionary of OSM entities.

Geographic boundaries to fetch geometries within

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

File path to the output GeoJSON.

A GeoJSON dictionary of OSM entities.

The address to geocode and use as the central point around which to get the geometries.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

File path to the output shapefile.

Distance in meters. Defaults to 1000.

Northern latitude of bounding box.

Southern latitude of bounding box.

Eastern longitude of bounding box.

Western longitude of bounding box.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

File path to the output shapefile.

Query string(s) or structured dict(s) to geocode.

File path to the output shapefile.

Which geocoding result to use. if None, auto-select the first (Multi)Polygon or raise an error if OSM doesn't return one. to get the top match regardless of geometry type, set which_result=1. Defaults to None.

If True, handle query as an OSM ID for lookup rather than text search. Defaults to False.

Distance to buffer around the place geometry, in meters. Defaults to None.

Query string(s) or structured dict(s) to geocode.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

File path to the output shapefile.

Which geocoding result to use. if None, auto-select the first (Multi)Polygon or raise an error if OSM doesn't return one. to get the top match regardless of geometry type, set which_result=1. Defaults to None.

Distance to buffer around the place geometry, in meters. Defaults to None.

The (lat, lng) center point around which to get the geometries.

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

File path to the output shapefile.

Distance in meters. Defaults to 1000.

Geographic boundaries to fetch geometries within

Dict of tags used for finding objects in the selected area. Results returned are the union, not intersection of each individual tag. Each result matches at least one given tag. The dict keys should be OSM tags, (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {‘building’: True} would return all building footprints in the area. tags = {‘amenity’:True, ‘landuse’:[‘retail’,’commercial’], ‘highway’:’bus_stop’} would return all amenities, landuse=retail, landuse=commercial, and highway=bus_stop.

File path to the output shapefile.

Bounding box as (west, south, east, north) or (minx, miny, maxx, maxy) in WGS84 coordinates.

Dict of tags used for filtering OSM features. The dict keys should be OSM tags (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. Defaults to None (all features).

Verbosity mode for progress output. Options are "verbose", "transient", or "silent". Defaults to "transient".

Additional keyword arguments passed to QuackOSM's convert_geometry_to_geodataframe.

A GeoDataFrame containing OSM features with 'tags' and 'geometry' columns.

A Shapely geometry (Polygon, MultiPolygon), WKT string, GeoJSON dict, or a GeoDataFrame. The geometry defines the area of interest.

Dict of tags used for filtering OSM features. The dict keys should be OSM tags (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. Defaults to None (all features).

Verbosity mode for progress output. Options are "verbose", "transient", or "silent". Defaults to "transient".

Additional keyword arguments passed to QuackOSM's convert_geometry_to_geodataframe.

A GeoDataFrame containing OSM features with 'tags' and 'geometry' columns.

Path to the local PBF file.

Dict of tags used for filtering OSM features. The dict keys should be OSM tags (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. Defaults to None (all features).

Optional Shapely geometry to clip the data to. Defaults to None.

Verbosity mode for progress output. Options are "verbose", "transient", or "silent". Defaults to "transient".

Additional keyword arguments passed to QuackOSM's convert_pbf_to_geodataframe.

A GeoDataFrame containing OSM features with 'tags' and 'geometry' columns.

Place name to geocode (e.g., "Vatican City", "Monaco", "Manhattan, New York").

Dict of tags used for filtering OSM features. The dict keys should be OSM tags (e.g., building, landuse, highway, etc) and the dict values should be either True to retrieve all items with the given tag, or a string to get a single tag-value combination, or a list of strings to get multiple values for the given tag. For example, tags = {'building': True} would return all building footprints in the area. tags = {'amenity': True, 'highway': 'bus_stop'} would return all amenities and highway=bus_stop features. Defaults to None (all features).

Source for OSM extracts. Options include "geofabrik", "osmfr", "bbbike", etc. If None, QuackOSM will automatically select the best source. Defaults to None.

Verbosity mode for progress output. Options are "verbose", "transient", or "silent". Defaults to "transient".

Additional keyword arguments passed to QuackOSM's convert_osm_extract_to_geodataframe or convert_geometry_to_geodataframe functions.

A GeoDataFrame containing OSM features with 'tags' and 'geometry' columns.

The data source. Can be: - A place name string (e.g., "Monaco") - A bounding box tuple (west, south, east, north) - A Shapely geometry - A GeoDataFrame

Path to save the output GeoParquet file.

Dict of tags used for filtering OSM features. Defaults to None.

Verbosity mode for progress output. Defaults to "transient".

Additional keyword arguments passed to QuackOSM functions.

Path to the saved GeoParquet file.