chesscom-openapi 0.1.0

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

# \DefaultApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**pub_player_username_games_get**](DefaultApi.md#pub_player_username_games_get) | **get** /pub/player/{username}/games | Current Daily Chess
[**pub_player_username_get**](DefaultApi.md#pub_player_username_get) | **get** /pub/player/{username} | Get additional details about a player in a game.
[**pub_player_username_is_online_get**](DefaultApi.md#pub_player_username_is_online_get) | **get** /pub/player/{username}/is-online | Get player online status.
[**pub_player_username_stats_get**](DefaultApi.md#pub_player_username_stats_get) | **get** /pub/player/{username}/stats | Get player stats.
[**pub_titled_title_get**](DefaultApi.md#pub_titled_title_get) | **get** /pub/titled/{title} | List of titled-player usernames.



## pub_player_username_games_get

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

Array 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)


## pub_player_username_get

> crate::models::Profile pub_player_username_get(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)


## pub_player_username_is_online_get

> crate::models::InlineResponse200 pub_player_username_is_online_get(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)


## pub_player_username_stats_get

> crate::models::PlayerStats pub_player_username_stats_get(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)


## pub_titled_title_get

> Vec<String> pub_titled_title_get(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)