Repository files navigation

Typescript oauth library for theV2 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 simplified responses

constquery=QueryBuilder.campaign.setAttributes({campaign:['patron_count']})constpayload=awaitclient.fetchCampaign('campaign_id',query)// ^? { data: { attributes: { patron_count: number }}, ...}constcampaign=awaitclient.simplified.fetchCampaign('campaign_id',query)// ^? { patronCount: number, id: string, type: Type.Campaign }

npm install patreon-api.tspnpm add patreon-api.tsyarn add patreon-api.ts

To read more about how to use this library, go to thedocumentation. Still doubting if this library has everything you need related to the Patreon API?Compare all libraries yourself.

This library is used to create the Patreon OpenAPI schemas for thepatreon-api-spec repository.

• Commonly used routes andcommunity apps
• Example webhook server:Cloudflare worker andexpress.js server
• Example Node.js server:ESM andCJS

Detailed changes are listed for each release inthe changelog.

For upcoming releases, seethe roadmap for planned changes.

See thecode of conduct and thecontributing guide for how to contribute. You can also support the development by writing guides, posts and templates orby funding the maintainers.

Do you have a question about using this library?Open a Q&A discussion on GitHub.

MIT

Copyright (c) 2023-present, ghostrider-05