LookupRequest class

A model class representing a request to the Nominatim Lookup API.

This class is used to encapsulate the parameters required for making a lookup request, which involves querying the Nominatim database for specific OSM objects by their IDs.

The LookupRequest class includes options to specify whether to include detailed address information, extra tags, name details, and the geometry of the object in the response.

Example usage:

LookupRequest request = LookupRequest(
  osmIds: 'N123,W456,R789',
  addressDetails: true,
  extraTags: true,
  nameDetails: true,
  polygonGeojson: true,
);

Properties:

  • osmIds: A comma-separated list of OSM object IDs to lookup. Each ID should be prefixed with the type of the object (N for node, W for way, R for relation). This is a required parameter.
  • addressDetails: Specifies whether to include detailed address information in the response. Defaults to false.
  • extraTags: Specifies whether to include extra tags like Wikipedia link, opening hours, etc. Defaults to true.
  • nameDetails: Specifies whether to include a list of alternative names in the results. Defaults to true.
  • polygonGeojson: Specifies whether to include the geometry of the object in GeoJSON format. Defaults to true.

Constructor:

Constructors

LookupRequest({required String osmIds, bool? addressDetails, bool? extraTags = true, bool? nameDetails = true, bool? polygonGeojson = true})
Constructor for creating a LookupRequest.

Properties

addressDetails → bool?
Specifies whether to include detailed address information in the response.
final
extraTags → bool?
Specifies whether to include extra tags like Wikipedia link, opening hours, etc.
final
hashCode → int
The hash code for this object.
no setterinherited
nameDetails → bool?
Specifies whether to include a list of alternative names in the results.
final
osmIds → String
A comma-separated list of OSM object IDs to lookup. Each ID should be prefixed with the type of the object (N for node, W for way, R for relation).
final
polygonGeojson → bool?
Specifies whether to include the geometry of the object in GeoJSON format.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited