Skip to main content

Nominatim - DB Backend

Nominatim is a tool to search OpenStreetMap data by name and address (geocoding) and to generate synthetic addresses of OSM points (reverse geocoding).

This module implements the database backend for Nominatim and the command-line tool for importing and maintaining the database.

Installation

Prerequisites

Nominatim requires osm2pgsql (>=1.8) for reading OSM data and PostgreSQL (>=9.6) to store the data.

On Ubuntu (>=23.04) and Debian (when using backports), you can install them with:

sudo apt-get install osm2pgsql postgresql-postgis

Installation from pypi

To install Nominatim from pypi, run:

pip install nominatim-db

Quick start

First create a project directory for your new Nominatim database, which is the space for additional configuration and customization:

mkdir nominatim-project

Make sure you run all nominatim commands from within the project directory:

cd nominatim-project

Download an appropriate data extract, for example from Geofabrik and import the file:

nominatim import --osm-file <downlaoded-osm-data.pbf>

You will need to install the nominatim-api package to query the database.

Documentation

A HTML version of the documentation can be found at https://nominatim.org/release-docs/latest/ .

License

The source code is available under a GPLv3 license.

Metadata

Release files for nominatim-db 5.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nominatim-db 5.3.3
File Size Uploaded Provenance Actions
nominatim_db-5.3.3.tar.gz 15.1 MB Without provenance Details for nominatim_db-5.3.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nominatim-db 5.3.3
File Interpreter ABI Platform Actions
nominatim_db-5.3.3-py3-none-any.whl Python 3 none any Details for nominatim_db-5.3.3-py3-none-any.whl

Total release size: 30.4 MB

Release files / nominatim_db-5.3.3.tar.gz

Download URL nominatim_db-5.3.3.tar.gz
Size 15.1 MB
Tags Source
SHA-256 checksum
How to use checksums
6919847eb742fe6e52dbb79654d7970e5b538fc4925a459433aeeab5315b7603
BLAKE2b-256 checksum
How to use checksums
1d737cdaa70e9995714fe30b14a10b0c7c0da92c9e55c6a7e15a090f17a38213
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release files / nominatim_db-5.3.3-py3-none-any.whl

Download URL nominatim_db-5.3.3-py3-none-any.whl
Size 15.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
6ecfeaf9c68eeec9aac18c61b8d4a1972dfc096589013612891a857cbaf56781
BLAKE2b-256 checksum
How to use checksums
6d45baadf61a81628aa78d8a7e0fcf68a565fd69e082128877f8c1152817cda4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Security for nominatim-db 5.3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page