igdb v0.1.0 Igdb.Company

Represents an Collection resource in the IGDB API.

Examples

Igdb.Company.get(1)
{:ok,
%Igdb.Company{
  change_date: nil,
  change_date_category: 7,
  changed_company_id: 5,
  country: 840,
  created_at: 1297810753000,
  description: "Electronic Arts Inc. is a leading global interactive entertainment software company. EA delivers games, content and online services for Internet-connected consoles, personal computers, mobile phones and tablets.",
  developed: [3632, 3633, 3431, 2656, 5155, 5053, 5530, 5363, 5396, 6211, 6631,
    6798, 1621, 8100, 11235, 11675, 4588, 18705, 8813, 12714, 4587, 19418, 4429,
    4394, 19772, 13838, 51953, 26013, 27075, 12770, 12267, 43280, 5338, 4409,
    48181],
  id: 1,
  logo: %{
    "cloudinary_id" => "i9s3h5sqtvzisfwik1za",
    "height" => 783,
    "url" => "//images.igdb.com/igdb/image/upload/t_thumb/i9s3h5sqtvzisfwik1za.jpg",
    "width" => 783
  },
  name: "Electronic Arts",
  published: [1274, 36, 296, 1268, 1059, 1832, 74, 1314, 1310, 585, 321, 1828,
    2249, 3553, 3852, 336, 240, 349, 335, 76, 1216, 1006, 343, 1306, 3126, 2153,
    3901, 4033, 4042, 3886, 4032, 503, 4041, 4778, 899, 4160, 2250, ...],
  slug: "electronic-arts",
  start_date: 391392000000,
  start_date_category: 0,
  twitter: "https://twitter.com/EA",
  updated_at: 1522571884772,
  url: "https://www.igdb.com/companies/electronic-arts",
  website: "http://www.ea.com/"
}}

Link to this section Summary

Functions

Finds a single resource by id

Returns a list of resources found from given search options

Link to this section Functions

Link to this function get(id, options \\ %{})
get(integer(), map()) :: {:ok, list()} | {:error, String.t()}

Finds a single resource by id.

Examples

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.

Link to this function resource_collection_name()
Link to this function search(options \\ %{})
search(map()) :: {:ok, list()} | {:error, String.t()}

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:

OptionValuesExample
fieldsstring; comma separated, can be nested with periods"id,game.name" "*"
expandstring; comma separated list of nested objects to expand"game"
orderstring; column with the direction (asc/desc)"created_at:desc"
limitinteger10
searchstring; text you want to search for"Final Fantasy"
filternested list; for each column you can have comparison with gt, lt, eq%{date: %{gt: 1500619813000}, platform: %{eq: 48}}

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: "*"})