Introduction
Typescript Oauth library for the V2 Patreon API with:
- Support for Creator access tokens and Oauth tokens
- Client with methods for calling every endpoint, both resource and webhook endpoints
- Methods to create a webhook server
- Typescript types that strongly reflect your query for raw or normalized responses
ts
const query = buildQuery.campaign([])({ campaign: ['title']})
const payload = await client.fetchCampaign(query)
// ^? { data: { attributes: { title: string } }, ... }
const campaign = await client.normalized.fetchCampaign(query)
// ^? { title: string, id: string, type: Type.Campaign }
Comparison
See why I made this library with all* JavaScript and TypeScript repositories for the Patreon API compared (scroll to see all features):
Repository | API Version | Sandbox | Oauth | Creator token | Webhooks | JSON:API | Normalized | Fetch user | Fetch members | All endpoints |
---|---|---|---|---|---|---|---|---|---|---|
patreon-api.ts | 2 | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
patreon-jsOfficial | 1 | No | Yes | Yes | No | No | No | Yes | Yes | No |
patreon-discord | 2 | No | No | Yes | No | No | Yes | No | Yes | No |
patreon-wrapper | 2 | Yes | No | Yes | No | No | Yes | No | Yes | No |
skyhook | 2 | No | No | Yes | Yes | No | No | No | No | No |
passport-patreon | 1 | No | Yes | No | No | No | Yes | Yes | No | No |
patreon-webhooks | 2 | No | No | No | Yes | No | Yes | No | No | No |
Repository requirements
A library is included if it:
- has at least 1 GitHub star
- is written in TypeScript or JavaScript
- is a repo:
- not for scraping, only related to badges, downloading assets or a Patreon clone
- exports code or is published on NPM
- is not archived
Contributions
If a library has been updated or a new library has met the requirements above, issues or a pull request are accepted to update this table.