https://github.com/tj/sponsors-api
GitHub Sponsor avatar listings in your Readme.md
https://github.com/tj/sponsors-api
github github-sponsors golang sponsors sponsorship
Last synced: 9 months ago
JSON representation
GitHub Sponsor avatar listings in your Readme.md
- Host: GitHub
- URL: https://github.com/tj/sponsors-api
- Owner: tj
- License: mit
- Created: 2020-05-28T13:08:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-05T15:27:32.000Z (almost 5 years ago)
- Last Synced: 2025-05-08T21:17:52.608Z (9 months ago)
- Topics: github, github-sponsors, golang, sponsors, sponsorship
- Language: Go
- Homepage:
- Size: 10.7 KB
- Stars: 242
- Watchers: 5
- Forks: 29
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- my-awesome - tj/sponsors-api - sponsors,golang,sponsors,sponsorship pushed_at:2021-04 star:0.2k fork:0.0k GitHub Sponsor avatar listings in your Readme.md (Go)
README
# Sponsors API
Sponsors API is a [GitHub Sponsors](https://github.com/sponsors) server for displaying sponsor avatars in your project Readme. It looks like this:
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/0)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/1)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/2)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/3)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/4)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/5)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/6)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/7)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/8)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/9)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/10)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/11)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/12)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/13)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/14)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/15)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/16)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/17)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/18)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/19)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/20)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/21)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/22)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/23)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/24)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/25)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/26)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/27)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/28)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/29)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/30)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/31)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/32)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/33)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/34)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/35)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/36)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/37)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/38)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/39)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/40)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/41)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/42)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/43)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/44)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/45)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/46)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/47)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/48)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/49)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/50)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/51)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/52)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/53)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/54)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/55)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/56)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/57)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/58)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/59)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/60)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/61)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/62)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/63)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/64)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/65)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/66)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/67)
[
](https://sponsors-api-u2fftug6kq-uc.a.run.app/sponsor/profile/68)
## Deploying
Deploy to host which supports HTTP, for example using [Apex Up](https://github.com/apex/up) or Heroku. The following environment variables are supported:
- `GITHUB_TOKEN` the GitHub API token (no scopes are required)
- `PORT` the server port (defaults to 3000)
- `URL` the url to your endpoint such as "https://sponsors.myhost.com" (optional)
## Usage
Visit the `/sponsor/markdown` path for the markdown to copy/paste. Sponsors are cached for an hour by default, tweak with the `-cache-ttl` flag.