How to retrieve linked Patreon sponsorship status via API

[kzu]

Select Topic Area

Question

Body

Now that Patreon can be linked and showcased on github.com, is there an equivalent API that allows to determine if a user is sponsoring via the linked Patron account? In other words, is the GH mechanism for determining that sponsorship available via API queries too?

(see https://docs.github.com/en/sponsors/receiving-sponsorships-through-github-sponsors/enabling-sponsorships-through-patreon)

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬

[nectariferous]

As of now, GitHub doesn't provide a direct API endpoint to retrieve the sponsorship status of a user via a linked Patreon account. The GitHub Sponsors API is primarily focused on sponsorships managed directly through GitHub. Here's what you need to know:

1. Current API Limitations:

   • The GitHub Sponsors API doesn't have a specific endpoint for Patreon-linked sponsorships.
   • The existing /sponsors and /sponsorships endpoints only return information about direct GitHub Sponsors.

2. Possible Workarounds:
   a. Use the GitHub Sponsors API:

   • You can query the user's sponsorship status using the GitHub Sponsors API.
   • This will only show sponsorships made directly through GitHub, not Patreon.
   • Example endpoint: GET /users/{username}/sponsorship

   b. Patreon API:

   • If you have access to the Patreon API on behalf of the creator, you could potentially cross-reference Patreon patrons with GitHub users.
   • This would require additional setup and authorization from the Patreon side.

   c. Manual Verification:

   • Currently, the Patreon link on GitHub profiles is mainly for display purposes.
   • You might need to implement a manual verification process if precise Patreon sponsorship data is crucial.

3. Future Possibilities:

   • As the integration between GitHub Sponsors and Patreon is relatively new, there's a possibility that GitHub might introduce API support for this feature in the future.
   • It's worth keeping an eye on the GitHub API changelog and documentation for any updates.

4. Alternative Approach:

   • If your goal is to verify overall sponsorship status (regardless of platform), you could use the existing GitHub Sponsors API and treat it as a general indicator of support.

5. Feedback to GitHub:

   • Consider submitting a feature request to GitHub for API support for Patreon-linked sponsorships. You can do this through their public feedback channels or support system.

In conclusion, while there isn't a direct API solution for retrieving Patreon-linked sponsorship status on GitHub at the moment, you can use the existing GitHub Sponsors API for general sponsorship information. For Patreon-specific data, you might need to explore alternative methods or wait for potential future API enhancements from GitHub.