https://github.com/joecars/nermanapi

API for communities using Nerman's governance data
https://github.com/joecars/nermanapi

Last synced: 11 days ago
JSON representation

API for communities using Nerman's governance data

• Host: GitHub
• URL: https://github.com/joecars/nermanapi
• Owner: JoeCars
• Created: 2023-11-27T21:05:45.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-10-24T17:01:14.000Z (25 days ago)
• Last Synced: 2024-10-26T00:32:11.463Z (24 days ago)
• Language: TypeScript
• Size: 81.1 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Nerman API

An API to query data stored by Nerman Discord.

## Endpoints

- **`GET /`:** Returns a list of user statistics for users eligible to vote in the most recent Nouncil poll.

```json

[

	{

		"userId": "362737590430072862",

		"votesEligible": 435,

		"votesParticipated": 388,

		"participationRate": 89.19540229885058 // A percentage. 0 to 100

	},

	//...

]

```

- **`GET /:discordId`:** Returns the statistics of the user, if they are eligible to vote in the most recent Nouncil poll.

```json

{

	"userId": "362737590430072862",

	"votesEligible": 435,

	"votesParticipated": 388,

	"participationRate": 89.19540229885058 // A percentage. 0 to 100

}

```