]> git.openstreetmap.org Git - nominatim.git/blob - docs/library/NominatimAPI.md
restructure library documentation
[nominatim.git] / docs / library / NominatimAPI.md
1 # The Nominatim API classes
2
3 The API classes are the core object of the search library. Always instantiate
4 one of these classes first. The API classes are **not threadsafe**. You need
5 to instantiate a separate instance for each thread.
6
7 ### NominatimAPI
8
9 ::: nominatim.api.NominatimAPI
10     options:
11         members:
12             - __init__
13             - config
14             - close
15             - status
16             - details
17             - lookup
18             - reverse
19             - search
20             - search_address
21             - search_category
22         heading_level: 6
23         group_by_category: False
24         show_signature_annotations: True
25
26
27 ### NominatimAPIAsync
28
29 ::: nominatim.api.NominatimAPIAsync
30     options:
31         members:
32             - __init__
33             - setup_database
34             - close
35             - begin
36         heading_level: 6
37         group_by_category: False
38         show_signature_annotations: True