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.0.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.0-py3-none-any.whl (525.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nominatim_api-5.3.0.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.0.tar.gz
Algorithm Hash digest
SHA256 9396dd3613f9c78febeb8747ba374151b4213eec113eb88d873c12890ed1fbc1
MD5 7d834a2799756811390100f198d83c1d
BLAKE2b-256 1dfa597ddba14431487e4d5ef9b8573d44c665b2ad67e69a72fd13be44d329ef

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nominatim_api-5.3.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 661381065812273d03a3c7eee1393943d5994c800494d291c5769a1994e2913b
MD5 9f2bfbce8fbebe97a85f546569bc0463
BLAKE2b-256 56e664f7865c6f6b01d1c16124b3653c349bc8673e3f4bcca044e7da26eee3e2

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