mlb-api 1.0.3

Endpoints for MLB's public Statcast API.
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334

//! Conglomerate pace data about teams, leagues, and sports. Such as total hits, innings, game duration, etc.

use std::fmt::Display;

use bon::Builder;
use chrono::TimeDelta;
use derive_more::{Deref, DerefMut};
use serde::{Deserialize, de::IgnoredAny};
use itertools::Itertools;

use crate::{Copyright, league::{LeagueId, NamedLeague}, request::RequestURL, season::SeasonId, sport::SportId, team::{NamedTeam, TeamId}};

#[derive(Debug, Deserialize, PartialEq, Clone)]
#[serde(rename_all = "camelCase")]
#[cfg_attr(feature = "_debug", serde(deny_unknown_fields))]
pub struct GamePace {
    #[serde(deserialize_with = "crate::deserialize_time_delta_from_hms", default)]
    pub total_game_time: TimeDelta,
    /// Can have a .5 for a half-inning played
    #[serde(rename = "totalInningsPlayed", default)]
    pub innings_played: f64,
    #[serde(rename = "totalHits", default)]
    pub hits: usize,
    #[serde(rename = "totalRuns", default)]
    pub runs: usize,
    #[serde(rename = "totalPlateAppearances", default)]
    pub plate_appearances: usize,
    #[serde(rename = "totalPitchers",default)]
    pub num_pitchers: usize,
    #[serde(rename = "totalPitches", default)]
    pub num_pitches: usize,
    #[serde(rename = "totalGames", default)]
    pub games: usize,

    #[serde(rename = "total9InnGames", default)]
    pub nine_inning_games: usize,
    #[serde(rename = "total9InnGamesCompletedEarly", default)]
    pub nine_inning_games_completed_early: usize,
    #[serde(rename = "total9InnGamesScheduled", default)]
    pub nine_inning_games_scheduled: usize,
    #[serde(rename = "total9InnGamesWithoutExtraInn", default)]
    pub nine_inning_games_without_extra_innings: usize,
    
    #[serde(rename = "total7InnGames", default)]
    pub seven_inning_games: usize,
    #[serde(rename = "total7InnGamesCompletedEarly", default)]
    pub seven_inning_games_completed_early: usize,
    #[serde(rename = "total7InnGamesScheduled", default)]
    pub seven_inning_games_scheduled: usize,
    #[serde(rename = "total7InnGamesWithoutExtraInn", default)]
    pub seven_inning_games_without_extra_innings: usize,
    
    #[serde(rename = "totalExtraInnGames", default)]
    pub extra_inning_games: usize,
    
    pub season: SeasonId,
    #[serde(rename = "timePer7InnGame", deserialize_with = "crate::deserialize_time_delta_from_hms", default)]
    pub time_per_seven_inning_game: TimeDelta,

    #[doc(hidden)]
    #[serde(rename = "prPortalCalculatedFields", default)]
    pub __pr_portal_calculated_fields: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "hitsPer9Inn", default)]
    pub __hits_per_nine: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "runsPer9Inn", default)]
    pub __runs_per_nine: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "pitchesPer9Inn", default)]
    pub __pitches_per_nine: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "plateAppearancesPer9Inn", default)]
    pub __plate_appearances_per_nine: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "hitsPerGame", default)]
    pub __hits_per_game: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "runsPerGame", default)]
    pub __runs_per_game: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "inningsPlayedPerGame", default)]
    pub __innings_played_per_game: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "pitchesPerGame", default)]
    pub __pitches_per_game: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "pitchersPerGame", default)]
    pub __pitchers_per_game: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "plateAppearancesPerGame", default)]
    pub __plate_appearances_per_game: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "timePerGame", default)]
    pub __time_per_game: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "timePerPitch", default)]
    pub __time_per_pitch: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "timePerHit", default)]
    pub __time_per_hit: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "timePerRun", default)]
    pub __time_per_run: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "timePerPlateAppearance", default)]
    pub __time_per_plate_appearance: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "timePer9Inn", default)]
    pub __time_per_nine: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "timePer77PlateAppearances", default)]
    pub __time_per_77_plate_appearances: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "totalExtraInnTime", default)]
    pub __total_extra_inning_time: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "timePer7InnGameWithoutExtraInn", default)]
    pub __time_per_seven_inning_game_without_extra_inning: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "hitsPerRun", default)]
    pub __hits_per_run: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "pitchesPerPitcher", default)]
    pub __pitches_per_pitcher: IgnoredAny,
}

#[derive(Debug, Deserialize, PartialEq, Clone, Deref, DerefMut)]
#[cfg_attr(feature = "_debug", serde(deny_unknown_fields))]
pub struct TeamGamePace {
    #[deref]
    #[deref_mut]
    #[serde(flatten)]
    pub pace: GamePace,

    pub team: NamedTeam,
    pub league: NamedLeague,
    pub sport: SportId,
}

#[derive(Debug, Deserialize, PartialEq, Clone, Deref, DerefMut)]
#[cfg_attr(feature = "_debug", serde(deny_unknown_fields))]
pub struct LeagueGamePace {
    #[deref]
    #[deref_mut]
    #[serde(flatten)]
    pub pace: GamePace,

    pub league: NamedLeague,

