| Query Param | Optional | description |
|---|---|---|
| color | ✔️ | The color you'd like the message field to be (where it says XX members). Must be a color from here or here |
| style | ✔️ | Style you'd like the button to be in (plastic, flat, flat-square, for-the-badge or social) |
This route will return an SVG badge containing the amount of members in your Guilded server. Results are cached for 15 minutes.
What your invite type should be is dependent on what kind of invite link you have. If you have one that follows the /i/:code schema, you should be appending that same thing after /shields. If you are using a vanity invite link, you must use /vanity/:code instead of providing no invite type. Examples below:
https://www.guilded.gg/i/ENZog7nE ➜ https://shields.yoki-labs.xyz/shields/i/ENZog7nE
https://www.guilded.gg/r/zzQR46qKZE ➜ https://shields.yoki-labs.xyz/shields/r/zzQR46qKZE
https://www.guilded.gg/guilded-api ➜ https://shields.yoki-labs.xyz/shields/vanity/guilded-api
git clone https://github.com/yoki-labs/guilded-shields.git
cd guilded-shields
bun install
bun run src/index.ts
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
Please ensure any and all commits pass our linting and build steps.
Licensed under the MIT License