GeofabrikDownloader.get_download_index

GeofabrikDownloader.get_download_index(update=False, confirmation_required=True, verbose=False, raise_error=False, **kwargs)[source]

Get the official index of downloads for all available geographic (sub)regions.

Similar to get_catalogue().

Parameters:

  • update (bool) – whether to (check on and) update the prepacked data, defaults to False

  • confirmation_required (bool) – whether asking for confirmation to proceed, defaults to True

  • verbose (bool | int) – whether to print relevant information in console, defaults to False

  • raise_error (bool) – Whether to raise the provided exception; if raise_error=False (default), the error will be suppressed.

Returns:

the official index of all downloads

Return type:

pandas.DataFrame | None

Examples:

>>> from pydriosm.downloader import GeofabrikDownloader
>>> gfd = GeofabrikDownloader()
>>> download_index = gfd.get_download_index()
>>> type(download_index)
pandas.DataFrame
>>> download_index.shape
(544, 12)
>>> download_index.head()
            id  ...                                            updates
0          act  ...  https://download.geofabrik.de/australia-oceani...
1  afghanistan  ...  https://download.geofabrik.de/asia/afghanistan...
2       africa  ...       https://download.geofabrik.de/africa-updates
3      albania  ...  https://download.geofabrik.de/europe/albania-u...
4      alberta  ...  https://download.geofabrik.de/north-america/ca...
[5 rows x 12 columns]
>>> download_index.columns.to_list()
['id',
 'parent',
 'name',
 'iso3166-1:alpha2',
 'iso3166-2',
 'geometry',
 '.osm.pbf',
 '.shp.zip',
 'pbf-internal',
 'history',
 'taginfo',
 'updates']