    // only sometimes present
    #[doc(hidden)]
    #[serde(rename = "sport", default)]
    pub __sport: IgnoredAny,
}

#[derive(Debug, Deserialize, PartialEq, Clone, Deref, DerefMut)]
#[cfg_attr(feature = "_debug", serde(deny_unknown_fields))]
pub struct SportGamePace {
    #[deref]
    #[deref_mut]
    #[serde(flatten)]
    pub pace: GamePace,

    pub sport: SportId,
}

#[derive(Debug, Deserialize, PartialEq, Clone)]
#[cfg_attr(feature = "_debug", serde(deny_unknown_fields))]
pub struct SportGamePaceResponse {
    pub copyright: Copyright,
    pub sports: Vec<SportGamePace>,

    #[doc(hidden)]
    #[serde(rename = "teams", default)]
    pub __teams: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "leagues", default)]
    pub __leagues: IgnoredAny,
}

#[derive(Builder)]
#[builder(derive(Into))]
pub struct SportGamePaceRequest {
    #[builder(into)]
    season: SeasonId,
    #[builder(into)]
    sport: Option<SportId>,
}

impl Display for SportGamePaceRequest {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "http://statsapi.mlb.com/api/v1/gamePace{}", gen_params! {
            "season": self.season,
            "sportId"?: self.sport,
        })
    }
}

impl<S: sport_game_pace_request_builder::State + sport_game_pace_request_builder::IsComplete> crate::request::RequestURLBuilderExt for SportGamePaceRequestBuilder<S> {
    type Built = SportGamePaceRequest;
}

impl RequestURL for SportGamePaceRequest {
    type Response = SportGamePaceResponse;
}

#[derive(Debug, Deserialize, PartialEq, Clone)]
#[cfg_attr(feature = "_debug", serde(deny_unknown_fields))]
pub struct TeamGamePaceResponse {
    pub copyright: Copyright,
    pub teams: Vec<TeamGamePace>,

    #[doc(hidden)]
    #[serde(rename = "sports", default)]
    pub __sports: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "leagues", default)]
    pub __leagues: IgnoredAny,
}

#[derive(Builder)]
#[builder(derive(Into))]
pub struct TeamGamePaceRequest {
    #[builder(into)]
    season: SeasonId,
    teams: Vec<TeamId>,
}

impl Display for TeamGamePaceRequest {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "http://statsapi.mlb.com/api/v1/gamePace{}", gen_params! {
            "season": self.season,
            "teamIds": self.teams.iter().join(","),
        })
    }
}

impl<S: team_game_pace_request_builder::State + team_game_pace_request_builder::IsComplete> crate::request::RequestURLBuilderExt for TeamGamePaceRequestBuilder<S> {
    type Built = TeamGamePaceRequest;
}

impl RequestURL for TeamGamePaceRequest {
    type Response = TeamGamePaceResponse;
}

#[derive(Debug, Deserialize, PartialEq, Clone)]
#[cfg_attr(feature = "_debug", serde(deny_unknown_fields))]
pub struct LeagueGamePaceResponse {
    pub copyright: Copyright,
    pub leagues: Vec<LeagueGamePace>,

    #[doc(hidden)]
    #[serde(rename = "teams", default)]
    pub __teams: IgnoredAny,

    #[doc(hidden)]
    #[serde(rename = "sports", default)]
    pub __sports: IgnoredAny,
}

#[derive(Builder)]
#[builder(derive(Into))]
pub struct LeagueGamePaceRequest {
    #[builder(into)]
    season: SeasonId,
    leagues: Vec<LeagueId>,
}

impl Display for LeagueGamePaceRequest {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "http://statsapi.mlb.com/api/v1/gamePace{}", gen_params! {
            "season": self.season,
            "leagueIds": self.leagues.iter().join(","),
        })
    }
}

impl<S: league_game_pace_request_builder::State + league_game_pace_request_builder::IsComplete> crate::request::RequestURLBuilderExt for LeagueGamePaceRequestBuilder<S> {
    type Built = LeagueGamePaceRequest;
}

impl RequestURL for LeagueGamePaceRequest {
    type Response = LeagueGamePaceResponse;
}

#[cfg(test)]
mod tests {
    use crate::{TEST_YEAR, game::{LeagueGamePaceRequest, SportGamePaceRequest, TeamGamePaceRequest}, request::RequestURLBuilderExt, sport::SportId, team::TeamsRequest};

    #[tokio::test]
    async fn sport_game_pace() {
        for season in 1901..=TEST_YEAR {
            let _ = SportGamePaceRequest::builder().season(season).build_and_get().await.unwrap();
        }
    }

    #[tokio::test]
    async fn team_game_pace() {
        let teams = TeamsRequest::<()>::builder().sport_id(SportId::MLB).build_and_get().await.unwrap().teams;
        let _ = TeamGamePaceRequest::builder().season(TEST_YEAR).teams(teams.into_iter().map(|team| team.id).collect()).build_and_get().await.unwrap();
    }

    #[tokio::test]
    async fn league_game_pace() {
        for season in 1901..=TEST_YEAR {
            let _ = LeagueGamePaceRequest::builder().season(season).leagues(vec![103.into(), 104.into()]).build_and_get().await.unwrap();
        }
    }
}