Kagi.MapsResult (kagi_ex v0.1.0)

A single Kagi Maps point-of-interest result.

Returned in Kagi.Maps.results. Most fields are optional because Kagi Maps providers return different metadata.

Fields

:name - place name.
:address - street address.
:coordinates - Kagi.MapsResult.Coordinates with latitude/longitude.
:phone - phone number in international format.
:url - website URL.
:source - upstream provider name.
:id - Kagi or upstream provider identifier.
:rating - average rating.
:review_count - number of reviews backing :rating.
:price - price tier string such as "$" or "$$".
:distance - distance from :ll, when supplied.
:hours_now - open/closed indicator string.
:types - category tags.
:links - provider-specific links payload.
:images - image references payload.

Summary

Types

t()

A single Maps point of interest.

Types

t()

@type t() :: %Kagi.MapsResult{
  address: String.t() | nil,
  coordinates: Kagi.MapsResult.Coordinates.t(),
  distance: float() | nil,
  hours_now: String.t() | nil,
  id: String.t() | nil,
  images: term() | nil,
  links: term() | nil,
  name: String.t(),
  phone: String.t() | nil,
  price: String.t() | nil,
  rating: float() | nil,
  review_count: non_neg_integer() | nil,
  source: String.t() | nil,
  types: [String.t()] | nil,
  url: String.t() | nil
}

A single Maps point of interest.