chesscom-openapi 0.1.1

OpenAPI-generated API client bindings for Chess.com
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291

# \DefaultApi

All URIs are relative to *https://api.chess.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_chess_games_archives**](DefaultApi.md#get_chess_games_archives) | **get** /pub/player/{username}/games/archives | List of Monthly Archives
[**get_chess_games_for_month**](DefaultApi.md#get_chess_games_for_month) | **get** /pub/player/{username}/games/{year}/{month} | Complete Monthly Archives
[**get_chess_games_for_month_pgn**](DefaultApi.md#get_chess_games_for_month_pgn) | **get** /pub/player/{username}/games/{year}/{month}/pgn | Multi-Game PGN Download
[**get_daily_chess_games**](DefaultApi.md#get_daily_chess_games) | **get** /pub/player/{username}/games | Current Daily Chess
[**get_daily_chess_games_to_move**](DefaultApi.md#get_daily_chess_games_to_move) | **get** /pub/player/{username}/games/to-move | To-Move Daily Chess
[**get_player_online_status**](DefaultApi.md#get_player_online_status) | **get** /pub/player/{username}/is-online | Get player online status.
[**get_player_profile**](DefaultApi.md#get_player_profile) | **get** /pub/player/{username} | Get additional details about a player in a game.
[**get_player_stats**](DefaultApi.md#get_player_stats) | **get** /pub/player/{username}/stats | Get player stats.
[**get_titled_players**](DefaultApi.md#get_titled_players) | **get** /pub/titled/{title} | List of titled-player usernames.



## get_chess_games_archives

> crate::models::InlineResponse2003 get_chess_games_archives(username)
List of Monthly Archives

Get list of monthly archives available for this player

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**username** | **String** |  | [required] |

### Return type

[**crate::models::InlineResponse2003**](inline_response_200_3.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_chess_games_for_month

> crate::models::InlineResponse2004 get_chess_games_for_month(username, year, month)
Complete Monthly Archives

Get list of Live and Daily Chess games that a player has finished

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**username** | **String** |  | [required] |
**year** | **String** | Four digit year of the game-end | [required] |
**month** | **String** | Two-digit month of the game-end | [required] |

### Return type

[**crate::models::InlineResponse2004**](inline_response_200_4.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_chess_games_for_month_pgn

> String get_chess_games_for_month_pgn(username, year, month)
Multi-Game PGN Download

Get standard multi-game format PGN containing all games for a month

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**username** | **String** |  | [required] |
**year** | **String** | Four digit year of the game-end | [required] |
**month** | **String** | Two-digit month of the game-end | [required] |

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/x-chess-pgn, application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_daily_chess_games

> crate::models::InlineResponse2001 get_daily_chess_games(username)
Current Daily Chess

Get list of Daily Chess games that a player is currently playing

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**username** | **String** |  | [required] |

### Return type

[**crate::models::InlineResponse2001**](inline_response_200_1.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_daily_chess_games_to_move

> crate::models::InlineResponse2002 get_daily_chess_games_to_move(username)
To-Move Daily Chess

Get list of Daily Chess games where it is the player's turn to move

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**username** | **String** |  | [required] |

### Return type

[**crate::models::InlineResponse2002**](inline_response_200_2.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_player_online_status

> crate::models::InlineResponse200 get_player_online_status(username)
Get player online status.

Tells if a user has been online in the last five minutes.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**username** | **String** |  | [required] |

### Return type

[**crate::models::InlineResponse200**](inline_response_200.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_player_profile

> crate::models::Profile get_player_profile(username)
Get additional details about a player in a game.

Get additional details about a player in a game.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**username** | **String** |  | [required] |

### Return type

[**crate::models::Profile**](Profile.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_player_stats

> crate::models::PlayerStats get_player_stats(username)
Get player stats.

Get ratings, win/loss, and other stats about a player's game play, tactics, lessons and Puzzle Rush score.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**username** | **String** |  | [required] |

### Return type

[**crate::models::PlayerStats**](PlayerStats.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_titled_players

> Vec<String> get_titled_players(title)
List of titled-player usernames.

List of titled-player usernames.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**title** | [**crate::models::Title**](.md) |  | [required] |

### Return type

**Vec<String>**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)