man/nominatim.1

   1 .TH nominatim "1" Manual
   2 .SH NAME
   3 nominatim
   4 .SH SYNOPSIS
   5 .B nominatim
   6 [-h] {import,freeze,replication,special-phrases,add-data,index,refresh,admin,export,serve,search,reverse,lookup,details,status} ...
   7 .SH DESCRIPTION
   8     Command\-line tools for importing, updating, administrating and
   9 .br
  10     querying the Nominatim database.
  11 .br
  12
  13 .SH OPTIONS
  14
  15
  16 .SS
  17 \fBSub-commands\fR
  18 .TP
  19 \fBnominatim\fR \fI\,import\/\fR
  20     Create a new Nominatim database from an OSM file.
  21 .TP
  22 \fBnominatim\fR \fI\,freeze\/\fR
  23     Make database read-only.
  24 .TP
  25 \fBnominatim\fR \fI\,replication\/\fR
  26     Update the database using an online replication service.
  27 .TP
  28 \fBnominatim\fR \fI\,special-phrases\/\fR
  29     Import special phrases.
  30 .TP
  31 \fBnominatim\fR \fI\,add-data\/\fR
  32     Add additional data from a file or an online source.
  33 .TP
  34 \fBnominatim\fR \fI\,index\/\fR
  35     Reindex all new and modified data.
  36 .TP
  37 \fBnominatim\fR \fI\,refresh\/\fR
  38     Recompute auxiliary data used by the indexing process.
  39 .TP
  40 \fBnominatim\fR \fI\,admin\/\fR
  41     Analyse and maintain the database.
  42 .TP
  43 \fBnominatim\fR \fI\,export\/\fR
  44     Export addresses as CSV file from the database.
  45 .TP
  46 \fBnominatim\fR \fI\,serve\/\fR
  47     Start a simple web server for serving the API.
  48 .TP
  49 \fBnominatim\fR \fI\,search\/\fR
  50     Execute a search query.
  51 .TP
  52 \fBnominatim\fR \fI\,reverse\/\fR
  53     Execute API reverse query.
  54 .TP
  55 \fBnominatim\fR \fI\,lookup\/\fR
  56     Execute API lookup query.
  57 .TP
  58 \fBnominatim\fR \fI\,details\/\fR
  59     Execute API details query.
  60 .TP
  61 \fBnominatim\fR \fI\,status\/\fR
  62     Execute API status query.
  63 .SH OPTIONS 'nominatim import'
  64 usage: nominatim import [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
  65                         (--osm-file FILE | --continue {load-data,indexing,db-postprocess})
  66                         [--osm2pgsql-cache SIZE] [--reverse-only]
  67                         [--no-partitions] [--no-updates] [--ignore-errors]
  68                         [--index-noanalyse]
  69
  70     Create a new Nominatim database from an OSM file.
  71 .br
  72
  73 .br
  74     This sub\-command sets up a new Nominatim database from scratch starting
  75 .br
  76     with creating a new database in Postgresql. The user running this command
  77 .br
  78     needs superuser rights on the database.
  79 .br
  80
  81
  82
  83
  84 .TP
  85 \fB\-q\fR, \fB\-\-quiet\fR
  86 Print only error messages
  87
  88 .TP
  89 \fB\-v\fR, \fB\-\-verbose\fR
  90 Increase verboseness of output
  91
  92 .TP
  93 \fB\-\-project\-dir\fR DIR
  94 Base directory of the Nominatim installation (default:.)
  95
  96 .TP
  97 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
  98 Number of parallel threads to use
  99
 100 .TP
 101 \fB\-\-osm\-file\fR FILE
 102 OSM file to be imported (repeat for importing multiple files)
 103
 104 .TP
 105 \fB\-\-continue\fR {load\-data,indexing,db\-postprocess}
 106 Continue an import that was interrupted
 107
 108 .TP
 109 \fB\-\-osm2pgsql\-cache\fR SIZE
 110 Size of cache to be used by osm2pgsql (in MB)
 111
 112 .TP
 113 \fB\-\-reverse\-only\fR
 114 Do not create tables and indexes for searching
 115
 116 .TP
 117 \fB\-\-no\-partitions\fR
 118 Do not partition search indices (speeds up import of single country extracts)
 119
 120 .TP
 121 \fB\-\-no\-updates\fR
 122 Do not keep tables that are only needed for updating the database later
 123
 124 .TP
 125 \fB\-\-ignore\-errors\fR
 126 Continue import even when errors in SQL are present
 127
 128 .TP
 129 \fB\-\-index\-noanalyse\fR
 130 Do not perform analyse operations during index (expert only)
 131
 132 .SH OPTIONS 'nominatim freeze'
 133 usage: nominatim freeze [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
 134
 135     Make database read\-only.
 136 .br
 137
 138 .br
 139     About half of data in the Nominatim database is kept only to be able to
 140 .br
 141     keep the data up\-to\-date with new changes made in OpenStreetMap. This
 142 .br
 143     command drops all this data and only keeps the part needed for geocoding
 144 .br
 145     itself.
 146 .br
 147
 148 .br
 149     This command has the same effect as the `\-\-no\-updates` option for imports.
 150 .br
 151
 152
 153
 154
 155 .TP
 156 \fB\-q\fR, \fB\-\-quiet\fR
 157 Print only error messages
 158
 159 .TP
 160 \fB\-v\fR, \fB\-\-verbose\fR
 161 Increase verboseness of output
 162
 163 .TP
 164 \fB\-\-project\-dir\fR DIR
 165 Base directory of the Nominatim installation (default:.)
 166
 167 .TP
 168 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
 169 Number of parallel threads to use
 170
 171 .SH OPTIONS 'nominatim replication'
 172 usage: nominatim replication [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
 173                              [--init] [--no-update-functions]
 174                              [--check-for-updates] [--once] [--no-index]
 175                              [--osm2pgsql-cache SIZE]
 176                              [--socket-timeout SOCKET_TIMEOUT]
 177
 178     Update the database using an online replication service.
 179 .br
 180
 181 .br
 182     An OSM replication service is an online service that provides regular
 183 .br
 184     updates (OSM diff files) for the planet or update they provide. The OSMF
 185 .br
 186     provides the primary replication service for the full planet at
 187 .br
 188     https://planet.osm.org/replication/ but there are other providers of
 189 .br
 190     extracts of OSM data who provide such a service as well.
 191 .br
 192
 193 .br
 194     This sub\-command allows to set up such a replication service and download
 195 .br
 196     and import updates at regular intervals. You need to call '\-\-init' once to
 197 .br
 198     set up the process or whenever you change the replication configuration
 199 .br
 200     parameters. Without any arguments, the sub\-command will go into a loop and
 201 .br
 202     continuously apply updates as they become available. Giving `\-\-once` just
 203 .br
 204     downloads and imports the next batch of updates.
 205 .br
 206
 207
 208
 209
 210 .TP
 211 \fB\-q\fR, \fB\-\-quiet\fR
 212 Print only error messages
 213
 214 .TP
 215 \fB\-v\fR, \fB\-\-verbose\fR
 216 Increase verboseness of output
 217
 218 .TP
 219 \fB\-\-project\-dir\fR DIR
 220 Base directory of the Nominatim installation (default:.)
 221
 222 .TP
 223 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
 224 Number of parallel threads to use
 225
 226 .TP
 227 \fB\-\-init\fR
 228 Initialise the update process
 229
 230 .TP
 231 \fB\-\-no\-update\-functions\fR
 232 Do not update the trigger function to support differential updates.
 233
 234 .TP
 235 \fB\-\-check\-for\-updates\fR
 236 Check if new updates are available and exit
 237
 238 .TP
 239 \fB\-\-once\fR
 240 Download and apply updates only once. When not set, updates are continuously applied
 241
 242 .TP
 243 \fB\-\-no\-index\fR
 244 Do not index the new data. Only usable together with \-\-once
 245
 246 .TP
 247 \fB\-\-osm2pgsql\-cache\fR SIZE
 248 Size of cache to be used by osm2pgsql (in MB)
 249
 250 .TP
 251 \fB\-\-socket\-timeout\fR \fI\,SOCKET_TIMEOUT\/\fR
 252 Set timeout for file downloads
 253
 254 .SH OPTIONS 'nominatim special-phrases'
 255 usage: nominatim special-phrases [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
 256                                  [--import-from-wiki] [--import-from-csv FILE]
 257                                  [--no-replace]
 258
 259     Import special phrases.
 260 .br
 261
 262 .br
 263     Special phrases are search terms that narrow down the type of object
 264 .br
 265     that should be searched. For example, you might want to search for
 266 .br
 267     'Hotels in Barcelona'. The OSM wiki has a selection of special phrases
 268 .br
 269     in many languages, which can be imported with this command.
 270 .br
 271
 272 .br
 273     You can also provide your own phrases in a CSV file. The file needs to have
 274 .br
 275     the following five columns:
 276 .br
 277      * phrase \- the term expected for searching
 278 .br
 279      * class \- the OSM tag key of the object type
 280 .br
 281      * type \- the OSM tag value of the object type
 282 .br
 283      * operator \- the kind of search to be done (one of: in, near, name, \-)
 284 .br
 285      * plural \- whether the term is a plural or not (Y/N)
 286 .br
 287
 288 .br
 289     An example file can be found in the Nominatim sources at
 290 .br
 291     'test/testdb/full_en_phrases_test.csv'.
 292 .br
 293
 294
 295
 296
 297 .TP
 298 \fB\-q\fR, \fB\-\-quiet\fR
 299 Print only error messages
 300
 301 .TP
 302 \fB\-v\fR, \fB\-\-verbose\fR
 303 Increase verboseness of output
 304
 305 .TP
 306 \fB\-\-project\-dir\fR DIR
 307 Base directory of the Nominatim installation (default:.)
 308
 309 .TP
 310 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
 311 Number of parallel threads to use
 312
 313 .TP
 314 \fB\-\-import\-from\-wiki\fR
 315 Import special phrases from the OSM wiki to the database
 316
 317 .TP
 318 \fB\-\-import\-from\-csv\fR FILE
 319 Import special phrases from a CSV file
 320
 321 .TP
 322 \fB\-\-no\-replace\fR
 323 Keep the old phrases and only add the new ones
 324
 325 .SH OPTIONS 'nominatim add-data'
 326 usage: nominatim add-data [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
 327                           (--file FILE | --diff FILE | --node ID | --way ID | --relation ID | --tiger-data DIR)
 328                           [--use-main-api] [--osm2pgsql-cache SIZE]
 329                           [--socket-timeout SOCKET_TIMEOUT]
 330
 331     Add additional data from a file or an online source.
 332 .br
 333
 334 .br
 335     This command allows to add or update the search data in the database.
 336 .br
 337     The data can come either from an OSM file or single OSM objects can
 338 .br
 339     directly be downloaded from the OSM API. This function only loads the
 340 .br
 341     data into the database. Afterwards it still needs to be integrated
 342 .br
 343     in the search index. Use the `nominatim index` command for that.
 344 .br
 345
 346 .br
 347     The command can also be used to add external non\-OSM data to the
 348 .br
 349     database. At the moment the only supported format is TIGER housenumber
 350 .br
 351     data. See the online documentation at
 352 .br
 353     https://nominatim.org/release\-docs/latest/admin/Import/#installing\-tiger\-housenumber\-data\-for\-the\-us
 354 .br
 355     for more information.
 356 .br
 357
 358
 359
 360
 361 .TP
 362 \fB\-q\fR, \fB\-\-quiet\fR
 363 Print only error messages
 364
 365 .TP
 366 \fB\-v\fR, \fB\-\-verbose\fR
 367 Increase verboseness of output
 368
 369 .TP
 370 \fB\-\-project\-dir\fR DIR
 371 Base directory of the Nominatim installation (default:.)
 372
 373 .TP
 374 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
 375 Number of parallel threads to use
 376
 377 .TP
 378 \fB\-\-file\fR FILE
 379 Import data from an OSM file or diff file
 380
 381 .TP
 382 \fB\-\-diff\fR FILE
 383 Import data from an OSM diff file (deprecated: use \-\-file)
 384
 385 .TP
 386 \fB\-\-node\fR ID
 387 Import a single node from the API
 388
 389 .TP
 390 \fB\-\-way\fR ID
 391 Import a single way from the API
 392
 393 .TP
 394 \fB\-\-relation\fR ID
 395 Import a single relation from the API
 396
 397 .TP
 398 \fB\-\-tiger\-data\fR DIR
 399 Add housenumbers from the US TIGER census database
 400
 401 .TP
 402 \fB\-\-use\-main\-api\fR
 403 Use OSM API instead of Overpass to download objects
 404
 405 .TP
 406 \fB\-\-osm2pgsql\-cache\fR SIZE
 407 Size of cache to be used by osm2pgsql (in MB)
 408
 409 .TP
 410 \fB\-\-socket\-timeout\fR \fI\,SOCKET_TIMEOUT\/\fR
 411 Set timeout for file downloads
 412
 413 .SH OPTIONS 'nominatim index'
 414 usage: nominatim index [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
 415                        [--boundaries-only] [--no-boundaries] [--minrank RANK]
 416                        [--maxrank RANK]
 417
 418     Reindex all new and modified data.
 419 .br
 420
 421 .br
 422     Indexing is the process of computing the address and search terms for
 423 .br
 424     the places in the database. Every time data is added or changed, indexing
 425 .br
 426     needs to be run. Imports and replication updates automatically take care
 427 .br
 428     of indexing. For other cases, this function allows to run indexing manually.
 429 .br
 430
 431
 432
 433
 434 .TP
 435 \fB\-q\fR, \fB\-\-quiet\fR
 436 Print only error messages
 437
 438 .TP
 439 \fB\-v\fR, \fB\-\-verbose\fR
 440 Increase verboseness of output
 441
 442 .TP
 443 \fB\-\-project\-dir\fR DIR
 444 Base directory of the Nominatim installation (default:.)
 445
 446 .TP
 447 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
 448 Number of parallel threads to use
 449
 450 .TP
 451 \fB\-\-boundaries\-only\fR
 452 Index only administrative boundaries.
 453
 454 .TP
 455 \fB\-\-no\-boundaries\fR
 456 Index everything except administrative boundaries.
 457
 458 .TP
 459 \fB\-\-minrank\fR RANK, \fB\-r\fR RANK
 460 Minimum/starting rank
 461
 462 .TP
 463 \fB\-\-maxrank\fR RANK, \fB\-R\fR RANK
 464 Maximum/finishing rank
 465
 466 .SH OPTIONS 'nominatim refresh'
 467 usage: nominatim refresh [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
 468                          [--postcodes] [--word-counts] [--address-levels]
 469                          [--functions] [--wiki-data] [--importance]
 470                          [--website] [--no-diff-updates]
 471                          [--enable-debug-statements]
 472
 473     Recompute auxiliary data used by the indexing process.
 474 .br
 475
 476 .br
 477     This sub\-commands updates various static data and functions in the database.
 478 .br
 479     It usually needs to be run after changing various aspects of the
 480 .br
 481     configuration. The configuration documentation will mention the exact
 482 .br
 483     command to use in such case.
 484 .br
 485
 486 .br
 487     Warning: the 'update' command must not be run in parallel with other update
 488 .br
 489              commands like 'replication' or 'add\-data'.
 490 .br
 491
 492
 493
 494
 495 .TP
 496 \fB\-q\fR, \fB\-\-quiet\fR
 497 Print only error messages
 498
 499 .TP
 500 \fB\-v\fR, \fB\-\-verbose\fR
 501 Increase verboseness of output
 502
 503 .TP
 504 \fB\-\-project\-dir\fR DIR
 505 Base directory of the Nominatim installation (default:.)
 506
 507 .TP
 508 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
 509 Number of parallel threads to use
 510
 511 .TP
 512 \fB\-\-postcodes\fR
 513 Update postcode centroid table
 514
 515 .TP
 516 \fB\-\-word\-counts\fR
 517 Compute frequency of full\-word search terms
 518
 519 .TP
 520 \fB\-\-address\-levels\fR
 521 Reimport address level configuration
 522
 523 .TP
 524 \fB\-\-functions\fR
 525 Update the PL/pgSQL functions in the database
 526
 527 .TP
 528 \fB\-\-wiki\-data\fR
 529 Update Wikipedia/data importance numbers
 530
 531 .TP
 532 \fB\-\-importance\fR
 533 Recompute place importances (expensive!)
 534
 535 .TP
 536 \fB\-\-website\fR
 537 Refresh the directory that serves the scripts for the web API
 538
 539 .TP
 540 \fB\-\-no\-diff\-updates\fR
 541 Do not enable code for propagating updates
 542
 543 .TP
 544 \fB\-\-enable\-debug\-statements\fR
 545 Enable debug warning statements in functions
 546
 547 .SH OPTIONS 'nominatim admin'
 548 usage: nominatim admin [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
 549                        (--warm | --check-database | --migrate | --analyse-indexing)
 550                        [--search-only] [--reverse-only]
 551                        [--osm-id OSM_ID | --place-id PLACE_ID]
 552
 553     Analyse and maintain the database.
 554 .br
 555
 556
 557
 558
 559 .TP
 560 \fB\-q\fR, \fB\-\-quiet\fR
 561 Print only error messages
 562
 563 .TP
 564 \fB\-v\fR, \fB\-\-verbose\fR
 565 Increase verboseness of output
 566
 567 .TP
 568 \fB\-\-project\-dir\fR DIR
 569 Base directory of the Nominatim installation (default:.)
 570
 571 .TP
 572 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
 573 Number of parallel threads to use
 574
 575 .TP
 576 \fB\-\-warm\fR
 577 Warm database caches for search and reverse queries
 578
 579 .TP
 580 \fB\-\-check\-database\fR
 581 Check that the database is complete and operational
 582
 583 .TP
 584 \fB\-\-migrate\fR
 585 Migrate the database to a new software version
 586
 587 .TP
 588 \fB\-\-analyse\-indexing\fR
 589 Print performance analysis of the indexing process
 590
 591 .TP
 592 \fB\-\-search\-only\fR
 593 Only pre\-warm tables for search queries
 594
 595 .TP
 596 \fB\-\-reverse\-only\fR
 597 Only pre\-warm tables for reverse queries
 598
 599 .TP
 600 \fB\-\-osm\-id\fR \fI\,OSM_ID\/\fR
 601 Analyse indexing of the given OSM object
 602
 603 .TP
 604 \fB\-\-place\-id\fR \fI\,PLACE_ID\/\fR
 605 Analyse indexing of the given Nominatim object
 606
 607 .SH OPTIONS 'nominatim export'
 608 usage: nominatim export [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
 609                         [--output-type {continent,country,state,county,city,suburb,street,path}]
 610                         [--output-format OUTPUT_FORMAT]
 611                         [--output-all-postcodes] [--language LANGUAGE]
 612                         [--restrict-to-country COUNTRY_CODE]
 613                         [--restrict-to-osm-node ID] [--restrict-to-osm-way ID]
 614                         [--restrict-to-osm-relation ID]
 615
 616     Export addresses as CSV file from the database.
 617 .br
 618
 619
 620
 621
 622 .TP
 623 \fB\-q\fR, \fB\-\-quiet\fR
 624 Print only error messages
 625
 626 .TP
 627 \fB\-v\fR, \fB\-\-verbose\fR
 628 Increase verboseness of output
 629
 630 .TP
 631 \fB\-\-project\-dir\fR DIR
 632 Base directory of the Nominatim installation (default:.)
 633
 634 .TP
 635 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
 636 Number of parallel threads to use
 637
 638 .TP
 639 \fB\-\-output\-type\fR {continent,country,state,county,city,suburb,street,path}
 640 Type of places to output (default: street)
 641
 642 .TP
 643 \fB\-\-output\-format\fR \fI\,OUTPUT_FORMAT\/\fR
 644 Semicolon\-separated list of address types (see \-\-output\-type). Multiple ranks can be merged into one column by simply using a comma\-separated list.
 645
 646 .TP
 647 \fB\-\-output\-all\-postcodes\fR
 648 List all postcodes for address instead of just the most likely one
 649
 650 .TP
 651 \fB\-\-language\fR \fI\,LANGUAGE\/\fR
 652 Preferred language for output (use local name, if omitted)
 653
 654 .TP
 655 \fB\-\-restrict\-to\-country\fR COUNTRY_CODE
 656 Export only objects within country
 657
 658 .TP
 659 \fB\-\-restrict\-to\-osm\-node\fR ID
 660 Export only children of this OSM node
 661
 662 .TP
 663 \fB\-\-restrict\-to\-osm\-way\fR ID
 664 Export only children of this OSM way
 665
 666 .TP
 667 \fB\-\-restrict\-to\-osm\-relation\fR ID
 668 Export only children of this OSM relation
 669
 670 .SH OPTIONS 'nominatim serve'
 671 usage: nominatim serve [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
 672                        [--server SERVER]
 673
 674     Start a simple web server for serving the API.
 675 .br
 676
 677 .br
 678     This command starts the built\-in PHP webserver to serve the website
 679 .br
 680     from the current project directory. This webserver is only suitable
 681 .br
 682     for testing and development. Do not use it in production setups!
 683 .br
 684
 685 .br
 686     By the default, the webserver can be accessed at: http://127.0.0.1:8088
 687 .br
 688
 689
 690
 691
 692 .TP
 693 \fB\-q\fR, \fB\-\-quiet\fR
 694 Print only error messages
 695
 696 .TP
 697 \fB\-v\fR, \fB\-\-verbose\fR
 698 Increase verboseness of output
 699
 700 .TP
 701 \fB\-\-project\-dir\fR DIR
 702 Base directory of the Nominatim installation (default:.)
 703
 704 .TP
 705 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
 706 Number of parallel threads to use
 707
 708 .TP
 709 \fB\-\-server\fR \fI\,SERVER\/\fR
 710 The address the server will listen to.
 711
 712 .SH OPTIONS 'nominatim search'
 713 usage: nominatim search [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
 714                         [--query QUERY] [--street STREET] [--city CITY]
 715                         [--county COUNTY] [--state STATE] [--country COUNTRY]
 716                         [--postalcode POSTALCODE]
 717                         [--format {xml,json,jsonv2,geojson,geocodejson}]
 718                         [--addressdetails] [--extratags] [--namedetails]
 719                         [--lang LANGS]
 720                         [--polygon-output {geojson,kml,svg,text}]
 721                         [--polygon-threshold TOLERANCE] [--countrycodes CC,..]
 722                         [--exclude_place_ids ID,..] [--limit LIMIT]
 723                         [--viewbox X1,Y1,X2,Y2] [--bounded] [--no-dedupe]
 724
 725     Execute a search query.
 726 .br
 727
 728 .br
 729     This command works exactly the same as if calling the /search endpoint on
 730 .br
 731     the web API. See the online documentation for more details on the
 732 .br
 733     various parameters:
 734 .br
 735     https://nominatim.org/release\-docs/latest/api/Search/
 736 .br
 737
 738
 739
 740
 741 .TP
 742 \fB\-q\fR, \fB\-\-quiet\fR
 743 Print only error messages
 744
 745 .TP
 746 \fB\-v\fR, \fB\-\-verbose\fR
 747 Increase verboseness of output
 748
 749 .TP
 750 \fB\-\-project\-dir\fR DIR
 751 Base directory of the Nominatim installation (default:.)
 752
 753 .TP
 754 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
 755 Number of parallel threads to use
 756
 757 .TP
 758 \fB\-\-query\fR \fI\,QUERY\/\fR
 759 Free\-form query string
 760
 761 .TP
 762 \fB\-\-street\fR \fI\,STREET\/\fR
 763 Structured query: housenumber and street
 764
 765 .TP
 766 \fB\-\-city\fR \fI\,CITY\/\fR
 767 Structured query: city, town or village
 768
 769 .TP
 770 \fB\-\-county\fR \fI\,COUNTY\/\fR
 771 Structured query: county
 772
 773 .TP
 774 \fB\-\-state\fR \fI\,STATE\/\fR
 775 Structured query: state
 776
 777 .TP
 778 \fB\-\-country\fR \fI\,COUNTRY\/\fR
 779 Structured query: country
 780
 781 .TP
 782 \fB\-\-postalcode\fR \fI\,POSTALCODE\/\fR
 783 Structured query: postcode
 784
 785 .TP
 786 \fB\-\-format\fR {xml,json,jsonv2,geojson,geocodejson}
 787 Format of result
 788
 789 .TP
 790 \fB\-\-addressdetails\fR
 791 Include a breakdown of the address into elements
 792
 793 .TP
 794 \fB\-\-extratags\fR
 795 Include additional information if available (e.g. wikipedia link, opening hours)
 796
 797 .TP
 798 \fB\-\-namedetails\fR
 799 Include a list of alternative names
 800
 801 .TP
 802 \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
 803 Preferred language order for presenting search results
 804
 805 .TP
 806 \fB\-\-polygon\-output\fR {geojson,kml,svg,text}
 807 Output geometry of results as a GeoJSON, KML, SVG or WKT
 808
 809 .TP
 810 \fB\-\-polygon\-threshold\fR TOLERANCE
 811 Simplify output geometry.Parameter is difference tolerance in degrees.
 812
 813 .TP
 814 \fB\-\-countrycodes\fR CC,..
 815 Limit search results to one or more countries
 816
 817 .TP
 818 \fB\-\-exclude_place_ids\fR ID,..
 819 List of search object to be excluded
 820
 821 .TP
 822 \fB\-\-limit\fR \fI\,LIMIT\/\fR
 823 Limit the number of returned results
 824
 825 .TP
 826 \fB\-\-viewbox\fR X1,Y1,X2,Y2
 827 Preferred area to find search results
 828
 829 .TP
 830 \fB\-\-bounded\fR
 831 Strictly restrict results to viewbox area
 832
 833 .TP
 834 \fB\-\-no\-dedupe\fR
 835 Do not remove duplicates from the result list
 836
 837 .SH OPTIONS 'nominatim reverse'
 838 usage: nominatim reverse [-h] [-q] [-v] [--project-dir DIR] [-j NUM] --lat LAT
 839                          --lon LON [--zoom ZOOM]
 840                          [--format {xml,json,jsonv2,geojson,geocodejson}]
 841                          [--addressdetails] [--extratags] [--namedetails]
 842                          [--lang LANGS]
 843                          [--polygon-output {geojson,kml,svg,text}]
 844                          [--polygon-threshold TOLERANCE]
 845
 846     Execute API reverse query.
 847 .br
 848
 849 .br
 850     This command works exactly the same as if calling the /reverse endpoint on
 851 .br
 852     the web API. See the online documentation for more details on the
 853 .br
 854     various parameters:
 855 .br
 856     https://nominatim.org/release\-docs/latest/api/Reverse/
 857 .br
 858
 859
 860
 861
 862 .TP
 863 \fB\-q\fR, \fB\-\-quiet\fR
 864 Print only error messages
 865
 866 .TP
 867 \fB\-v\fR, \fB\-\-verbose\fR
 868 Increase verboseness of output
 869
 870 .TP
 871 \fB\-\-project\-dir\fR DIR
 872 Base directory of the Nominatim installation (default:.)
 873
 874 .TP
 875 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
 876 Number of parallel threads to use
 877
 878 .TP
 879 \fB\-\-lat\fR \fI\,LAT\/\fR
 880 Latitude of coordinate to look up (in WGS84)
 881
 882 .TP
 883 \fB\-\-lon\fR \fI\,LON\/\fR
 884 Longitude of coordinate to look up (in WGS84)
 885
 886 .TP
 887 \fB\-\-zoom\fR \fI\,ZOOM\/\fR
 888 Level of detail required for the address
 889
 890 .TP
 891 \fB\-\-format\fR {xml,json,jsonv2,geojson,geocodejson}
 892 Format of result
 893
 894 .TP
 895 \fB\-\-addressdetails\fR
 896 Include a breakdown of the address into elements
 897
 898 .TP
 899 \fB\-\-extratags\fR
 900 Include additional information if available (e.g. wikipedia link, opening hours)
 901
 902 .TP
 903 \fB\-\-namedetails\fR
 904 Include a list of alternative names
 905
 906 .TP
 907 \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
 908 Preferred language order for presenting search results
 909
 910 .TP
 911 \fB\-\-polygon\-output\fR {geojson,kml,svg,text}
 912 Output geometry of results as a GeoJSON, KML, SVG or WKT
 913
 914 .TP
 915 \fB\-\-polygon\-threshold\fR TOLERANCE
 916 Simplify output geometry.Parameter is difference tolerance in degrees.
 917
 918 .SH OPTIONS 'nominatim lookup'
 919 usage: nominatim lookup [-h] [-q] [-v] [--project-dir DIR] [-j NUM] --id OSMID
 920                         [--format {xml,json,jsonv2,geojson,geocodejson}]
 921                         [--addressdetails] [--extratags] [--namedetails]
 922                         [--lang LANGS]
 923                         [--polygon-output {geojson,kml,svg,text}]
 924                         [--polygon-threshold TOLERANCE]
 925
 926     Execute API lookup query.
 927 .br
 928
 929 .br
 930     This command works exactly the same as if calling the /lookup endpoint on
 931 .br
 932     the web API. See the online documentation for more details on the
 933 .br
 934     various parameters:
 935 .br
 936     https://nominatim.org/release\-docs/latest/api/Lookup/
 937 .br
 938
 939
 940
 941
 942 .TP
 943 \fB\-q\fR, \fB\-\-quiet\fR
 944 Print only error messages
 945
 946 .TP
 947 \fB\-v\fR, \fB\-\-verbose\fR
 948 Increase verboseness of output
 949
 950 .TP
 951 \fB\-\-project\-dir\fR DIR
 952 Base directory of the Nominatim installation (default:.)
 953
 954 .TP
 955 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
 956 Number of parallel threads to use
 957
 958 .TP
 959 \fB\-\-id\fR OSMID
 960 OSM id to lookup in format <NRW><id> (may be repeated)
 961
 962 .TP
 963 \fB\-\-format\fR {xml,json,jsonv2,geojson,geocodejson}
 964 Format of result
 965
 966 .TP
 967 \fB\-\-addressdetails\fR
 968 Include a breakdown of the address into elements
 969
 970 .TP
 971 \fB\-\-extratags\fR
 972 Include additional information if available (e.g. wikipedia link, opening hours)
 973
 974 .TP
 975 \fB\-\-namedetails\fR
 976 Include a list of alternative names
 977
 978 .TP
 979 \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
 980 Preferred language order for presenting search results
 981
 982 .TP
 983 \fB\-\-polygon\-output\fR {geojson,kml,svg,text}
 984 Output geometry of results as a GeoJSON, KML, SVG or WKT
 985
 986 .TP
 987 \fB\-\-polygon\-threshold\fR TOLERANCE
 988 Simplify output geometry.Parameter is difference tolerance in degrees.
 989
 990 .SH OPTIONS 'nominatim details'
 991 usage: nominatim details [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
 992                          (--node NODE | --way WAY | --relation RELATION | --place_id PLACE_ID)
 993                          [--class OBJECT_CLASS] [--addressdetails]
 994                          [--keywords] [--linkedplaces] [--hierarchy]
 995                          [--group_hierarchy] [--polygon_geojson]
 996                          [--lang LANGS]
 997
 998     Execute API details query.
 999 .br
1000
1001 .br
1002     This command works exactly the same as if calling the /details endpoint on
1003 .br
1004     the web API. See the online documentation for more details on the
1005 .br
1006     various parameters:
1007 .br
1008     https://nominatim.org/release\-docs/latest/api/Details/
1009 .br
1010
1011
1012
1013
1014 .TP
1015 \fB\-q\fR, \fB\-\-quiet\fR
1016 Print only error messages
1017
1018 .TP
1019 \fB\-v\fR, \fB\-\-verbose\fR
1020 Increase verboseness of output
1021
1022 .TP
1023 \fB\-\-project\-dir\fR DIR
1024 Base directory of the Nominatim installation (default:.)
1025
1026 .TP
1027 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
1028 Number of parallel threads to use
1029
1030 .TP
1031 \fB\-\-node\fR \fI\,NODE\/\fR, \fB\-n\fR \fI\,NODE\/\fR
1032 Look up the OSM node with the given ID.
1033
1034 .TP
1035 \fB\-\-way\fR \fI\,WAY\/\fR, \fB\-w\fR \fI\,WAY\/\fR
1036 Look up the OSM way with the given ID.
1037
1038 .TP
1039 \fB\-\-relation\fR \fI\,RELATION\/\fR, \fB\-r\fR \fI\,RELATION\/\fR
1040 Look up the OSM relation with the given ID.
1041
1042 .TP
1043 \fB\-\-place_id\fR \fI\,PLACE_ID\/\fR, \fB\-p\fR \fI\,PLACE_ID\/\fR
1044 Database internal identifier of the OSM object to look up
1045
1046 .TP
1047 \fB\-\-class\fR \fI\,OBJECT_CLASS\/\fR
1048 Class type to disambiguated multiple entries of the same object.
1049
1050 .TP
1051 \fB\-\-addressdetails\fR
1052 Include a breakdown of the address into elements
1053
1054 .TP
1055 \fB\-\-keywords\fR
1056 Include a list of name keywords and address keywords
1057
1058 .TP
1059 \fB\-\-linkedplaces\fR
1060 Include a details of places that are linked with this one
1061
1062 .TP
1063 \fB\-\-hierarchy\fR
1064 Include details of places lower in the address hierarchy
1065
1066 .TP
1067 \fB\-\-group_hierarchy\fR
1068 Group the places by type
1069
1070 .TP
1071 \fB\-\-polygon_geojson\fR
1072 Include geometry of result
1073
1074 .TP
1075 \fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
1076 Preferred language order for presenting search results
1077
1078 .SH OPTIONS 'nominatim status'
1079 usage: nominatim status [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
1080                         [--format {text,json}]
1081
1082     Execute API status query.
1083 .br
1084
1085 .br
1086     This command works exactly the same as if calling the /status endpoint on
1087 .br
1088     the web API. See the online documentation for more details on the
1089 .br
1090     various parameters:
1091 .br
1092     https://nominatim.org/release\-docs/latest/api/Status/
1093 .br
1094
1095
1096
1097
1098 .TP
1099 \fB\-q\fR, \fB\-\-quiet\fR
1100 Print only error messages
1101
1102 .TP
1103 \fB\-v\fR, \fB\-\-verbose\fR
1104 Increase verboseness of output
1105
1106 .TP
1107 \fB\-\-project\-dir\fR DIR
1108 Base directory of the Nominatim installation (default:.)
1109
1110 .TP
1111 \fB\-j\fR NUM, \fB\-\-threads\fR NUM
1112 Number of parallel threads to use
1113
1114 .TP
1115 \fB\-\-format\fR {text,json}
1116 Format of result
1117
1118 .SH AUTHORS
1119 .B Nominatim
1120 was written by the Nominatim developer community <info@nominatim.org>.
1121 .SH DISTRIBUTION
1122 The latest version of Nominatim may be downloaded from
1123 .UR https://nominatim.org
1124 .UE