docs/library/Input-Parameter-Types.md

   1 # Input Parameter Types
   2
   3 This page describes in more detail some of the input parameter types used
   4 in the query functions of the API object.
   5
   6 ## Place identification
   7
   8 The [details](NominatimAPI.md#nominatim.api.core.NominatimAPI.details) and
   9 [lookup](NominatimAPI.md#nominatim.api.core.NominatimAPI.lookup) functions
  10 require references to places in the database. Below are listed the possible
  11 types for place identification. All types are dataclasses.
  12
  13 ### PlaceID
  14
  15 ::: nominatim.api.PlaceID
  16     options:
  17         heading_level: 6
  18
  19 ### OsmID
  20
  21 ::: nominatim.api.OsmID
  22     options:
  23         heading_level: 6
  24
  25 ## Geometry types
  26
  27 ::: nominatim.api.GeometryFormat
  28     options:
  29         heading_level: 6
  30         members_order: source
  31
  32 ## Geometry input
  33
  34 ### Point
  35
  36 ::: nominatim.api.Point
  37     options:
  38         heading_level: 6
  39         show_signature_annotations: True
  40
  41 ### Bbox
  42
  43 ::: nominatim.api.Bbox
  44     options:
  45         heading_level: 6
  46         show_signature_annotations: True
  47         members_order: source
  48         group_by_category: False
  49
  50 ## Layers
  51
  52 Layers allow to restrict the search result to thematic groups. This is
  53 orthogonal to restriction by address ranks, which groups places by their
  54 geographic extent.
  55
  56
  57 ::: nominatim.api.DataLayer
  58     options:
  59         heading_level: 6
  60         members_order: source
  61
  62