{"id":25626690,"url":"https://github.com/anitrack/patreon-wrapper","last_synced_at":"2025-04-14T12:53:31.881Z","repository":{"id":57097807,"uuid":"469101638","full_name":"AniTrack/patreon-wrapper","owner":"AniTrack","description":"Patreon API is 💀","archived":false,"fork":false,"pushed_at":"2024-04-18T23:32:50.000Z","size":75,"stargazers_count":10,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T10:45:49.393Z","etag":null,"topics":["api-wrapper","discord","patreon","patreon-wrapper"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@anitrack/patreon-wrapper","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/AniTrack.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}},"created_at":"2022-03-12T14:12:23.000Z","updated_at":"2025-01-26T12:08:19.000Z","dependencies_parsed_at":"2024-04-19T00:26:16.014Z","dependency_job_id":"6425d2a6-a31b-417f-9dbd-9a85d5f55922","html_url":"https://github.com/AniTrack/patreon-wrapper","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AniTrack%2Fpatreon-wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AniTrack%2Fpatreon-wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AniTrack%2Fpatreon-wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AniTrack%2Fpatreon-wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AniTrack","download_url":"https://codeload.github.com/AniTrack/patreon-wrapper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248885454,"owners_count":21177625,"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":["api-wrapper","discord","patreon","patreon-wrapper"],"created_at":"2025-02-22T16:58:00.997Z","updated_at":"2025-04-14T12:53:31.845Z","avatar_url":"https://github.com/AniTrack.png","language":"TypeScript","funding_links":["https://www.patreon.com/api/oauth2/v2/user/12345678'","https://www.patreon.com/api/oauth2/v2/user/user_id'"],"categories":[],"sub_categories":[],"readme":"# 🍊 Patreon Wrapper\n\n💎 Universal Patron API v2 wrapper that simplifies their API usage in JavaScript\n\n\u003e This package was previously used on [AniTrack.co](https://anitrack.co) before switching to the payment gateway\n\n# Table of Contents\n\n-   [Install](#Install%20the%20package)\n-   [Getting Started](#Getting%20Started)\n-   [Sandbox for development](#Patreon%20Sandbox)\n-   [License](#license)\n\n\u003cbr /\u003e\n\n# Install the package\n\n```\n$ npm install @anitrack/patreon-wrapper\n```\n\n\u003cbr /\u003e\n\n# Getting Started\n\n```js\nimport { Patreon } from '@anitrack/patreon-wrapper';\n```\n\n\u003cbr /\u003e\n\n# API Authorization\n\n\u003e Where do I find Campaign ID? F12 your Patreon page and search for \"campaign\" then keep looking until you finds URL with campaign params that contains around 7 degits. That should be your Campaign ID\n\n```js\nPatreon.Authorization({\n    AccessToken: 'YOUR_API_V2_ACCESS_TOKEN',\n    CampaignID: 'YOUR_CAPAIGN_ID',\n});\n```\n\n\u003cbr /\u003e\n\n# Package Usage\n\n## Fetching every Patrons from the Campaign\n\n```js\nconst Patrons = await Patreon.FetchPatrons([\n    'active_patron',\n    'declined_patron',\n    'former_patron',\n]);\n\nconsole.log(Patrons);\n```\n\n## Patron object example\n\nconsole.log(Patrons) from above\n\n```js\n [\n    {\n      displayId: '12345678',\n      displayName: 'Username',\n      emailAddress: 'email@address.com',\n      isFollower: false,\n      subscription: {\n        note: '',\n        currentEntitled: {\n          status: 'active_patron',\n          tier: {\n            id: '12345678',\n            title: 'My First Tier'\n          },\n          cents: 500,\n          willPayCents: 500,\n          lifetimeCents: 1500,\n          firstCharge: '2022-01-15 15:00:00.000',\n          nextCharge: '2022-05-15 15:00:00.000',\n          lastCharge: '2022-05-15 15:00:00.000'\n        }\n      },\n      mediaConnection: {\n        patreon: {\n          id: '12345678',\n          url: 'https://www.patreon.com/api/oauth2/v2/user/12345678'\n        },\n        discord: {\n          id: '12345678',\n          url: 'https://discordapp.com/users/12345678'\n        }\n      }\n    },\n    ...\n]\n```\n\n\u003cbr /\u003e\n\n# Patreon Sandbox\n\n\u003e This is great for development and working with sandbox patrons users. The sandbox patrons object will be exactly the same as real ones!\n\n## Adding Custom Patrons to the Sandbox\n\nYou can add as much sandbox patrons as you want\n\n```js\nimport { Sandbox } from '@anitrack/patreon-wrapper';\n\nSandbox.AddPatron({\n    displayId: '123', // Patreon ID\n    displayName: '123', // Patreon Username\n    emailAddress: 'email@address.com', // Patreon Email\n    tier: { id: '123', title: 'Tier 1' }, // Current Tier\n    cents: 500, // Current paying in cent 500 -\u003e $5.00\n    willPayCents: 500, // Next pay price\n    lifetimeCents: 1500, // Total lifetime spent\n    firstCharge: '2022-01-15 15:00:00.000', // ISO 8601 String date format\n    nextCharge: '2022-05-15 15:00:00.000',\n    lastCharge: '2022-04-15 15:00:00.000',\n    patronStatus: 'active_patron',\n    mediaConnection: {\n        patreon: {\n            id: '123',\n            url: 'https://www.patreon.com/api/oauth2/v2/user/user_id',\n        },\n        discord: { id: '123', url: 'https://discord.com/users/user_id' },\n    },\n});\n\nconst Patrons = Sandbox.GetPatrons();\n\nconsole.log(Patrons);\n```\n\n## Get both Sandbox Patrons and Real Patrons\n\nset second boolean argument \"showSandboxPatrons\" to true\n\n```js\nconst Patrons = await Patreon.FetchPatrons(\n    ['active_patron', 'declined_patron', 'former_patron'],\n    true\n);\n\nconsole.log(Patrons);\n```\n\n\u003cbr /\u003e\n\n# License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanitrack%2Fpatreon-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanitrack%2Fpatreon-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanitrack%2Fpatreon-wrapper/lists"}