Patreon OpenAPI

This repository contains a preview of the OpenAPI 3.1 specification for Patreons's API. Currently, the spec is only available for the API version v2.

Warning

This repository is not created, maintained or associated in any way with Patreon. Both specifications are made from the public documented API and are subject to breaking changes without notice if Patreon updates the public API.

Usage

Spec Files

Two versions of the spec are included—the standard spec and the preview spec:

• openapi.json is the standard spec that contains the documented, public API.
• openapi_preview.json is the preview spec which contains unstable and/or undocumented API features. This should not be considered stable or used in production environments.

Documentation

To view both the stable and experimental specifications, see the API reference.

To use the Patreon API with a library, go to the documentation of patreon-api.ts.

Contributing

OpenAPI spec contents are automatically generated by the patreon-api.ts library.

For bug fixes or improvements for the OpenAPI spec, you can open an issue.

Known issues

TODO: add known issues

License

MIT