Skip to main content

A tool for building a database of OpenStreetMap for geocoding and for searching the database. Search library.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nominatim_api-5.3.2.tar.gz (365.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nominatim_api-5.3.2-py3-none-any.whl (525.2 kB view details)

Uploaded Python 3

File details

Details for the file nominatim_api-5.3.2.tar.gz.

File metadata

  • Download URL: nominatim_api-5.3.2.tar.gz
  • Upload date:
  • Size: 365.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for nominatim_api-5.3.2.tar.gz
Algorithm Hash digest
SHA256 e3abe7917b0f2bca44c16dca1e492007b1e372bc1440032e78845456e08fa183
MD5 073aee45bcf0b34da5b0605f90904026
BLAKE2b-256 cd5a6329fdb2e4d8eaad5c9066fad0a782d666d637fdcd6696df99327c5b67e7

See more details on using hashes here.

File details

Details for the file nominatim_api-5.3.2-py3-none-any.whl.

File metadata

  • Download URL: nominatim_api-5.3.2-py3-none-any.whl
  • Upload date:
  • Size: 525.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for nominatim_api-5.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 052e63d4291972d513b40530ddad09f54d51516b97cb07c834e79439d4190c89
MD5 0f2df4f1a2ac80ab3852d49807d29e2f
BLAKE2b-256 fd6144941d65409414b66a13c55c671b7ec67c05e27b4d988515b95e4023ce1e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page