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

Built distribution (wheel)

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

Total release size: 894.8 kB

Release files / nominatim_api-5.3.3.tar.gz

Download URL nominatim_api-5.3.3.tar.gz
Size 367.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a6d20cf44b943e5b03d17d61514792d11e1509a7e4b354187d96894dcece3ab2
BLAKE2b-256 checksum
How to use checksums
8767bc8fba64e9ca815dd4eecb829e4438170235a406f7ada0d4cbc9a2250776
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

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

Download URL nominatim_api-5.3.3-py3-none-any.whl
Size 527.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
638ba370b47023e6a623accec89e29a333ad0e8a90629a935bd6674a5b8775a6
BLAKE2b-256 checksum
How to use checksums
44cc9b635118deec01a93a760cc7a1998118c086e1115a81badac007513f6fa6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release history Release notifications | RSS feed

This release

5.3.3 This release

2 release files

5.3.2

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