Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
filiptronicek authored Jun 11, 2024
1 parent b3dfce1 commit efac89e
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# GitHub Sponsors API

A REST API for GitHub Sponsors, if you need a GraphQL one, there is an official API. Some links and examples can be found in [the Notes section](#notes).

## Endpoints

### /v2/count/user/

Get the count of people who sponsor `user`. Includes private sponsors.

Example query: [`https://ghs.vercel.app/v2/count/filiptronicek/`](https://ghs.vercel.app/v2/count/filiptronicek)
Expand All @@ -24,10 +26,11 @@ Example query: [`https://ghs.vercel.app/v2/count/filiptronicek/`](https://ghs.ve
```
</details>

### /v2/sponsors/user/
### /v3/sponsors/user/

Get details of people who sponsor `user`. Does **not** include private sponsors.

Example query: [`https://ghs.vercel.app/v2/sponsors/filiptronicek`](https://ghs.vercel.app/v2/sponsors/filiptronicek)
Example query: [`https://ghs.vercel.app/v3/sponsors/filiptronicek`](https://ghs.vercel.app/v3/sponsors/filiptronicek)

<details>
<summary>
Expand Down Expand Up @@ -119,6 +122,7 @@ Example query: [`https://ghs.vercel.app/sponsoring/svobodavl`](https://ghs.verce
</details>

## Notes

- The `/sponsors/user/` and `/count/user/` endpoints got themselves an official API (as of June of 2021)! you can use them like this: (https://github.com/github/feedback/discussions/3818)

```gql
Expand Down

0 comments on commit efac89e

Please sign in to comment.