mirror of
https://github.com/osm-search/Nominatim.git
synced 2026-02-16 15:47:58 +00:00
4cdd2526b6
Updated Getting Started Docs Added documentation for Result Handling removed api documentation
63 lines
2.1 KiB
Markdown
63 lines
2.1 KiB
Markdown
# Result handling
|
|
|
|
The search functions of the Nominatim API always return a result object
|
|
with the raw information about the place that is available in the
|
|
database. This section discusses data types used in the results and utility
|
|
functions that allow further processing of the results.
|
|
|
|
## Result fields
|
|
|
|
### Sources
|
|
|
|
Nominatim takes the result data from multiple sources. The `source_table` field
|
|
in the result describes, from which source the result was retrieved.
|
|
|
|
::: nominatim_api.SourceTable
|
|
options:
|
|
heading_level: 6
|
|
members_order: source
|
|
|
|
### Detailed address description
|
|
|
|
When the `address_details` parameter is set, then functions return not
|
|
only information about the result place but also about the place that
|
|
make up the address. This information is almost always required when you
|
|
want to present the user with a human-readable description of the result.
|
|
See also [Localization](#localization) below.
|
|
|
|
The address details are available in the `address_rows` field as a ordered
|
|
list of `AddressLine` objects with the country information last. The list also
|
|
contains the result place itself and some artificial entries, for example,
|
|
for the house number or the country code. This makes processing and creating
|
|
a full address easier.
|
|
|
|
::: nominatim_api.AddressLine
|
|
options:
|
|
heading_level: 6
|
|
members_order: source
|
|
|
|
### Detailed search terms
|
|
|
|
The `details` function can return detailed information about which search terms
|
|
may be used to find a place, when the `keywords` parameter is set. Search
|
|
terms are split into terms for the name of the place and search terms for
|
|
its address.
|
|
|
|
::: nominatim_api.WordInfo
|
|
options:
|
|
heading_level: 6
|
|
|
|
## Localization
|
|
|
|
Results are always returned with the full list of available names. However, the
|
|
default `locale_name` must be explicitly set using the `localize` function within
|
|
`Locales`. This parses through the full list of available names to find the one
|
|
most preferred by the user. Once this is set, the user can simply use the
|
|
`display_name` field within a `Result` object to retrive the localized name.
|
|
|
|
### Locale
|
|
|
|
::: nominatim_api.Locales
|
|
options:
|
|
heading_level: 6
|