Vote Chess Endpoints: Some Proposals

I've been discussing with bcurtis the possibility of extending the site's API into the area of vote chess. He explained to me that while there're no immediate resources & therefore plans to implement this idea, it would help if those of us who are keen to see this introduced drew up some form of definition.

So if you have any suggestions as to what kind of data you'd like to be able to access from VC games, please post them below...

For me, basic things like PGN's as well as team-player lists are essential.

I would definitely like to see team member lists at the conclusion of the VC game.

Also the ability to download a batch of PGN's from a team archive not just for one game.

Would like to get a list of VC matches by player and by team.  For a given match, I'd like the meta-data about the match: the two teams, IDs of participating players on both teams, admins, start times, etc.  Also who is to move and when the move is due.

For completed games, I would like ability to download the PGNs, and ideally data about the archive comments - who commented from each team in each move would be a great start.

I think the minimum data would need to be game status, something like:-

"in_progress"

"draw"

"white_won"/"black_won" and qualifying with 'on_time' etc.

Thanks @stephen_33 for creating this. It would be really useful to have an endpoint for vote chess. It could help especially to avoid timeouts.

For clubs

List of vote chess games per club. (running and finished)

For games:

Number of players on each side, time per move, start time.
Created by, accepted by.
If it is still running, if not outcome
Which team is to move, how much time left. (This would be really useful to create alerts.)
An idea could be to flag it somehow if there were votes casted or not, so we can see and avoid timeouts.

Actual position Fen. An image of the position if possible, like for the puzzles. 
PGN.

I am not sure about the player list that was mentioned above. As far as I know, we currently do not have that and I guess there is a reason for it. Not even after the game has finished.

Another interesting thing would be to get the votes after the game has finished and the comments.

(was this post created in 2020 or is it just my beta acting up with the dates again? )

"was this post created in 2020" - for once Beta isn't on the blink 😄

I created this thread originally in 2020 because that was the last time the possibility of some vote chess endpoints was floated by a staff member and they asked me to collect together some suggestions for what might be useful to users.

Ressurect this topic pls.
Player achievements would be nice API feature.

Already done because @jdcannon asked me what kind of data might be useful in any future (potential) vote chess endpoints.

But would you explain what you mean by "Player achievements" please? Not at all clear to me.

Hi @stephen_33. My proposal: https://api.chess.com/pub/player/{{player}}/achievements
with an achievement name and percent of completion. Hidden achievements not included if not achieved of course. Gamification techniques always work ;p

The end points will only provide a reflection of what is available on the web pages.

What information is available for a player that would be provided by https://api.chess.com/pub/player/{{player}}/achievements?

@Tricky_Dicky , So for achievements it would be fe:
"achievements" " [
{ "@id": "URL",
"name": "name of achievement",
"icon": "URL to icon",
"earned": "date", // no key when percentage >0 but <100
"percentage": int //0-100
},
]
btw I think the same could be done for the rest of the "awards" too.

What information on the Vote Chess web pages are you describing?

Forum title - "Vote Chess Endpoints: Some Proposals"

Ahahahah wrong tread. Just ignore.

i'd absolutely love to be able to access VC through the api. stuff i'd want? i guess just who won, who lost, points, # of players, and # of moves...