{"id":18916613,"url":"https://github.com/auropick/epic-free-games","last_synced_at":"2025-04-15T09:31:10.362Z","repository":{"id":41424441,"uuid":"356959661","full_name":"AuroPick/epic-free-games","owner":"AuroPick","description":"Wrapper to getting weekly free games with Epic Games API","archived":false,"fork":false,"pushed_at":"2023-10-08T17:28:34.000Z","size":149,"stargazers_count":48,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"prod","last_synced_at":"2024-09-19T14:39:16.990Z","etag":null,"topics":["axios","epic","epic-free-games","epic-games","epicgames","free","free-games","games","javascript","js","node","nodejs","ts","typescript","wrapper"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/epic-free-games","language":"TypeScript","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/AuroPick.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-11T19:24:46.000Z","updated_at":"2024-09-11T13:00:21.000Z","dependencies_parsed_at":"2024-06-18T22:47:37.242Z","dependency_job_id":"285405e4-7c6f-455d-ad44-8e2fe1950bb1","html_url":"https://github.com/AuroPick/epic-free-games","commit_stats":{"total_commits":67,"total_committers":4,"mean_commits":16.75,"dds":0.4328358208955224,"last_synced_commit":"8e4b0641fb2c428a5ba5008e4cbe108e88ca8927"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AuroPick%2Fepic-free-games","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AuroPick%2Fepic-free-games/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AuroPick%2Fepic-free-games/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AuroPick%2Fepic-free-games/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AuroPick","download_url":"https://codeload.github.com/AuroPick/epic-free-games/tar.gz/refs/heads/prod","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223665219,"owners_count":17182264,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["axios","epic","epic-free-games","epic-games","epicgames","free","free-games","games","javascript","js","node","nodejs","ts","typescript","wrapper"],"created_at":"2024-11-08T10:20:09.053Z","updated_at":"2024-11-08T10:20:11.224Z","avatar_url":"https://github.com/AuroPick.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\t\u003ch1\u003eEpic Games Free Games\u003c/h1\u003e\n  \u003ca href=\"https://github.com/AuroPick/epic-free-games/blob/master/LICENSE\"\u003e\u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/AuroPick/epic-free-games\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/epic-free-games\"\u003e\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/epic-free-games\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/epic-free-games\"\u003e\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/dm/epic-free-games\"\u003e\u003c/a\u003e\n  \u003c/br\u003e\n  \u003c/br\u003e\n\t\u003cp\u003e\u003cb\u003eGet Weekly Free Games Of Epic Games\u003c/b\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n## Installation\n\n```js\nnpm i epic-free-games\n\n// OR\n\nyarn add epic-free-games\n```\n\n## Usage\n\n```js\nconst { EpicFreeGames } = require('epic-free-games');\n\n// OR\n\nimport { EpicFreeGames } from 'epic-free-games';\n\nconst epicFreeGames = new EpicFreeGames({ country: 'JP', locale: 'ja', includeAll: true })\n\nepicFreeGames.getGames().then(res =\u003e {\n  // Do something\n}).catch(err =\u003e {\n  // Do something\n});\n\n// you can override default options\nepicFreeGames.getGames({ country: 'DE', locale: 'de', includeAll: false }).then(res =\u003e {\n  // Do something\n}).catch(err =\u003e {\n  // Do something\n});\n\n```\n\n## Function Parameters\n\n| Function    | Parameter             | Parameter Values                                                                               | Default Value  |\n| :---------: | :-------------------: | :--------------------------------------------------------------------------------------------: | :------------: |\n| getGames    | country: `string`     | \"TR\", \"US\", \"GB\", \"DE\", \"AR\", \"ES\", \"MX\", \"FR\", \"IT\", \"JP\", \"KR\", \"PL\", \"BR\", \"RU\", \"TH\", \"CN\", \"IN\", \"GR\" | \"US\"           |\n| getGames    | locale: `string`      | \"tr\", \"ja\", \"ar\", \"de\", \"en-US\", \"es-ES\", \"es-MX\", \"fr\", \"it\", \"ko\", \"pl\", \"pt-BR\", \"ru\", \"th\", \"zh-CN\", \"zh-Hant\" | \"en-US\"           |\n| getGames    | includeAll: `boolean` | true \\| false                                                                                  | false          |\n\n## Sample Output\n\n```js\n{\n  currentGames: [\n    {\n      title: '3 out of 10: Season Two',\n      id: '9fc33e99abf342138323856854e745ec',\n      namespace: 'b829cfd910554ad3ad2eb3b314e2b1ef',\n      description: '3 out of 10: Season Two',\n      effectiveDate: '2021-04-08T15:00:00.000Z',\n      offerType: 'BASE_GAME',\n      expiryDate: null,\n      status: 'ACTIVE',\n      isCodeRedemptionOnly: false,\n      keyImages: [Array],\n      seller: [Object],\n      productSlug: '3-out-of-10-season-2',\n      urlSlug: 'mooncakegeneralaudience',\n      url: null,\n      items: [Array],\n      customAttributes: [Array],\n      categories: [Array],\n      tags: [Array],\n      price: [Object],\n      promotions: [Object]\n    }\n  ],\n  nextGames: [\n    {\n      title: \"Ken Follett's The Pillars of the Earth\",\n      id: 'ded5930173d5495993186871fbfd329a',\n      namespace: 'ce8393adfbf342ceab0a36479ffbc627',\n      description: \"Ken Follett's The Pillars of the Earth\",\n      effectiveDate: '2021-04-15T15:00:00.000Z',\n      offerType: 'BASE_GAME',\n      expiryDate: null,\n      status: 'ACTIVE',\n      isCodeRedemptionOnly: false,\n      keyImages: [Array],\n      seller: [Object],\n      productSlug: 'ken-follets-the-pillars-of-the-earth',\n      urlSlug: 'tiger-general-audience',\n      url: null,\n      items: [Array],\n      customAttributes: [Array],\n      categories: [Array],\n      tags: [Array],\n      price: [Object],\n      promotions: [Object]\n    },\n    {\n      title: 'Deponia: The Complete Journey',\n      id: 'abdae4ebcf3e41beb6ec8040d818afcd',\n      namespace: 'e5decf71f325458b92653616ee98682a',\n      description: 'Deponia: The Complete Journey',\n      effectiveDate: '2021-04-15T15:00:00.000Z',\n      offerType: 'BASE_GAME',\n      expiryDate: null,\n      status: 'ACTIVE',\n      isCodeRedemptionOnly: false,\n      keyImages: [Array],\n      seller: [Object],\n      productSlug: 'deponia-the-complete-journey',\n      urlSlug: 'ghoulgeneralaudience',\n      url: null,\n      items: [Array],\n      customAttributes: [Array],\n      categories: [Array],\n      tags: [Array],\n      price: [Object],\n      promotions: [Object]\n    },\n    {\n      title: 'The First Tree',\n      id: '844f72b164ad4f5884c4feeca5561678',\n      namespace: '489c2ca47aaa4190b694184b979d3b23',\n      description: 'The First Tree',\n      effectiveDate: '2021-04-15T15:00:00.000Z',\n      offerType: 'BASE_GAME',\n      expiryDate: null,\n      status: 'ACTIVE',\n      isCodeRedemptionOnly: false,\n      keyImages: [Array],\n      seller: [Object],\n      productSlug: 'the-first-tree',\n      urlSlug: 'the-first-tree',\n      url: null,\n      items: [Array],\n      customAttributes: [Array],\n      categories: [Array],\n      tags: [Array],\n      price: [Object],\n      promotions: [Object]\n    }\n  ]\n}\n```\n\u003chr/\u003e\n\n\u003e If you have any questions please do not hesitate to contact me.\n\n\u003chr/\u003e\n\n\u003e If you want to support me, you can give a star. That makes me happy.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fauropick%2Fepic-free-games","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fauropick%2Fepic-free-games","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fauropick%2Fepic-free-games/lists"}