Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

map-stats endpoint info #33

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

map-stats endpoint info #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/Endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,9 +334,9 @@ are the ones listed below.

- [POST] `https://screeps.com/api/game/map-stats`
- post data: `{ rooms: [ <room name> ], statName: "..."}`
- statName can be "owner0", "claim0", or a stat (see the enumeration above) followed by an interval
- if it is owner0 or claim0, there's no separate stat block in the response
- response: `{ ok, stats: { <room name>: { status, novice, own: { user, level }, <stat>: [ { user, value } ] } }, users: { <user's _id>: { _id, username, badge: { type, color1, color2, color3, param, flip } } } }`
- statName can be "owner0", "claim0", "sign0", or a stat (see the enumeration above) followed by an interval
- if it is owner0. claim0 or sign0, there's no separate stat block in the response
- response: `{ ok, stats: { <room name>: { status, novice, own: { user, level }, sign: { datetime, text, time, user }, decorations: [{_id, activatedAt, active: {}, createdAt, decoration, user}], <stat>: [ { user, value } ] } }, users: { <user's _id>: { _id, username, badge: { type, color1, color2, color3, param, flip } } } }`
- `status` and `novice` are as per the `room-status` call
- `level` can be 0 to indicate a reserved room

Expand All @@ -354,4 +354,4 @@ are the ones listed below.
- only works on the Public Test Realm

- [GET] `https://screeps.com/api/scoreboard/list?limit=20&offset=0`
- only works on Seasonal servers
- only works on Seasonal servers