.TH NOMINATIM "1" "2026\-04\-19" "Nominatim" "Generated Python Manual" .SH NAME nominatim .SH SYNOPSIS .B nominatim [-h] [--version] {import,freeze,replication,special-phrases,add-data,index,refresh,admin,export,convert,serve,search,reverse,lookup,details,status} ... .SH DESCRIPTION Command\-line tools for importing, updating, administrating and querying the Nominatim database. 'cli_args' is a list of parameters for the command to run. If not given, sys.args will be used. 'environ' is the dictionary of environment variables containing the Nominatim configuration. When None, the os.environ is inherited. .SH OPTIONS .TP \fB\-\-version\fR Print Nominatim version and exit .SH AVAILABLE COMMANDS .TP \fBnominatim\fR \fI\,import\/\fR Create a new Nominatim database from an OSM file. .TP \fBnominatim\fR \fI\,freeze\/\fR Make database read\-only. .TP \fBnominatim\fR \fI\,replication\/\fR Update the database using an online replication service. .TP \fBnominatim\fR \fI\,special\-phrases\/\fR Import special phrases. .TP \fBnominatim\fR \fI\,add\-data\/\fR Add additional data from a file or an online source. .TP \fBnominatim\fR \fI\,index\/\fR Reindex all new and modified data. .TP \fBnominatim\fR \fI\,refresh\/\fR Recompute auxiliary data used by the indexing process. .TP \fBnominatim\fR \fI\,admin\/\fR Analyse and maintain the database. .TP \fBnominatim\fR \fI\,export\/\fR Export places as CSV file from the database. .TP \fBnominatim\fR \fI\,convert\/\fR Convert an existing database into a different format. (EXPERIMENTAL) .TP \fBnominatim\fR \fI\,serve\/\fR Start a simple web server for serving the API. .TP \fBnominatim\fR \fI\,search\/\fR Execute a search query. .TP \fBnominatim\fR \fI\,reverse\/\fR Execute API reverse query. .TP \fBnominatim\fR \fI\,lookup\/\fR Execute API lookup query. .TP \fBnominatim\fR \fI\,details\/\fR Execute API details query. .TP \fBnominatim\fR \fI\,status\/\fR .SH COMMAND \fI\,'nominatim import'\/\fR usage: nominatim import [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-osm\-file FILE] [\-\-continue {import\-from\-file,load\-data,indexing,db\-postprocess}] [\-\-osm2pgsql\-cache SIZE] [\-\-reverse\-only] [\-\-no\-partitions] [\-\-no\-updates] [\-\-offline] [\-\-ignore\-errors] [\-\-index\-noanalyse] [\-\-prepare\-database] Create a new Nominatim database from an OSM file. This sub\-command sets up a new Nominatim database from scratch starting with creating a new database in Postgresql. The user running this command needs superuser rights on the database. .SH DEFAULT ARGUMENTS \fI\,'nominatim import'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH REQUIRED ARGUMENTS \fI\,'nominatim import'\/\fR .TP \fB\-\-osm\-file\fR \fI\,FILE\/\fR OSM file to be imported (repeat for importing multiple files) .TP \fB\-\-continue\fR \fI\,{import\-from\-file,load\-data,indexing,db\-postprocess}\/\fR Continue an import that was interrupted .SH OPTIONAL ARGUMENTS \fI\,'nominatim import'\/\fR .TP \fB\-\-osm2pgsql\-cache\fR \fI\,SIZE\/\fR Size of cache to be used by osm2pgsql (in MB) .TP \fB\-\-reverse\-only\fR Do not create tables and indexes for searching .TP \fB\-\-no\-partitions\fR Do not partition search indices (speeds up import of single country extracts) .TP \fB\-\-no\-updates\fR Do not keep tables that are only needed for updating the database later .TP \fB\-\-offline\fR Do not attempt to load any additional data from the internet .SH EXPERT OPTIONS \fI\,'nominatim import'\/\fR .TP \fB\-\-ignore\-errors\fR Continue import even when errors in SQL are present .TP \fB\-\-index\-noanalyse\fR Do not perform analyse operations during index (expert only) .TP \fB\-\-prepare\-database\fR Create the database but do not import any data .SH COMMAND \fI\,'nominatim freeze'\/\fR usage: nominatim freeze [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] Make database read\-only. About half of data in the Nominatim database is kept only to be able to keep the data up\-to\-date with new changes made in OpenStreetMap. This command drops all this data and only keeps the part needed for geocoding itself. This command has the same effect as the `\-\-no\-updates` option for imports. .SH DEFAULT ARGUMENTS \fI\,'nominatim freeze'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH COMMAND \fI\,'nominatim replication'\/\fR usage: nominatim replication [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-init] [\-\-no\-update\-functions] [\-\-check\-for\-updates] [\-\-once] [\-\-catch\-up] [\-\-no\-index] [\-\-osm2pgsql\-cache SIZE] [\-\-socket\-timeout SOCKET_TIMEOUT] Update the database using an online replication service. An OSM replication service is an online service that provides regular updates (OSM diff files) for the planet or update they provide. The OSMF provides the primary replication service for the full planet at https://planet.osm.org/replication/ but there are other providers of extracts of OSM data who provide such a service as well. This sub\-command allows to set up such a replication service and download and import updates at regular intervals. You need to call '\-\-init' once to set up the process or whenever you change the replication configuration parameters. Without any arguments, the sub\-command will go into a loop and continuously apply updates as they become available. Giving `\-\-once` just downloads and imports the next batch of updates. .SH DEFAULT ARGUMENTS \fI\,'nominatim replication'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH ARGUMENTS FOR INITIALISATION \fI\,'nominatim replication'\/\fR .TP \fB\-\-init\fR Initialise the update process .TP \fB\-\-no\-update\-functions\fR Do not update the trigger function to support differential updates (EXPERT) .SH ARGUMENTS FOR UPDATES \fI\,'nominatim replication'\/\fR .TP \fB\-\-check\-for\-updates\fR Check if new updates are available and exit .TP \fB\-\-once\fR Download and apply updates only once. When not set, updates are continuously applied .TP \fB\-\-catch\-up\fR Download and apply updates until no new data is available on the server .TP \fB\-\-no\-index\fR Do not index the new data. Only usable together with \-\-once .TP \fB\-\-osm2pgsql\-cache\fR \fI\,SIZE\/\fR Size of cache to be used by osm2pgsql (in MB) .SH DOWNLOAD PARAMETERS \fI\,'nominatim replication'\/\fR .TP \fB\-\-socket\-timeout\fR \fI\,SOCKET_TIMEOUT\/\fR Set timeout for file downloads .SH COMMAND \fI\,'nominatim special\-phrases'\/\fR usage: nominatim special\-phrases [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-import\-from\-wiki] [\-\-import\-from\-csv FILE] [\-\-no\-replace] [\-\-min MIN] Import special phrases. Special phrases are search terms that narrow down the type of object that should be searched. For example, you might want to search for 'Hotels in Barcelona'. The OSM wiki has a selection of special phrases in many languages, which can be imported with this command. You can also provide your own phrases in a CSV file. The file needs to have the following five columns: * phrase \- the term expected for searching * class \- the OSM tag key of the object type * type \- the OSM tag value of the object type * operator \- the kind of search to be done (one of: in, near, name, \-) * plural \- whether the term is a plural or not (Y/N) An example file can be found in the Nominatim sources at 'test/testdb/full_en_phrases_test.csv'. The import can be further configured to ignore specific key/value pairs. This is particularly useful when importing phrases from the wiki. The default configuration excludes some very common tags like building=yes. The configuration can be customized by putting a file `phrase\-settings.json` with custom rules into the project directory or by using the `\-\-config` option to point to another configuration file. .SH DEFAULT ARGUMENTS \fI\,'nominatim special\-phrases'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH INPUT ARGUMENTS \fI\,'nominatim special\-phrases'\/\fR .TP \fB\-\-import\-from\-wiki\fR Import special phrases from the OSM wiki to the database .TP \fB\-\-import\-from\-csv\fR \fI\,FILE\/\fR Import special phrases from a CSV file .TP \fB\-\-no\-replace\fR Keep the old phrases and only add the new ones .TP \fB\-\-min\fR \fI\,MIN\/\fR Restrict special phrases by minimum occurance .SH COMMAND \fI\,'nominatim add\-data'\/\fR usage: nominatim add\-data [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] (\-\-file FILE | \-\-diff FILE | \-\-node ID | \-\-way ID | \-\-relation ID | \-\-tiger\-data DIR) [\-\-use\-main\-api] [\-\-osm2pgsql\-cache SIZE] [\-\-socket\-timeout SOCKET_TIMEOUT] Add additional data from a file or an online source. This command allows to add or update the search data in the database. The data can come either from an OSM file or single OSM objects can directly be downloaded from the OSM API. This function only loads the data into the database. Afterwards it still needs to be integrated in the search index. Use the `nominatim index` command for that. The command can also be used to add external non\-OSM data to the database. At the moment the only supported format is TIGER housenumber data. See the online documentation at https://nominatim.org/release\-docs/latest/customize/Tiger/ for more information. .SH DEFAULT ARGUMENTS \fI\,'nominatim add\-data'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH SOURCE \fI\,'nominatim add\-data'\/\fR .TP \fB\-\-file\fR \fI\,FILE\/\fR Import data from an OSM file or diff file .TP \fB\-\-diff\fR \fI\,FILE\/\fR Import data from an OSM diff file (deprecated: use \-\-file) .TP \fB\-\-node\fR \fI\,ID\/\fR Import a single node from the API .TP \fB\-\-way\fR \fI\,ID\/\fR Import a single way from the API .TP \fB\-\-relation\fR \fI\,ID\/\fR Import a single relation from the API .TP \fB\-\-tiger\-data\fR \fI\,DIR\/\fR Add housenumbers from the US TIGER census database .SH EXTRA ARGUMENTS \fI\,'nominatim add\-data'\/\fR .TP \fB\-\-use\-main\-api\fR Use OSM API instead of Overpass to download objects .TP \fB\-\-osm2pgsql\-cache\fR \fI\,SIZE\/\fR Size of cache to be used by osm2pgsql (in MB) .TP \fB\-\-socket\-timeout\fR \fI\,SOCKET_TIMEOUT\/\fR Set timeout for file downloads .SH COMMAND \fI\,'nominatim index'\/\fR usage: nominatim index [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-boundaries\-only] [\-\-no\-boundaries] [\-\-minrank RANK] [\-\-maxrank RANK] Reindex all new and modified data. Indexing is the process of computing the address and search terms for the places in the database. Every time data is added or changed, indexing needs to be run. Imports and replication updates automatically take care of indexing. For other cases, this function allows to run indexing manually. .SH DEFAULT ARGUMENTS \fI\,'nominatim index'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH FILTER ARGUMENTS \fI\,'nominatim index'\/\fR .TP \fB\-\-boundaries\-only\fR Index only administrative boundaries. .TP \fB\-\-no\-boundaries\fR Index everything except administrative boundaries. .TP \fB\-\-minrank\fR \fI\,RANK\/\fR, \fB\-r\fR \fI\,RANK\/\fR Minimum/starting rank .TP \fB\-\-maxrank\fR \fI\,RANK\/\fR, \fB\-R\fR \fI\,RANK\/\fR Maximum/finishing rank .SH COMMAND \fI\,'nominatim refresh'\/\fR usage: nominatim refresh [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-postcodes] [\-\-word\-tokens] [\-\-word\-counts] [\-\-address\-levels] [\-\-functions] [\-\-wiki\-data] [\-\-secondary\-importance] [\-\-importance] [\-\-ro\-access] [\-\-website] [\-\-data\-object OBJECT] [\-\-data\-area OBJECT] [\-\-no\-diff\-updates] [\-\-enable\-debug\-statements] [\-\-force\-reimport] Recompute auxiliary data used by the indexing process. This sub\-commands updates various static data and functions in the database. It usually needs to be run after changing various aspects of the configuration. The configuration documentation will mention the exact command to use in such case. Warning: the 'update' command must not be run in parallel with other update commands like 'replication' or 'add\-data'. .SH DEFAULT ARGUMENTS \fI\,'nominatim refresh'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH DATA ARGUMENTS \fI\,'nominatim refresh'\/\fR .TP \fB\-\-postcodes\fR Update postcode centroid table .TP \fB\-\-word\-tokens\fR Clean up search terms .TP \fB\-\-word\-counts\fR Compute frequency of full\-word search terms .TP \fB\-\-address\-levels\fR Reimport address level configuration .TP \fB\-\-functions\fR Update the PL/pgSQL functions in the database .TP \fB\-\-wiki\-data\fR Update Wikipedia/data importance numbers .TP \fB\-\-secondary\-importance\fR Update secondary importance raster data .TP \fB\-\-importance\fR Recompute place importances (expensive!) .TP \fB\-\-ro\-access\fR Grant read\-only access to web user for all tables .TP \fB\-\-website\fR DEPRECATED. This function has no function anymore and will be removed in a future version. .TP \fB\-\-data\-object\fR \fI\,OBJECT\/\fR Mark the given OSM object as requiring an update (format: [NWR]) .TP \fB\-\-data\-area\fR \fI\,OBJECT\/\fR Mark the area around the given OSM object as requiring an update (format: [NWR]) .SH ARGUMENTS FOR FUNCTION REFRESH \fI\,'nominatim refresh'\/\fR .TP \fB\-\-no\-diff\-updates\fR Do not enable code for propagating updates .TP \fB\-\-enable\-debug\-statements\fR Enable debug warning statements in functions .SH ARGUMENTS FOR POSTCODE REFRESH \fI\,'nominatim refresh'\/\fR .TP \fB\-\-force\-reimport\fR Recompute the postcodes from scratch instead of updating .SH COMMAND \fI\,'nominatim admin'\/\fR usage: nominatim admin [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] (\-\-warm | \-\-check\-database | \-\-migrate | \-\-analyse\-indexing | \-\-collect\-os\-info | \-\-clean\-deleted AGE) [\-\-search\-only] [\-\-reverse\-only] [\-\-osm\-id OSM_ID | \-\-place\-id PLACE_ID] Analyse and maintain the database. .SH DEFAULT ARGUMENTS \fI\,'nominatim admin'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH ADMIN TASKS \fI\,'nominatim admin'\/\fR .TP \fB\-\-warm\fR Warm database caches for search and reverse queries .TP \fB\-\-check\-database\fR Check that the database is complete and operational .TP \fB\-\-migrate\fR Migrate the database to a new software version .TP \fB\-\-analyse\-indexing\fR Print performance analysis of the indexing process .TP \fB\-\-collect\-os\-info\fR Generate a report about the host system information .TP \fB\-\-clean\-deleted\fR \fI\,AGE\/\fR Clean up deleted relations .SH ARGUMENTS FOR CACHE WARMING \fI\,'nominatim admin'\/\fR .TP \fB\-\-search\-only\fR Only pre\-warm tables for search queries .TP \fB\-\-reverse\-only\fR Only pre\-warm tables for reverse queries .SH ARGUMENTS FOR INDEX ANAYSIS \fI\,'nominatim admin'\/\fR .TP \fB\-\-osm\-id\fR \fI\,OSM_ID\/\fR Analyse indexing of the given OSM object .TP \fB\-\-place\-id\fR \fI\,PLACE_ID\/\fR Analyse indexing of the given Nominatim object .SH COMMAND \fI\,'nominatim export'\/\fR usage: nominatim export [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-output\-type {country,state,county,city,suburb,street,path}] [\-\-output\-format OUTPUT_FORMAT] [\-\-language LANGUAGE] [\-\-restrict\-to\-country COUNTRY_CODE] [\-\-restrict\-to\-osm\-node ID] [\-\-restrict\-to\-osm\-way ID] [\-\-restrict\-to\-osm\-relation ID] Export places as CSV file from the database. .SH DEFAULT ARGUMENTS \fI\,'nominatim export'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH OUTPUT ARGUMENTS \fI\,'nominatim export'\/\fR .TP \fB\-\-output\-type\fR \fI\,{country,state,county,city,suburb,street,path}\/\fR Type of places to output (default: street) .TP \fB\-\-output\-format\fR \fI\,OUTPUT_FORMAT\/\fR Semicolon\-separated list of address types (see \-\-output\-type). Additionally accepts:placeid,postcode .TP \fB\-\-language\fR \fI\,LANGUAGE\/\fR Preferred language for output (use local name, if omitted) .SH FILTER ARGUMENTS \fI\,'nominatim export'\/\fR .TP \fB\-\-restrict\-to\-country\fR \fI\,COUNTRY_CODE\/\fR Export only objects within country .TP \fB\-\-restrict\-to\-osm\-node\fR \fI\,ID\/\fR Export only children of this OSM node .TP \fB\-\-restrict\-to\-osm\-way\fR \fI\,ID\/\fR Export only children of this OSM way .TP \fB\-\-restrict\-to\-osm\-relation\fR \fI\,ID\/\fR Export only children of this OSM relation .SH COMMAND \fI\,'nominatim convert'\/\fR usage: nominatim convert [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-format {sqlite}] \-\-output OUTPUT [\-\-with\-reverse] [\-\-with\-search] [\-\-with\-details] Convert an existing database into a different format. (EXPERIMENTAL) Dump a read\-only version of the database in a different format. At the moment only a SQLite database suitable for reverse lookup can be created. .SH OPTIONS \fI\,'nominatim convert'\/\fR .TP \fB\-\-format\fR \fI\,{sqlite}\/\fR Format of the output database (must be sqlite currently) .TP \fB\-\-output\fR \fI\,OUTPUT\/\fR, \fB\-o\fR \fI\,OUTPUT\/\fR File to write the database to. .SH DEFAULT ARGUMENTS \fI\,'nominatim convert'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH SWITCHES TO DEFINE DATABASE LAYOUT(CURRENTLY NO EFFECT) \fI\,'nominatim convert'\/\fR .TP \fB\-\-with\-reverse\fR, \fB\-\-without\-reverse\fR Enable/disable support for reverse and lookup API (default: enabled) .TP \fB\-\-with\-search\fR, \fB\-\-without\-search\fR Enable/disable support for search API (default: disabled) .TP \fB\-\-with\-details\fR, \fB\-\-without\-details\fR Enable/disable support for details API (default: enabled) .SH COMMAND \fI\,'nominatim serve'\/\fR usage: nominatim serve [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-server SERVER] [\-\-engine {falcon,starlette}] Start a simple web server for serving the API. This command starts a built\-in webserver to serve the website from the current project directory. This webserver is only suitable for testing and development. Do not use it in production setups! There are two different webserver implementations for Python available: falcon (the default) and starlette. You need to make sure the appropriate Python packages as well as the uvicorn package are installed to use this function. By the default, the webserver can be accessed at: http://127.0.0.1:8088 .SH DEFAULT ARGUMENTS \fI\,'nominatim serve'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH SERVER ARGUMENTS \fI\,'nominatim serve'\/\fR .TP \fB\-\-server\fR \fI\,SERVER\/\fR The address the server will listen to. .TP \fB\-\-engine\fR \fI\,{falcon,starlette}\/\fR Webserver framework to run. (default: falcon) .SH COMMAND \fI\,'nominatim search'\/\fR usage: nominatim search [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-query QUERY] [\-\-amenity AMENITY] [\-\-street STREET] [\-\-city CITY] [\-\-county COUNTY] [\-\-state STATE] [\-\-country COUNTRY] [\-\-postalcode POSTALCODE] [\-\-format FORMAT] [\-\-addressdetails] [\-\-extratags] [\-\-entrances] [\-\-namedetails] [\-\-lang LANGS] [\-\-polygon\-output {geojson,kml,svg,text}] [\-\-polygon\-threshold TOLERANCE] [\-\-countrycodes CC,..] [\-\-exclude_place_ids ID,..] [\-\-limit LIMIT] [\-\-viewbox X1,Y1,X2,Y2] [\-\-bounded] [\-\-layer LAYER] [\-\-no\-dedupe] [\-\-list\-formats] Execute a search query. This command works exactly the same as if calling the /search endpoint on the web API. See the online documentation for more details on the various parameters: https://nominatim.org/release\-docs/latest/api/Search/ .SH DEFAULT ARGUMENTS \fI\,'nominatim search'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH QUERY ARGUMENTS \fI\,'nominatim search'\/\fR .TP \fB\-\-query\fR \fI\,QUERY\/\fR Free\-form query string .TP \fB\-\-amenity\fR \fI\,AMENITY\/\fR Structured query: name and/or type of POI .TP \fB\-\-street\fR \fI\,STREET\/\fR Structured query: housenumber and street .TP \fB\-\-city\fR \fI\,CITY\/\fR Structured query: city, town or village .TP \fB\-\-county\fR \fI\,COUNTY\/\fR Structured query: county .TP \fB\-\-state\fR \fI\,STATE\/\fR Structured query: state .TP \fB\-\-country\fR \fI\,COUNTRY\/\fR Structured query: country .TP \fB\-\-postalcode\fR \fI\,POSTALCODE\/\fR Structured query: postcode .SH OUTPUT FORMATTING \fI\,'nominatim search'\/\fR .TP \fB\-\-format\fR \fI\,FORMAT\/\fR Format of result (use \-\-list\-format to see supported formats) .TP \fB\-\-addressdetails\fR Include a breakdown of the address into elements .TP \fB\-\-extratags\fR Include additional information if available (e.g. wikipedia link, opening hours) .TP \fB\-\-entrances\fR Include a list of tagged entrance nodes .TP \fB\-\-namedetails\fR Include a list of alternative names .TP \fB\-\-lang\fR \fI\,LANGS\/\fR, \fB\-\-accept\-language\fR \fI\,LANGS\/\fR Preferred language order for presenting search results .TP \fB\-\-polygon\-output\fR \fI\,{geojson,kml,svg,text}\/\fR Output geometry of results as a GeoJSON, KML, SVG or WKT .TP \fB\-\-polygon\-threshold\fR \fI\,TOLERANCE\/\fR Simplify output geometry.Parameter is difference tolerance in degrees. .SH RESULT LIMITATION \fI\,'nominatim search'\/\fR .TP \fB\-\-countrycodes\fR \fI\,CC,..\/\fR Limit search results to one or more countries .TP \fB\-\-exclude_place_ids\fR \fI\,ID,..\/\fR List of search object to be excluded .TP \fB\-\-limit\fR \fI\,LIMIT\/\fR Limit the number of returned results .TP \fB\-\-viewbox\fR \fI\,X1,Y1,X2,Y2\/\fR Preferred area to find search results .TP \fB\-\-bounded\fR Strictly restrict results to viewbox area .TP \fB\-\-layer\fR \fI\,LAYER\/\fR Restrict results to one or more layers (may be repeated) .TP \fB\-\-no\-dedupe\fR Do not remove duplicates from the result list .SH OTHER OPTIONS \fI\,'nominatim search'\/\fR .TP \fB\-\-list\-formats\fR List supported output formats and exit. .SH COMMAND \fI\,'nominatim reverse'\/\fR usage: nominatim reverse [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-lat LAT] [\-\-lon LON] [\-\-zoom ZOOM] [\-\-layer LAYER] [\-\-format FORMAT] [\-\-addressdetails] [\-\-extratags] [\-\-entrances] [\-\-namedetails] [\-\-lang LANGS] [\-\-polygon\-output {geojson,kml,svg,text}] [\-\-polygon\-threshold TOLERANCE] [\-\-list\-formats] Execute API reverse query. This command works exactly the same as if calling the /reverse endpoint on the web API. See the online documentation for more details on the various parameters: https://nominatim.org/release\-docs/latest/api/Reverse/ .SH DEFAULT ARGUMENTS \fI\,'nominatim reverse'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH QUERY ARGUMENTS \fI\,'nominatim reverse'\/\fR .TP \fB\-\-lat\fR \fI\,LAT\/\fR Latitude of coordinate to look up (in WGS84) .TP \fB\-\-lon\fR \fI\,LON\/\fR Longitude of coordinate to look up (in WGS84) .TP \fB\-\-zoom\fR \fI\,ZOOM\/\fR Level of detail required for the address .TP \fB\-\-layer\fR \fI\,LAYER\/\fR Restrict results to one or more layers (may be repeated) .SH OUTPUT FORMATTING \fI\,'nominatim reverse'\/\fR .TP \fB\-\-format\fR \fI\,FORMAT\/\fR Format of result (use \-\-list\-format to see supported formats) .TP \fB\-\-addressdetails\fR Include a breakdown of the address into elements .TP \fB\-\-extratags\fR Include additional information if available (e.g. wikipedia link, opening hours) .TP \fB\-\-entrances\fR Include a list of tagged entrance nodes .TP \fB\-\-namedetails\fR Include a list of alternative names .TP \fB\-\-lang\fR \fI\,LANGS\/\fR, \fB\-\-accept\-language\fR \fI\,LANGS\/\fR Preferred language order for presenting search results .TP \fB\-\-polygon\-output\fR \fI\,{geojson,kml,svg,text}\/\fR Output geometry of results as a GeoJSON, KML, SVG or WKT .TP \fB\-\-polygon\-threshold\fR \fI\,TOLERANCE\/\fR Simplify output geometry.Parameter is difference tolerance in degrees. .SH OTHER OPTIONS \fI\,'nominatim reverse'\/\fR .TP \fB\-\-list\-formats\fR List supported output formats and exit. .SH COMMAND \fI\,'nominatim lookup'\/\fR usage: nominatim lookup [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-id OSMID] [\-\-format FORMAT] [\-\-addressdetails] [\-\-extratags] [\-\-entrances] [\-\-namedetails] [\-\-lang LANGS] [\-\-polygon\-output {geojson,kml,svg,text}] [\-\-polygon\-threshold TOLERANCE] [\-\-list\-formats] Execute API lookup query. This command works exactly the same as if calling the /lookup endpoint on the web API. See the online documentation for more details on the various parameters: https://nominatim.org/release\-docs/latest/api/Lookup/ .SH DEFAULT ARGUMENTS \fI\,'nominatim lookup'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH QUERY ARGUMENTS \fI\,'nominatim lookup'\/\fR .TP \fB\-\-id\fR \fI\,OSMID\/\fR OSM id to lookup in format (may be repeated) .SH OUTPUT FORMATTING \fI\,'nominatim lookup'\/\fR .TP \fB\-\-format\fR \fI\,FORMAT\/\fR Format of result (use \-\-list\-format to see supported formats) .TP \fB\-\-addressdetails\fR Include a breakdown of the address into elements .TP \fB\-\-extratags\fR Include additional information if available (e.g. wikipedia link, opening hours) .TP \fB\-\-entrances\fR Include a list of tagged entrance nodes .TP \fB\-\-namedetails\fR Include a list of alternative names .TP \fB\-\-lang\fR \fI\,LANGS\/\fR, \fB\-\-accept\-language\fR \fI\,LANGS\/\fR Preferred language order for presenting search results .TP \fB\-\-polygon\-output\fR \fI\,{geojson,kml,svg,text}\/\fR Output geometry of results as a GeoJSON, KML, SVG or WKT .TP \fB\-\-polygon\-threshold\fR \fI\,TOLERANCE\/\fR Simplify output geometry.Parameter is difference tolerance in degrees. .SH OTHER OPTIONS \fI\,'nominatim lookup'\/\fR .TP \fB\-\-list\-formats\fR List supported output formats and exit. .SH COMMAND \fI\,'nominatim details'\/\fR usage: nominatim details [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-node NODE] [\-\-way WAY] [\-\-relation RELATION] [\-\-place_id PLACE_ID] [\-\-class OBJECT_CLASS] [\-\-format FORMAT] [\-\-addressdetails] [\-\-keywords] [\-\-linkedplaces] [\-\-entrances] [\-\-hierarchy] [\-\-group_hierarchy] [\-\-polygon_geojson] [\-\-lang LANGS] [\-\-list\-formats] Execute API details query. This command works exactly the same as if calling the /details endpoint on the web API. See the online documentation for more details on the various parameters: https://nominatim.org/release\-docs/latest/api/Details/ .SH DEFAULT ARGUMENTS \fI\,'nominatim details'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH QUERY ARGUMENTS \fI\,'nominatim details'\/\fR .TP \fB\-\-node\fR \fI\,NODE\/\fR, \fB\-n\fR \fI\,NODE\/\fR Look up the OSM node with the given ID. .TP \fB\-\-way\fR \fI\,WAY\/\fR, \fB\-w\fR \fI\,WAY\/\fR Look up the OSM way with the given ID. .TP \fB\-\-relation\fR \fI\,RELATION\/\fR, \fB\-r\fR \fI\,RELATION\/\fR Look up the OSM relation with the given ID. .TP \fB\-\-place_id\fR \fI\,PLACE_ID\/\fR, \fB\-p\fR \fI\,PLACE_ID\/\fR Database internal identifier of the OSM object to look up .TP \fB\-\-class\fR \fI\,OBJECT_CLASS\/\fR Class type to disambiguated multiple entries of the same object. .SH OUTPUT ARGUMENTS \fI\,'nominatim details'\/\fR .TP \fB\-\-format\fR \fI\,FORMAT\/\fR Format of result (use \-\-list\-formats to see supported formats) .TP \fB\-\-addressdetails\fR Include a breakdown of the address into elements .TP \fB\-\-keywords\fR Include a list of name keywords and address keywords .TP \fB\-\-linkedplaces\fR Include a details of places that are linked with this one .TP \fB\-\-entrances\fR Include a list of tagged entrance nodes .TP \fB\-\-hierarchy\fR Include details of places lower in the address hierarchy .TP \fB\-\-group_hierarchy\fR Group the places by type .TP \fB\-\-polygon_geojson\fR Include geometry of result .TP \fB\-\-lang\fR \fI\,LANGS\/\fR, \fB\-\-accept\-language\fR \fI\,LANGS\/\fR Preferred language order for presenting search results .SH OTHER OPTIONS \fI\,'nominatim details'\/\fR .TP \fB\-\-list\-formats\fR List supported output formats and exit. .SH COMMAND \fI\,'nominatim status'\/\fR usage: nominatim status [\-h] [\-q] [\-v] [\-\-project\-dir DIR] [\-j NUM] [\-\-format FORMAT] [\-\-list\-formats] Execute API status query. This command works exactly the same as if calling the /status endpoint on the web API. See the online documentation for more details on the various parameters: https://nominatim.org/release\-docs/latest/api/Status/ .SH DEFAULT ARGUMENTS \fI\,'nominatim status'\/\fR .TP \fB\-q\fR, \fB\-\-quiet\fR Print only error messages .TP \fB\-v\fR, \fB\-\-verbose\fR Increase verboseness of output .TP \fB\-\-project\-dir\fR \fI\,DIR\/\fR Base directory of the Nominatim installation (default: /var/lib/nominatim/) .TP \fB\-j\fR \fI\,NUM\/\fR, \fB\-\-threads\fR \fI\,NUM\/\fR Number of parallel threads to use .SH API PARAMETERS \fI\,'nominatim status'\/\fR .TP \fB\-\-format\fR \fI\,FORMAT\/\fR Format of result (use \-\-list\-formats to see supported formats) .SH OTHER OPTIONS \fI\,'nominatim status'\/\fR .TP \fB\-\-list\-formats\fR List supported output formats and exit. .SH AUTHOR .nf the Nominatim developer community .fi .nf info@nominatim.org .fi .SH DISTRIBUTION The latest version of Nominatim may be downloaded from .UR https://nominatim.org .UE