Skip to main content

Nominatim - Frontend Library

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 library for searching a Nominatim database imported with the nominatim-db package.

Installation

To install the Nominatim API from pypi, run:

pip install nominatim-api

Running a Nominatim server

You need Falcon or Starlette to run Nominatim as a service, as well as an ASGI-capable server like uvicorn. To install them from pypi run:

pip install falcon uvicorn

You need to have a Nominatim database imported with the 'nominatim-db' package. Go to the project directory, then run uvicorn as:

uvicorn --factory nominatim_api.server.falcon.server:run_wsgi

Documentation

The full documentation for the Nominatim library can be found at: https://nominatim.org/release-docs/latest/library/Getting-Started/

The v1 API of the server is documented at: https://nominatim.org/release-docs/latest/api/Overview/

License

The source code is available under a GPLv3 license.

Metadata

Release files for nominatim-api 5.3.2

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-api 5.3.2
File Size Uploaded
nominatim_api-5.3.2.tar.gz 365.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nominatim-api 5.3.2
File Interpreter ABI Platform
nominatim_api-5.3.2-py3-none-any.whl Python 3 none any Details

Total release size: 890.6 kB

Release files / nominatim_api-5.3.2.tar.gz

Download URL nominatim_api-5.3.2.tar.gz
Size 365.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e3abe7917b0f2bca44c16dca1e492007b1e372bc1440032e78845456e08fa183
BLAKE2b-256 checksum
How to use checksums
cd5a6329fdb2e4d8eaad5c9066fad0a782d666d637fdcd6696df99327c5b67e7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / nominatim_api-5.3.2-py3-none-any.whl

Download URL nominatim_api-5.3.2-py3-none-any.whl
Size 525.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
052e63d4291972d513b40530ddad09f54d51516b97cb07c834e79439d4190c89
BLAKE2b-256 checksum
How to use checksums
fd6144941d65409414b66a13c55c671b7ec67c05e27b4d988515b95e4023ce1e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release history Release notifications | RSS feed

This release

5.3.2 This release

2 release files

5.3.1

2 release files

5.3.0

2 release files

5.2.0

2 release files

5.1.0

2 release files

5.0.0

2 release files

4.5.0

2 release files

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