# `AppBlockList`
[🔗](https://github.com/explainableaixai/appblocklist-elixir/blob/v1.0.0/lib/appblocklist.ex#L1)

Elixir client for the AppBlockList App Lookup API (https://www.appblocklist.com).

    {:ok, app} = AppBlockList.lookup("com.zhiliaoapp.musically")
    app.filtering_categories
    #=> ["Social Networking", "Streaming Media"]

See `AppBlockList.Client` for options, `AppBlockList.Queue` for a
supervised, rate-limited lookup process, `AppBlockList.App` for the result
struct and `AppBlockList.Error` for error reasons.

# `lookup`

```elixir
@spec lookup(String.t(), keyword()) ::
  {:ok, AppBlockList.App.t()} | {:error, AppBlockList.Error.t()}
```

Looks up one app with a client built from `opts` (or the environment).
Returns `{:ok, %AppBlockList.App{}}` or `{:error, %AppBlockList.Error{}}`.

# `lookup!`

```elixir
@spec lookup!(String.t(), keyword()) :: AppBlockList.App.t()
```

Like `lookup/2` but returns the app or raises.

# `version`

```elixir
@spec version() :: String.t()
```

Library version.

---

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