For developers
Mintboard is open source under the MIT licence. The hosted board and City Bot are the easiest way to use it. If you would rather run your own copy, extend it, or build on its data, everything is on GitHub.
Repository: github.com/cityofstonks/mintboard
Technical docs on GitHub
In the repository's docs/ folder:
| Doc | What is in it |
|---|---|
Setup · docs/SETUP.md | Deploying your own board, the config file, data files, embedding, environment variables |
The bot · docs/BOT.md | Creating your own Discord application, the database tables, scheduling the draw, ticket weighting |
Operations · docs/OPERATIONS.md | Running a collab end to end, from the offer to measuring how spots were held |
Architecture · docs/ARCHITECTURE.md | How the board, the bot and the database fit together |
Traps · docs/TRAPS.md | Failures this software has actually had, and why they looked like working software |
Public API
Read-only, no key needed.
| Route | Returns |
|---|---|
GET /api/raffles | Every open raffle. Nothing per-wallet. |
GET /api/board?address=0x… | The mints that wallet qualifies for, its holdings, warnings and open raffles |
GET /api/board/ics?address=0x… | A calendar file with one event per dated mint |
GET /api/source | Mints, spot lists and raffles, as the City of Stonks site reads them |
Contributing
Issues and pull requests are welcome on GitHub. Please do not open public issues for security problems; open a ticket in our Discord instead.