IGDB

Installation

If available in Hex, the package can be installed by adding igdb to your list of dependencies in mix.exs:

def deps do
  [
    {:igdb, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/igdb.

Configuration

You will need to set the following configuration variables in your config/config.exs file:

use Mix.Config

config :igdb, api_key:  "IGDB_API_KEY",
              api_root: "IGDB_API_ROOT"

For security, I recommend that you use environment variables rather than hard coding your account credentials. If you don't already have an environment variable manager, you can create a .env file in your project with the following content:

export IGDB_API_KEY="<production key here>"
export IGDB_API_ROOT="https://api-XXXXXXXXXX.apicast.io"

Then, just be sure to run source .env in your shell before compiling your project.

Usage

For most resources, you can get it by ID and get an individual object back or search using filters.

Get

If the resource was found, get/2 will return a two-element tuple in this format, {:ok, item}.

Igdb.Game.get(359)
{:ok, %Igdb.Game{ ... }}

If the resource could not be found, get/2 will return a 2-element tuple in this format, {:ok, nil}. The code is the HTTP status code returned by the IGDB API, for example, 404.

Igdb.Game.get(100000000)
{:ok, nil}

If the resource could not be loaded, get/2 will return a 3-element tuple in this format, {:error, message, code}. The code is the HTTP status code returned by the IGDB API, for example, 404.

Search

Returns a list of resources found from given search options.

Options

The options should be passed as a map. Below is a list of allowed keys:

Refer to individual resources for the available columns to filter on.

Examples

Igdb.Game.search(%{search: "Final Fantasy", order: "popularity:desc", limit: 5, filter: %{platforms: %{eq: 48}}, fields: "*"})

Credits

A lot of inspiration taken from ex_twilio. Thank you!