{"id":32163966,"url":"https://github.com/tomasz-tomczyk/igdb","last_synced_at":"2026-02-20T16:01:22.934Z","repository":{"id":57506347,"uuid":"118519999","full_name":"tomasz-tomczyk/igdb","owner":"tomasz-tomczyk","description":"Elixir wrapper for the Internet Game Database API. https://www.igdb.com/","archived":false,"fork":false,"pushed_at":"2020-05-08T09:31:04.000Z","size":66,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-21T14:49:25.322Z","etag":null,"topics":["api","elixir","igdb"],"latest_commit_sha":null,"homepage":null,"language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tomasz-tomczyk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-22T21:51:15.000Z","updated_at":"2020-05-08T09:31:07.000Z","dependencies_parsed_at":"2022-08-29T20:00:55.550Z","dependency_job_id":null,"html_url":"https://github.com/tomasz-tomczyk/igdb","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tomasz-tomczyk/igdb","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomasz-tomczyk%2Figdb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomasz-tomczyk%2Figdb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomasz-tomczyk%2Figdb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomasz-tomczyk%2Figdb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tomasz-tomczyk","download_url":"https://codeload.github.com/tomasz-tomczyk/igdb/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomasz-tomczyk%2Figdb/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29656589,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-20T09:27:29.698Z","status":"ssl_error","status_checked_at":"2026-02-20T09:26:12.373Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","elixir","igdb"],"created_at":"2025-10-21T14:41:21.185Z","updated_at":"2026-02-20T16:01:22.923Z","avatar_url":"https://github.com/tomasz-tomczyk.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IGDB\n[![Actions Status](https://github.com/tomasz-tomczyk/igdb/workflows/Build/badge.svg)](https://github.com/tomasz-tomczyk/igdb/actions)\n[![Docs](https://img.shields.io/badge/docs-hex.pm-brightgreen)](https://hexdocs.pm/igdb/Igdb.html)\n\n## Installation\n\nThe package can be installed by adding `igdb` to your list of dependencies in\n`mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:igdb, \"~\u003e 1.0.1\"}\n  ]\nend\n```\n\nDocumentation can be found at [https://hexdocs.pm/igdb](https://hexdocs.pm/igdb).\n\n## Configuration\n\nYou will need to set the following configuration variables in your\n`config/config.exs` file:\n\n```elixir\nuse Mix.Config\n\nconfig :igdb, api_key:  \"IGDB_API_KEY\",\n              api_root: \"IGDB_API_ROOT\"\n```\n\nFor security, I recommend that you use environment variables rather than hard\ncoding your account credentials. If you don't already have an environment\nvariable manager, you can create a `.env` file in your project with the\nfollowing content:\n\n```bash\nexport IGDB_API_KEY=\"\u003cproduction key here\u003e\"\nexport IGDB_API_ROOT=\"https://api-v3.igdb.com\"\n```\n\nThen, just be sure to run `source .env` in your shell before compiling your\nproject.\n\n## Usage\n\n### Search\n\nReturns a list of resources found from given search options.\n\nIf the resources could not be loaded, `search/1` will return a 3-element tuple\nin this format, `{:error, message, code}`. The `code` is the HTTP status code\nreturned by the IGDB API, for example, 404.\n\n#### Options\n\nThe options should be passed as a keyword list. Below is a list of allowed keys:\n\n| Option   | Values                                                                     | Example                                              |\n|----------|----------------------------------------------------------------------------|------------------------------------------------------|\n| `fields` | atom, string or list of those; can be nested with periods                  | `\"*\", [\"*\", \"game.*]`                                |\n| `sort`   | string; column with the direction (asc/desc); cannot be used with `search` | `\"created_at desc\"`                                  |\n| `limit`  | integer                                                                    | `10`                                                 |\n| `search` | string; text you want to search for; cannot be used with `sort`            | `\"Final Fantasy\"`                                    |\n| `where`  | list of strings, will be joined with AND - you may construct your own      | `[\"platforms = 48\", \"date \u003e 1538129354\"]`            |\n| `exclude`| string; exclude irrelevant data from your query                            | `\"tags\"`                                             |\n\nRefer to individual resources for the available columns to filter on.\n\n#### Examples\n\n```\niex\u003e Igdb.Game.search(search: \"Final Fantasy\", limit: 5, where: [\"platforms = 48\"], fields: \"name\")\n{:ok,\n[\n  %{id: 37087, name: \"Monster of the Deep: Final Fantasy XV\"},\n  %{id: 11169, name: \"Final Fantasy VII Remake\"},\n  %{id: 36831, name: \"Dissidia Final Fantasy NT\"},\n  %{id: 38492, name: \"Final Fantasy XV Deluxe Edition\"},\n  %{id: 26069, name: \"FINAL FANTASY XV - Season Pass Upgrade\"}\n]}\n```\n\n## Testing\n\nUnit tests:\n\n```\nmix test\n```\n\nThere is an external test, not run by default, that hits the API for each\nresource endpoint. To enable, it, first ensure you have the API configured in\nthe ENV:\n\n```\nexport IGDB_TEST_API_KEY=\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\nexport IGDB_TEST_API_ROOT=\"https://api-v3.igdb.com\"\n```\n\nAnd run:\n\n```\nmix test --include external\n```\n\n## Credits\n\nA lot of inspiration taken from [ex_twilio](https://github.com/danielberkompas/ex_twilio). Thank you!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomasz-tomczyk%2Figdb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomasz-tomczyk%2Figdb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomasz-tomczyk%2Figdb/lists"}