Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/filiptronicek/gh-sponsors-api
A REST API for GitHub Sponsors
https://github.com/filiptronicek/gh-sponsors-api
github rest-api sponsors
Last synced: 18 days ago
JSON representation
A REST API for GitHub Sponsors
- Host: GitHub
- URL: https://github.com/filiptronicek/gh-sponsors-api
- Owner: filiptronicek
- License: mit
- Created: 2020-06-10T09:40:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-19T12:26:12.000Z (7 months ago)
- Last Synced: 2024-05-01T16:21:37.789Z (7 months ago)
- Topics: github, rest-api, sponsors
- Language: Go
- Homepage: https://ghs.vercel.app/
- Size: 104 KB
- Stars: 32
- Watchers: 1
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Sponsors API
An unofficial REST API for GitHub Sponsors.
If you need something for GraphQL instead, there is an official API provided by GitHub. 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)
Example response:
```json
{
"status": "success",
"sponsors": {
"current": 4,
"past": 10
}
}
```
### /v3/sponsors/user/
Get details of people who sponsor `user`. Does **not** include private sponsors.
Example query: [`https://ghs.vercel.app/v3/sponsors/filiptronicek`](https://ghs.vercel.app/v3/sponsors/filiptronicek)
Example response:
```json
{
"status": "success",
"sponsors": {
"current": [
{
"username": "aellopos",
"avatar": "https://avatars.githubusercontent.com/u/39790985?s=60&v=4"
},
{
"username": "mosh98",
"avatar": "https://avatars.githubusercontent.com/u/48658042?s=60&v=4"
},
{
"username": "kahy9",
"avatar": "https://avatars.githubusercontent.com/u/48121432?s=60&v=4"
},
{
"username": "0ndras3k",
"avatar": "https://avatars.githubusercontent.com/u/57116019?s=60&v=4"
},
{
"username": "AdamSchinzel",
"avatar": "https://avatars.githubusercontent.com/u/66002635?s=60&v=4"
},
{
"username": "czM1K3",
"avatar": "https://avatars.githubusercontent.com/u/45005362?s=60&v=4"
},
{
"username": "svobodavl",
"avatar": "https://avatars.githubusercontent.com/u/58887042?s=60&v=4"
},
{
"username": "bigint",
"avatar": "https://avatars.githubusercontent.com/u/69431456?s=60&v=4"
},
{
"username": "anuraghazra",
"avatar": "https://avatars.githubusercontent.com/u/35374649?s=60&v=4"
}
],
"past": [
{
"username": "scraptechguy",
"avatar": "https://avatars.githubusercontent.com/u/75474651?s=60&v=4"
},
{
"username": "bdougie",
"avatar": "https://avatars.githubusercontent.com/u/5713670?s=60&v=4"
},
{
"username": "kdaigle",
"avatar": "https://avatars.githubusercontent.com/u/2501?s=60&v=4"
}
]
}
}
```
### /sponsoring/user/
Get all users who are sponsored by `user`.
Example query: [`https://ghs.vercel.app/sponsoring/svobodavl`](https://ghs.vercel.app/sponsoring/svobodavl)
Example response:
```json
{
"sponsorees": [
{
"handle": "filiptronicek",
"avatar": "https://avatars.githubusercontent.com/u/29888641?s=88&u=152b134e3e6e3d003ecd55fdde31c4171144c771&v=4",
"profile": "https://github.com/filiptronicek"
}
]
}
```
## 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
query {
user(login: "filiptronicek") {
... on Sponsorable {
sponsors(first: 100) {
totalCount
nodes {
... on User { login }
... on Organization { login }
}
}
}
}
}
```
- The `/sponsoring/user/` endpoint is implemented in the GraphQL API since August of 2021, usable like this: https://github.com/github/feedback/discussions/3818#discussioncomment-1131586
```gql
query {
user(login: "cheshire137") {
sponsoring(first: 10) {
totalCount
nodes {
... on User { login }
... on Organization { login }
}
}
}
}
```