# `Kagi.Maps`
[🔗](https://github.com/rubas/kagi_ex/blob/v0.1.0/lib/kagi/maps.ex#L1)

Maps response returned by `Kagi.maps/1..3`.

Contains parsed point-of-interest rows. Sorting and limiting are applied
client-side after the response is parsed.

## Fields

  * `:results` - point-of-interest rows in result order.

# `order`

```elixir
@type order() :: :asc | :desc
```

Sort direction passed via the `:order` option.

# `sort`

```elixir
@type sort() :: :relevance | :rating | :distance | :price
```

Maps sort mode passed via the `:sort` option.

# `t`

```elixir
@type t() :: %Kagi.Maps{results: [Kagi.MapsResult.t()]}
```

A parsed Kagi Maps response.

---

*Consult [api-reference.md](api-reference.md) for complete listing*