https://github.com/whoabuddy/sip015-api
A simple API to return data stored by the SIP-015 Indexer.
https://github.com/whoabuddy/sip015-api
Last synced: 2 months ago
JSON representation
A simple API to return data stored by the SIP-015 Indexer.
- Host: GitHub
- URL: https://github.com/whoabuddy/sip015-api
- Owner: whoabuddy
- Created: 2022-12-02T01:50:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-02T15:35:51.000Z (over 2 years ago)
- Last Synced: 2025-02-07T17:35:09.403Z (4 months ago)
- Language: TypeScript
- Homepage: https://api.sip015.xyz
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SIP-015 API
A simple API to return data stored by the [SIP-015 Indexer](https://github.com/whoabuddy/sip015-indexer).
- Production deployment: https://api.sip015.xyz
- Testing deployment: https://sip015-api.chaos.workers.dev
The architecture uses Cloudflare [Workers](https://developers.cloudflare.com/workers/) and [KV](https://developers.cloudflare.com/workers/runtime-apis/kv/).
Supported routes will fetch and return data, or 404 if a key is not found.
Unsupported routes will display the index page.
> **ALPHA:** The endpoints listed here may change as interactions between this and the indexer are adjusted.
## Supported Routes
- `/data` - returns all known keys in Cloudflare KV store
- `/addresses` - returns all known voting addresses in Cloudflare KV store
- `/method2-vote` - returns compiled vote stats for SIP-015
- `/method2-vote-details` - returns compiled vote data for SIP-015
- `/method2-invalid-votes` - returns stats on invalid votes for SIP-015
- `/method2-yes-votes` - returns transactions and stats on yes votes for SIP-015
- `/method2-no-votes` - returns transactions and stats on no votes for SIP-015
- `/` or invalid path - returns this info
Types for each object queried can be found in [utils.ts](./src/utils.ts).