cfbd 5.0.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2323 @@
1
+ export type Venue = {
2
+ id: (number) | null;
3
+ name: (string) | null;
4
+ city: (string) | null;
5
+ state: (string) | null;
6
+ zip: (string) | null;
7
+ countryCode: (string) | null;
8
+ timezone: (string) | null;
9
+ latitude: (number) | null;
10
+ longitude: (number) | null;
11
+ elevation: (string) | null;
12
+ capacity: (number) | null;
13
+ constructionYear: (number) | null;
14
+ grass?: (boolean) | null;
15
+ dome?: (boolean) | null;
16
+ };
17
+ export type Team = {
18
+ id: number;
19
+ school: string;
20
+ mascot: (string) | null;
21
+ abbreviation: (string) | null;
22
+ alternateNames: Array<(string)> | null;
23
+ conference: (string) | null;
24
+ division: (string) | null;
25
+ classification: (string) | null;
26
+ color: (string) | null;
27
+ alternateColor: (string) | null;
28
+ logos: Array<(string)> | null;
29
+ twitter: (string) | null;
30
+ location: ((Venue) | null);
31
+ };
32
+ export type MatchupGame = {
33
+ season: number;
34
+ week: number;
35
+ seasonType: string;
36
+ date: string;
37
+ neutralSite: boolean;
38
+ venue: string;
39
+ homeTeam: string;
40
+ homeScore: number;
41
+ awayTeam: string;
42
+ awayScore: number;
43
+ winner: (string) | null;
44
+ };
45
+ export type Matchup = {
46
+ team1: string;
47
+ team2: string;
48
+ startYear?: number;
49
+ endYear?: number;
50
+ team1Wins: number;
51
+ team2Wins: number;
52
+ ties: number;
53
+ games: Array<MatchupGame>;
54
+ };
55
+ export type RosterPlayer = {
56
+ id: string;
57
+ firstName: string;
58
+ lastName: string;
59
+ team: string;
60
+ height: (number) | null;
61
+ weight: (number) | null;
62
+ jersey: (number) | null;
63
+ year: number;
64
+ position: (string) | null;
65
+ homeCity: (string) | null;
66
+ homeState: (string) | null;
67
+ homeCountry: (string) | null;
68
+ homeLatitude: (number) | null;
69
+ homeLongitude: (number) | null;
70
+ homeCountyFIPS: (string) | null;
71
+ recruitIds: Array<(string)> | null;
72
+ };
73
+ export type DivisionClassification = 'fbs' | 'fcs' | 'ii' | 'iii';
74
+ export type Conference = {
75
+ id: number;
76
+ name: string;
77
+ shortName: (string) | null;
78
+ abbreviation: (string) | null;
79
+ classification: ((DivisionClassification) | null);
80
+ };
81
+ export type TeamTalent = {
82
+ year: number;
83
+ team: string;
84
+ talent: number;
85
+ };
86
+ export type PlayerStat = {
87
+ season: number;
88
+ playerId: string;
89
+ player: string;
90
+ team: string;
91
+ conference: string;
92
+ category: string;
93
+ statType: string;
94
+ stat: number;
95
+ };
96
+ export type SeasonType = 'regular' | 'postseason' | 'both' | 'allstar' | 'spring_regular' | 'spring_postseason';
97
+ export type TeamStat = {
98
+ season: number;
99
+ team: string;
100
+ conference: string;
101
+ statName: string;
102
+ statValue: (string | number);
103
+ };
104
+ export type AdvancedSeasonStat = {
105
+ season: number;
106
+ team: string;
107
+ conference: string;
108
+ offense: {
109
+ passingPlays: {
110
+ explosiveness: number;
111
+ successRate: number;
112
+ totalPPA: number;
113
+ ppa: number;
114
+ rate: number;
115
+ };
116
+ rushingPlays: {
117
+ explosiveness: number;
118
+ successRate: number;
119
+ totalPPA: number;
120
+ ppa: number;
121
+ rate: number;
122
+ };
123
+ passingDowns: {
124
+ explosiveness: number;
125
+ successRate: number;
126
+ ppa: number;
127
+ rate: number;
128
+ };
129
+ standardDowns: {
130
+ explosiveness: number;
131
+ successRate: number;
132
+ ppa: number;
133
+ rate: number;
134
+ };
135
+ havoc: {
136
+ db: (number) | null;
137
+ frontSeven: (number) | null;
138
+ total: (number) | null;
139
+ };
140
+ fieldPosition: {
141
+ averagePredictedPoints: (number) | null;
142
+ averageStart: (number) | null;
143
+ };
144
+ pointsPerOpportunity: number;
145
+ totalOpportunies: number;
146
+ openFieldYardsTotal: number;
147
+ openFieldYards: number;
148
+ secondLevelYardsTotal: number;
149
+ secondLevelYards: number;
150
+ lineYardsTotal: number;
151
+ lineYards: number;
152
+ stuffRate: number;
153
+ powerSuccess: number;
154
+ explosiveness: number;
155
+ successRate: number;
156
+ totalPPA: number;
157
+ ppa: number;
158
+ drives: number;
159
+ plays: number;
160
+ };
161
+ defense: {
162
+ passingPlays: {
163
+ explosiveness: number;
164
+ successRate: number;
165
+ totalPPA: number;
166
+ ppa: number;
167
+ rate: number;
168
+ };
169
+ rushingPlays: {
170
+ explosiveness: number;
171
+ successRate: number;
172
+ totalPPA: number;
173
+ ppa: number;
174
+ rate: number;
175
+ };
176
+ passingDowns: {
177
+ explosiveness: number;
178
+ successRate: number;
179
+ totalPPA: number;
180
+ ppa: number;
181
+ rate: number;
182
+ };
183
+ standardDowns: {
184
+ explosiveness: number;
185
+ successRate: number;
186
+ ppa: number;
187
+ rate: number;
188
+ };
189
+ havoc: {
190
+ db: (number) | null;
191
+ frontSeven: (number) | null;
192
+ total: (number) | null;
193
+ };
194
+ fieldPosition: {
195
+ averagePredictedPoints: (number) | null;
196
+ averageStart: (number) | null;
197
+ };
198
+ pointsPerOpportunity: number;
199
+ totalOpportunies: number;
200
+ openFieldYardsTotal: number;
201
+ openFieldYards: number;
202
+ secondLevelYardsTotal: number;
203
+ secondLevelYards: number;
204
+ lineYardsTotal: number;
205
+ lineYards: number;
206
+ stuffRate: number;
207
+ powerSuccess: number;
208
+ explosiveness: number;
209
+ successRate: number;
210
+ totalPPA: number;
211
+ ppa: number;
212
+ drives: number;
213
+ plays: number;
214
+ };
215
+ };
216
+ export type AdvancedGameStat = {
217
+ gameId: number;
218
+ season: number;
219
+ week: number;
220
+ team: string;
221
+ opponent: string;
222
+ offense: {
223
+ passingPlays: {
224
+ explosiveness: number;
225
+ successRate: number;
226
+ totalPPA: number;
227
+ ppa: number;
228
+ };
229
+ rushingPlays: {
230
+ explosiveness: number;
231
+ successRate: number;
232
+ totalPPA: number;
233
+ ppa: number;
234
+ };
235
+ passingDowns: {
236
+ explosiveness: number;
237
+ successRate: number;
238
+ ppa: number;
239
+ };
240
+ standardDowns: {
241
+ explosiveness: number;
242
+ successRate: number;
243
+ ppa: number;
244
+ };
245
+ openFieldYardsTotal: number;
246
+ openFieldYards: number;
247
+ secondLevelYardsTotal: number;
248
+ secondLevelYards: number;
249
+ lineYardsTotal: number;
250
+ lineYards: number;
251
+ stuffRate: number;
252
+ powerSuccess: number;
253
+ explosiveness: number;
254
+ successRate: number;
255
+ totalPPA: number;
256
+ ppa: number;
257
+ drives: number;
258
+ plays: number;
259
+ };
260
+ defense: {
261
+ passingPlays: {
262
+ explosiveness: number;
263
+ successRate: number;
264
+ totalPPA: number;
265
+ ppa: number;
266
+ };
267
+ rushingPlays: {
268
+ explosiveness: number;
269
+ successRate: number;
270
+ totalPPA: number;
271
+ ppa: number;
272
+ };
273
+ passingDowns: {
274
+ explosiveness: number;
275
+ successRate: number;
276
+ ppa: number;
277
+ };
278
+ standardDowns: {
279
+ explosiveness: number;
280
+ successRate: number;
281
+ ppa: number;
282
+ };
283
+ openFieldYardsTotal: number;
284
+ openFieldYards: number;
285
+ secondLevelYardsTotal: number;
286
+ secondLevelYards: number;
287
+ lineYardsTotal: number;
288
+ lineYards: number;
289
+ stuffRate: number;
290
+ powerSuccess: number;
291
+ explosiveness: number;
292
+ successRate: number;
293
+ totalPPA: number;
294
+ ppa: number;
295
+ drives: number;
296
+ plays: number;
297
+ };
298
+ };
299
+ export type RecruitClassification = 'JUCO' | 'PrepSchool' | 'HighSchool';
300
+ export type Recruit = {
301
+ id: string;
302
+ athleteId: (string) | null;
303
+ recruitType: RecruitClassification;
304
+ year: number;
305
+ ranking: (number) | null;
306
+ name: string;
307
+ school: (string) | null;
308
+ committedTo: (string) | null;
309
+ position: (string) | null;
310
+ height: (number) | null;
311
+ weight: (number) | null;
312
+ stars: number;
313
+ rating: number;
314
+ city: (string) | null;
315
+ stateProvince: (string) | null;
316
+ country: (string) | null;
317
+ hometownInfo: {
318
+ fipsCode: (string) | null;
319
+ longitude: (number) | null;
320
+ latitude: (number) | null;
321
+ };
322
+ };
323
+ export type TeamRecruitingRanking = {
324
+ year: number;
325
+ rank: number;
326
+ team: string;
327
+ points: number;
328
+ };
329
+ export type AggregatedTeamRecruiting = {
330
+ team: string;
331
+ conference: string;
332
+ positionGroup: (string) | null;
333
+ averageRating: number;
334
+ totalRating: number;
335
+ commits: number;
336
+ averageStars: number;
337
+ };
338
+ export type TeamSP = {
339
+ year: number;
340
+ team: string;
341
+ conference: string;
342
+ rating: number;
343
+ ranking: number;
344
+ secondOrderWins: (number) | null;
345
+ sos: (number) | null;
346
+ offense: {
347
+ pace: (number) | null;
348
+ runRate: (number) | null;
349
+ passingDowns: (number) | null;
350
+ standardDowns: (number) | null;
351
+ passing: (number) | null;
352
+ rushing: (number) | null;
353
+ explosiveness: (number) | null;
354
+ success: (number) | null;
355
+ rating: number;
356
+ ranking: number;
357
+ };
358
+ defense: {
359
+ havoc: {
360
+ db: (number) | null;
361
+ frontSeven: (number) | null;
362
+ total: (number) | null;
363
+ };
364
+ passingDowns: (number) | null;
365
+ standardDowns: (number) | null;
366
+ passing: (number) | null;
367
+ rushing: (number) | null;
368
+ explosiveness: (number) | null;
369
+ success: (number) | null;
370
+ rating: number;
371
+ ranking: number;
372
+ };
373
+ specialTeams: {
374
+ rating: (number) | null;
375
+ };
376
+ };
377
+ export type ConferenceSP = {
378
+ year: number;
379
+ conference: string;
380
+ rating: number;
381
+ secondOrderWins: (number) | null;
382
+ sos: (number) | null;
383
+ offense: {
384
+ pace: (number) | null;
385
+ runRate: (number) | null;
386
+ passingDowns: (number) | null;
387
+ standardDowns: (number) | null;
388
+ passing: (number) | null;
389
+ rushing: (number) | null;
390
+ explosiveness: (number) | null;
391
+ success: (number) | null;
392
+ rating: number;
393
+ };
394
+ defense: {
395
+ havoc: {
396
+ db: (number) | null;
397
+ frontSeven: (number) | null;
398
+ total: (number) | null;
399
+ };
400
+ passingDowns: (number) | null;
401
+ standardDowns: (number) | null;
402
+ passing: (number) | null;
403
+ rushing: (number) | null;
404
+ explosiveness: (number) | null;
405
+ success: (number) | null;
406
+ rating: number;
407
+ };
408
+ specialTeams: {
409
+ rating: (number) | null;
410
+ };
411
+ };
412
+ export type TeamSRS = {
413
+ year: number;
414
+ team: string;
415
+ conference: (string) | null;
416
+ division: (string) | null;
417
+ rating: number;
418
+ ranking: number;
419
+ };
420
+ export type TeamElo = {
421
+ year: number;
422
+ team: string;
423
+ conference: string;
424
+ elo: (number) | null;
425
+ };
426
+ export type TeamFPI = {
427
+ year: number;
428
+ team: string;
429
+ conference: (string) | null;
430
+ fpi: (number) | null;
431
+ resumeRanks: {
432
+ gameControl: (number) | null;
433
+ remainingStrengthOfSchedule: (number) | null;
434
+ strengthOfSchedule: (number) | null;
435
+ averageWinProbability: (number) | null;
436
+ fpi: (number) | null;
437
+ strengthOfRecord: (number) | null;
438
+ };
439
+ efficiencies: {
440
+ specialTeams: (number) | null;
441
+ defense: (number) | null;
442
+ offense: (number) | null;
443
+ overall: (number) | null;
444
+ };
445
+ };
446
+ export type PollRank = {
447
+ rank: (number) | null;
448
+ school: string;
449
+ conference: (string) | null;
450
+ firstPlaceVotes: (number) | null;
451
+ points: (number) | null;
452
+ };
453
+ export type Poll = {
454
+ poll: string;
455
+ ranks: Array<PollRank>;
456
+ };
457
+ export type PollWeek = {
458
+ season: number;
459
+ seasonType: SeasonType;
460
+ week: number;
461
+ polls: Array<Poll>;
462
+ };
463
+ export type Play = {
464
+ id: string;
465
+ driveId: string;
466
+ gameId: number;
467
+ driveNumber: (number) | null;
468
+ playNumber: (number) | null;
469
+ offense: string;
470
+ offenseConference: (string) | null;
471
+ offenseScore: number;
472
+ defense: string;
473
+ home: string;
474
+ away: string;
475
+ defenseConference: (string) | null;
476
+ defenseScore: number;
477
+ period: number;
478
+ clock: {
479
+ seconds: (number) | null;
480
+ minutes: (number) | null;
481
+ };
482
+ offenseTimeouts: (number) | null;
483
+ defenseTimeouts: (number) | null;
484
+ yardline: number;
485
+ yardsToGoal: number;
486
+ down: number;
487
+ distance: number;
488
+ yardsGained: number;
489
+ scoring: boolean;
490
+ playType: string;
491
+ playText: (string) | null;
492
+ ppa: (number) | null;
493
+ wallclock: (string) | null;
494
+ };
495
+ export type PlayType = {
496
+ id: number;
497
+ text: string;
498
+ abbreviation: (string) | null;
499
+ };
500
+ export type PlayStat = {
501
+ gameId: number;
502
+ season: number;
503
+ week: number;
504
+ team: string;
505
+ conference: string;
506
+ opponent: string;
507
+ teamScore: number;
508
+ opponentScore: number;
509
+ driveId: string;
510
+ playId: string;
511
+ period: number;
512
+ clock: {
513
+ seconds: (number) | null;
514
+ minutes: (number) | null;
515
+ };
516
+ yardsToGoal: number;
517
+ down: number;
518
+ distance: number;
519
+ athleteId: string;
520
+ athleteName: string;
521
+ statType: string;
522
+ stat: number;
523
+ };
524
+ export type PlayStatType = {
525
+ id: number;
526
+ name: string;
527
+ };
528
+ export type PlayerSearchResult = {
529
+ id: string;
530
+ team: string;
531
+ name: string;
532
+ firstName: (string) | null;
533
+ lastName: (string) | null;
534
+ weight: (number) | null;
535
+ height: (number) | null;
536
+ jersey: (number) | null;
537
+ position: string;
538
+ hometown: string;
539
+ teamColor: string;
540
+ teamColorSecondary: string;
541
+ };
542
+ export type PlayerPPAChartItem = {
543
+ playNumber: number;
544
+ avgPPA: number;
545
+ };
546
+ export type PlayerUsage = {
547
+ season: number;
548
+ id: string;
549
+ name: string;
550
+ position: string;
551
+ team: string;
552
+ conference: string;
553
+ usage: {
554
+ passingDowns: number;
555
+ standardDowns: number;
556
+ thirdDown: number;
557
+ secondDown: number;
558
+ firstDown: number;
559
+ rush: number;
560
+ pass: number;
561
+ overall: number;
562
+ };
563
+ };
564
+ export type ReturningProduction = {
565
+ season: number;
566
+ team: string;
567
+ conference: string;
568
+ totalPPA: number;
569
+ totalPassingPPA: number;
570
+ totalReceivingPPA: number;
571
+ totalRushingPPA: number;
572
+ percentPPA: number;
573
+ percentPassingPPA: number;
574
+ percentReceivingPPA: number;
575
+ percentRushingPPA: number;
576
+ usage: number;
577
+ passingUsage: number;
578
+ receivingUsage: number;
579
+ rushingUsage: number;
580
+ };
581
+ export type TransferEligibility = 'Withdrawn' | 'TBD' | 'PendingAppeal' | 'SittingOne' | 'Immediate';
582
+ export type PlayerTransfer = {
583
+ season: number;
584
+ firstName: string;
585
+ lastName: string;
586
+ position: string;
587
+ origin: string;
588
+ destination: (string) | null;
589
+ transferDate: (string) | null;
590
+ rating: (number) | null;
591
+ stars: (number) | null;
592
+ eligibility: ((TransferEligibility) | null);
593
+ };
594
+ export type PredictedPointsValue = {
595
+ yardLine: number;
596
+ predictedPoints: number;
597
+ };
598
+ export type TeamSeasonPredictedPointsAdded = {
599
+ season: number;
600
+ conference: string;
601
+ team: string;
602
+ offense: {
603
+ cumulative: {
604
+ rushing: number;
605
+ passing: number;
606
+ total: number;
607
+ };
608
+ thirdDown: number;
609
+ secondDown: number;
610
+ firstDown: number;
611
+ rushing: number;
612
+ passing: number;
613
+ overall: number;
614
+ };
615
+ defense: {
616
+ cumulative: {
617
+ rushing: number;
618
+ passing: number;
619
+ total: number;
620
+ };
621
+ thirdDown: number;
622
+ secondDown: number;
623
+ firstDown: number;
624
+ rushing: number;
625
+ passing: number;
626
+ overall: number;
627
+ };
628
+ };
629
+ export type TeamGamePredictedPointsAdded = {
630
+ gameId: number;
631
+ season: number;
632
+ week: number;
633
+ seasonType: SeasonType;
634
+ team: string;
635
+ conference: string;
636
+ opponent: string;
637
+ offense: {
638
+ thirdDown: number;
639
+ secondDown: number;
640
+ firstDown: number;
641
+ rushing: number;
642
+ passing: number;
643
+ overall: number;
644
+ };
645
+ defense: {
646
+ thirdDown: number;
647
+ secondDown: number;
648
+ firstDown: number;
649
+ rushing: number;
650
+ passing: number;
651
+ overall: number;
652
+ };
653
+ };
654
+ export type PlayerGamePredictedPointsAdded = {
655
+ season: number;
656
+ week: number;
657
+ seasonType: SeasonType;
658
+ id: string;
659
+ name: string;
660
+ position: string;
661
+ team: string;
662
+ opponent: string;
663
+ averagePPA: {
664
+ rush?: number;
665
+ pass?: number;
666
+ all: number;
667
+ };
668
+ };
669
+ export type PlayerSeasonPredictedPointsAdded = {
670
+ season: number;
671
+ id: string;
672
+ name: string;
673
+ position: string;
674
+ team: string;
675
+ conference: string;
676
+ averagePPA: {
677
+ passingDowns?: number;
678
+ standardDowns?: number;
679
+ thirdDown?: number;
680
+ secondDown?: number;
681
+ firstDown?: number;
682
+ rush?: number;
683
+ pass?: number;
684
+ all: number;
685
+ };
686
+ totalPPA: {
687
+ passingDowns?: number;
688
+ standardDowns?: number;
689
+ thirdDown?: number;
690
+ secondDown?: number;
691
+ firstDown?: number;
692
+ rush?: number;
693
+ pass?: number;
694
+ all: number;
695
+ };
696
+ };
697
+ export type PlayWinProbability = {
698
+ gameId: number;
699
+ playId: string;
700
+ playText: string;
701
+ homeId: number;
702
+ home: string;
703
+ awayId: number;
704
+ away: string;
705
+ spread: number;
706
+ homeBall: boolean;
707
+ homeScore: number;
708
+ awayScore: number;
709
+ yardLine: number;
710
+ down: number;
711
+ distance: number;
712
+ homeWinProbability: number;
713
+ playNumber: number;
714
+ };
715
+ export type PregameWinProbability = {
716
+ season: number;
717
+ seasonType: SeasonType;
718
+ week: number;
719
+ gameId: number;
720
+ homeTeam: string;
721
+ awayTeam: string;
722
+ spread: number;
723
+ homeWinProbability: number;
724
+ };
725
+ export type FieldGoalEP = {
726
+ yardsToGoal: number;
727
+ distance: number;
728
+ expectedPoints: number;
729
+ };
730
+ export type LiveGameTeam = {
731
+ teamId: number;
732
+ team: string;
733
+ homeAway: 'home' | 'away';
734
+ lineScores: Array<(number)>;
735
+ points: number;
736
+ drives: number;
737
+ scoringOpportunities: number;
738
+ pointsPerOpportunity: number;
739
+ plays: number;
740
+ lineYards: number;
741
+ lineYardsPerRush: number;
742
+ secondLevelYards: number;
743
+ secondLevelYardsPerRush: number;
744
+ openFieldYards: number;
745
+ openFieldYardsPerRush: number;
746
+ epaPerPlay: number;
747
+ totalEpa: number;
748
+ passingEpa: number;
749
+ epaPerPass: number;
750
+ rushingEpa: number;
751
+ epaPerRush: number;
752
+ successRate: number;
753
+ standardDownSuccessRate: number;
754
+ passingDownSuccessRate: number;
755
+ explosiveness: number;
756
+ };
757
+ export type homeAway = 'home' | 'away';
758
+ export type LiveGamePlay = {
759
+ id: string;
760
+ homeScore: number;
761
+ awayScore: number;
762
+ period: number;
763
+ clock: string;
764
+ wallClock: string;
765
+ teamId: number;
766
+ team: string;
767
+ down: number;
768
+ distance: number;
769
+ yardsToGoal: number;
770
+ yardsGained: number;
771
+ playTypeId: number;
772
+ playType: string;
773
+ epa: (number) | null;
774
+ garbageTime: boolean;
775
+ success: boolean;
776
+ rushPash: 'rush' | 'pass' | 'other';
777
+ downType: 'passing' | 'standard';
778
+ playText: string;
779
+ };
780
+ export type rushPash = 'rush' | 'pass' | 'other';
781
+ export type downType = 'passing' | 'standard';
782
+ export type LiveGameDrive = {
783
+ id: string;
784
+ offenseId: number;
785
+ offense: string;
786
+ defenseId: number;
787
+ defense: string;
788
+ playCount: number;
789
+ yards: number;
790
+ startPeriod: number;
791
+ startClock: (string) | null;
792
+ startYardsToGoal: number;
793
+ endPeriod: (number) | null;
794
+ endClock: (string) | null;
795
+ endYardsToGoal: (number) | null;
796
+ duration: (string) | null;
797
+ scoringOpportunity: boolean;
798
+ result: string;
799
+ pointsGained: number;
800
+ plays: Array<LiveGamePlay>;
801
+ };
802
+ export type LiveGame = {
803
+ id: number;
804
+ status: string;
805
+ period: (number) | null;
806
+ clock: string;
807
+ possession: string;
808
+ down: (number) | null;
809
+ distance: (number) | null;
810
+ yardsToGoal: (number) | null;
811
+ teams: Array<LiveGameTeam>;
812
+ drives: Array<LiveGameDrive>;
813
+ };
814
+ export type GameLine = {
815
+ provider: string;
816
+ spread: (number) | null;
817
+ formattedSpread: string;
818
+ spreadOpen: (number) | null;
819
+ overUnder: (number) | null;
820
+ overUnderOpen: (number) | null;
821
+ homeMoneyline: (number) | null;
822
+ awayMoneyline: (number) | null;
823
+ };
824
+ export type BettingGame = {
825
+ id: number;
826
+ season: number;
827
+ seasonType: SeasonType;
828
+ week: number;
829
+ startDate: string;
830
+ homeTeam: string;
831
+ homeConference: (string) | null;
832
+ homeClassification: ((DivisionClassification) | null);
833
+ homeScore: (number) | null;
834
+ awayTeam: string;
835
+ awayConference: (string) | null;
836
+ awayClassification: ((DivisionClassification) | null);
837
+ awayScore: (number) | null;
838
+ lines: Array<GameLine>;
839
+ };
840
+ export type Game = {
841
+ id: number;
842
+ season: number;
843
+ week: number;
844
+ seasonType: SeasonType;
845
+ startDate: string;
846
+ startTimeTBD: boolean;
847
+ completed: boolean;
848
+ neutralSite: boolean;
849
+ conferenceGame: boolean;
850
+ attendance: (number) | null;
851
+ venueId: (number) | null;
852
+ venue: (string) | null;
853
+ homeId: number;
854
+ homeTeam: string;
855
+ homeConference: (string) | null;
856
+ homeClassification: ((DivisionClassification) | null);
857
+ homePoints: (number) | null;
858
+ homeLineScores: Array<(number)> | null;
859
+ homePostgameWinProbability: (number) | null;
860
+ homePregameElo: (number) | null;
861
+ homePostgameElo: (number) | null;
862
+ awayId: number;
863
+ awayTeam: string;
864
+ awayConference: (string) | null;
865
+ awayClassification: ((DivisionClassification) | null);
866
+ awayPoints: (number) | null;
867
+ awayLineScores: Array<(number)> | null;
868
+ awayPostgameWinProbability: (number) | null;
869
+ awayPregameElo: (number) | null;
870
+ awayPostgameElo: (number) | null;
871
+ excitementIndex: (number) | null;
872
+ highlights: (string) | null;
873
+ notes: (string) | null;
874
+ };
875
+ export type GameTeamStatsTeamStat = {
876
+ category: string;
877
+ stat: string;
878
+ };
879
+ export type GameTeamStatsTeam = {
880
+ teamId: number;
881
+ team: string;
882
+ conference: (string) | null;
883
+ homeAway: 'home' | 'away';
884
+ points: (number) | null;
885
+ stats: Array<GameTeamStatsTeamStat>;
886
+ };
887
+ export type GameTeamStats = {
888
+ id: number;
889
+ teams: Array<GameTeamStatsTeam>;
890
+ };
891
+ export type GamePlayerStatPlayer = {
892
+ id: string;
893
+ name: string;
894
+ stat: string;
895
+ };
896
+ export type GamePlayerStatTypes = {
897
+ name: string;
898
+ athletes: Array<GamePlayerStatPlayer>;
899
+ };
900
+ export type GamePlayerStatCategories = {
901
+ name: string;
902
+ types: Array<GamePlayerStatTypes>;
903
+ };
904
+ export type GamePlayerStatsTeam = {
905
+ team: string;
906
+ conference: (string) | null;
907
+ homeAway: 'home' | 'away';
908
+ points: (number) | null;
909
+ categories: Array<GamePlayerStatCategories>;
910
+ };
911
+ export type GamePlayerStats = {
912
+ id: number;
913
+ teams: Array<GamePlayerStatsTeam>;
914
+ };
915
+ export type MediaType = 'tv' | 'radio' | 'web' | 'ppv' | 'mobile';
916
+ export type GameMedia = {
917
+ id: number;
918
+ season: number;
919
+ week: number;
920
+ seasonType: SeasonType;
921
+ startTime: string;
922
+ isStartTimeTBD: boolean;
923
+ homeTeam: string;
924
+ homeConference: (string) | null;
925
+ awayTeam: string;
926
+ awayConference: (string) | null;
927
+ mediaType: MediaType;
928
+ outlet: string;
929
+ };
930
+ export type GameWeather = {
931
+ id: number;
932
+ season: number;
933
+ week: number;
934
+ seasonType: SeasonType;
935
+ startTime: string;
936
+ gameIndoors: boolean;
937
+ homeTeam: string;
938
+ homeConference: (string) | null;
939
+ awayTeam: string;
940
+ awayConference: (string) | null;
941
+ venueId: number;
942
+ venue: string;
943
+ temperature: (number) | null;
944
+ dewPoint: (number) | null;
945
+ humidity: (number) | null;
946
+ precipitation: (number) | null;
947
+ snowfall: (number) | null;
948
+ windDirection: (number) | null;
949
+ windSpeed: (number) | null;
950
+ pressure: (number) | null;
951
+ weatherConditionCode: (number) | null;
952
+ weatherCondition: (string) | null;
953
+ };
954
+ export type TeamRecord = {
955
+ games: number;
956
+ wins: number;
957
+ losses: number;
958
+ ties: number;
959
+ };
960
+ export type TeamRecords = {
961
+ year: number;
962
+ teamId: number;
963
+ team: string;
964
+ classification: ((DivisionClassification) | null);
965
+ conference: string;
966
+ division: string;
967
+ expectedWins: number;
968
+ total: TeamRecord;
969
+ conferenceGames: TeamRecord;
970
+ homeGames: TeamRecord;
971
+ awayGames: TeamRecord;
972
+ neutralSiteGames: TeamRecord;
973
+ };
974
+ export type CalendarWeek = {
975
+ season: number;
976
+ week: number;
977
+ seasonType: SeasonType;
978
+ firstGameStart: string;
979
+ lastGameStart: string;
980
+ };
981
+ export type GameStatus = 'scheduled' | 'in_progress' | 'completed';
982
+ export type ScoreboardGame = {
983
+ id: number;
984
+ startDate: string;
985
+ startTimeTBD: boolean;
986
+ tv: (string) | null;
987
+ neutralSite: boolean;
988
+ conferenceGame: boolean;
989
+ status: GameStatus;
990
+ period: (number) | null;
991
+ clock: (string) | null;
992
+ situation: (string) | null;
993
+ possession: (string) | null;
994
+ venue: {
995
+ state: (string) | null;
996
+ city: (string) | null;
997
+ name: string;
998
+ };
999
+ homeTeam: {
1000
+ points: (number) | null;
1001
+ classification: ((DivisionClassification) | null);
1002
+ conference: (string) | null;
1003
+ name: string;
1004
+ id: number;
1005
+ };
1006
+ awayTeam: {
1007
+ points: (number) | null;
1008
+ classification: ((DivisionClassification) | null);
1009
+ conference: (string) | null;
1010
+ name: string;
1011
+ id: number;
1012
+ };
1013
+ weather: {
1014
+ windDirection: (number) | null;
1015
+ windSpeed: (number) | null;
1016
+ description: (string) | null;
1017
+ temperature: (number) | null;
1018
+ };
1019
+ betting: {
1020
+ awayMoneyline: (number) | null;
1021
+ homeMoneyline: (number) | null;
1022
+ overUnder: (number) | null;
1023
+ spread: (number) | null;
1024
+ };
1025
+ };
1026
+ export type Drive = {
1027
+ offense: string;
1028
+ offenseConference: (string) | null;
1029
+ defense: string;
1030
+ defenseConference: (string) | null;
1031
+ gameId: number;
1032
+ id: string;
1033
+ driveNumber: (number) | null;
1034
+ scoring: boolean;
1035
+ startPeriod: number;
1036
+ startYardline: number;
1037
+ startYardsToGoal: number;
1038
+ startTime: {
1039
+ seconds: (number) | null;
1040
+ minutes: (number) | null;
1041
+ };
1042
+ endPeriod: number;
1043
+ endYardline: number;
1044
+ endYardsToGoal: number;
1045
+ endTime: {
1046
+ seconds: (number) | null;
1047
+ minutes: (number) | null;
1048
+ };
1049
+ plays: number;
1050
+ yards: number;
1051
+ driveResult: string;
1052
+ isHomeOffense: boolean;
1053
+ startOffenseScore: number;
1054
+ startDefenseScore: number;
1055
+ endOffenseScore: number;
1056
+ endDefenseScore: number;
1057
+ };
1058
+ export type DraftTeam = {
1059
+ location: string;
1060
+ nickname: (string) | null;
1061
+ displayName: (string) | null;
1062
+ logo: (string) | null;
1063
+ };
1064
+ export type DraftPosition = {
1065
+ name: string;
1066
+ abbreviation: string;
1067
+ };
1068
+ export type DraftPick = {
1069
+ collegeAthleteId: (number) | null;
1070
+ nflAthleteId: number;
1071
+ collegeId: number;
1072
+ collegeTeam: string;
1073
+ collegeConference: (string) | null;
1074
+ nflTeamId: number;
1075
+ nflTeam: string;
1076
+ year: number;
1077
+ overall: number;
1078
+ round: number;
1079
+ pick: number;
1080
+ name: string;
1081
+ position: string;
1082
+ height: (number) | null;
1083
+ weight: (number) | null;
1084
+ preDraftRanking: (number) | null;
1085
+ preDraftPositionRanking: (number) | null;
1086
+ preDraftGrade: (number) | null;
1087
+ hometownInfo: {
1088
+ countyFips: (string) | null;
1089
+ longitude: (string) | null;
1090
+ latitude: (string) | null;
1091
+ country: (string) | null;
1092
+ state: (string) | null;
1093
+ city: (string) | null;
1094
+ };
1095
+ };
1096
+ export type CoachSeason = {
1097
+ school: string;
1098
+ year: number;
1099
+ games: number;
1100
+ wins: number;
1101
+ losses: number;
1102
+ ties: number;
1103
+ preseasonRank: (number) | null;
1104
+ postseasonRank: (number) | null;
1105
+ srs: (number) | null;
1106
+ spOverall: (number) | null;
1107
+ spOffense: (number) | null;
1108
+ spDefense: (number) | null;
1109
+ };
1110
+ export type Coach = {
1111
+ firstName: string;
1112
+ lastName: string;
1113
+ hireDate: (string) | null;
1114
+ seasons: Array<CoachSeason>;
1115
+ };
1116
+ export type StatsByQuarter = {
1117
+ total: number;
1118
+ quarter1: number;
1119
+ quarter2: number;
1120
+ quarter3: number;
1121
+ quarter4: number;
1122
+ };
1123
+ export type TeamPPA = {
1124
+ team: string;
1125
+ plays: number;
1126
+ overall: StatsByQuarter;
1127
+ passing: StatsByQuarter;
1128
+ rushing: StatsByQuarter;
1129
+ };
1130
+ export type TeamSuccessRates = {
1131
+ team: string;
1132
+ overall: StatsByQuarter;
1133
+ standardDowns: StatsByQuarter;
1134
+ passingDowns: StatsByQuarter;
1135
+ };
1136
+ export type TeamExplosiveness = {
1137
+ team: string;
1138
+ overall: StatsByQuarter;
1139
+ };
1140
+ export type TeamRushingStats = {
1141
+ team: string;
1142
+ powerSuccess: number;
1143
+ stuffRate: number;
1144
+ lineYards: number;
1145
+ lineYardsAverage: number;
1146
+ secondLevelYards: number;
1147
+ secondLevelYardsAverage: number;
1148
+ openFieldYards: number;
1149
+ openFieldYardsAverage: number;
1150
+ };
1151
+ export type TeamHavoc = {
1152
+ team: string;
1153
+ total: number;
1154
+ frontSeven: number;
1155
+ db: number;
1156
+ };
1157
+ export type TeamScoringOpportunities = {
1158
+ team: string;
1159
+ opportunities: number;
1160
+ points: number;
1161
+ pointsPerOpportunity: number;
1162
+ };
1163
+ export type TeamFieldPosition = {
1164
+ team: string;
1165
+ averageStart: number;
1166
+ averageStartingPredictedPoints: number;
1167
+ };
1168
+ export type PlayerGameUsage = {
1169
+ total: number;
1170
+ quarter1: number;
1171
+ quarter2: number;
1172
+ quarter3: number;
1173
+ quarter4: number;
1174
+ rushing: number;
1175
+ passing: number;
1176
+ player: string;
1177
+ team: string;
1178
+ position: string;
1179
+ };
1180
+ export type PlayerStatsByQuarter = {
1181
+ total: number;
1182
+ quarter1: number;
1183
+ quarter2: number;
1184
+ quarter3: number;
1185
+ quarter4: number;
1186
+ rushing: number;
1187
+ passing: number;
1188
+ };
1189
+ export type PlayerPPA = {
1190
+ player: string;
1191
+ team: string;
1192
+ position: string;
1193
+ average: PlayerStatsByQuarter;
1194
+ cumulative: PlayerStatsByQuarter;
1195
+ };
1196
+ export type AdvancedBoxScore = {
1197
+ gameInfo: {
1198
+ excitement: number;
1199
+ homeWinner: boolean;
1200
+ awayWinProb: number;
1201
+ awayPoints: number;
1202
+ awayTeam: string;
1203
+ homeWinProb: number;
1204
+ homePoints: number;
1205
+ homeTeam: string;
1206
+ };
1207
+ teams: {
1208
+ fieldPosition: Array<TeamFieldPosition>;
1209
+ scoringOpportunities: Array<TeamScoringOpportunities>;
1210
+ havoc: Array<TeamHavoc>;
1211
+ rushing: Array<TeamRushingStats>;
1212
+ explosiveness: Array<TeamExplosiveness>;
1213
+ successRates: Array<TeamSuccessRates>;
1214
+ cumulativePpa: Array<TeamPPA>;
1215
+ ppa: Array<TeamPPA>;
1216
+ };
1217
+ players: {
1218
+ ppa: Array<PlayerPPA>;
1219
+ usage: Array<PlayerGameUsage>;
1220
+ };
1221
+ };
1222
+ export type GetTeamsData = {
1223
+ query?: {
1224
+ /**
1225
+ * Optional conference abbreviation filter
1226
+ */
1227
+ conference?: string;
1228
+ /**
1229
+ * Optional year filter to get historical conference affiliations
1230
+ */
1231
+ year?: number;
1232
+ };
1233
+ };
1234
+ export type GetTeamsResponse = (Array<Team>);
1235
+ export type GetTeamsError = unknown;
1236
+ export type GetFbsTeamsData = {
1237
+ query?: {
1238
+ /**
1239
+ * Year or season
1240
+ */
1241
+ year?: number;
1242
+ };
1243
+ };
1244
+ export type GetFbsTeamsResponse = (Array<Team>);
1245
+ export type GetFbsTeamsError = unknown;
1246
+ export type GetMatchupData = {
1247
+ query: {
1248
+ /**
1249
+ * Optional ending year
1250
+ */
1251
+ maxYear?: number;
1252
+ /**
1253
+ * Optional starting year
1254
+ */
1255
+ minYear?: number;
1256
+ /**
1257
+ * First team to compare
1258
+ */
1259
+ team1: string;
1260
+ /**
1261
+ * Second team to compare
1262
+ */
1263
+ team2: string;
1264
+ };
1265
+ };
1266
+ export type GetMatchupResponse = (Matchup);
1267
+ export type GetMatchupError = unknown;
1268
+ export type GetRosterData = {
1269
+ query?: {
1270
+ /**
1271
+ * Optional team filter
1272
+ */
1273
+ team?: string;
1274
+ /**
1275
+ * Optional year filter, defaults to 2023
1276
+ */
1277
+ year?: number;
1278
+ };
1279
+ };
1280
+ export type GetRosterResponse = (Array<RosterPlayer>);
1281
+ export type GetRosterError = unknown;
1282
+ export type GetConferencesResponse = (Array<Conference>);
1283
+ export type GetConferencesError = unknown;
1284
+ export type GetTalentData = {
1285
+ query: {
1286
+ /**
1287
+ * Year filter
1288
+ */
1289
+ year: number;
1290
+ };
1291
+ };
1292
+ export type GetTalentResponse = (Array<TeamTalent>);
1293
+ export type GetTalentError = unknown;
1294
+ export type GetVenuesResponse = (Array<Venue>);
1295
+ export type GetVenuesError = unknown;
1296
+ export type GetPlayerSeasonStatsData = {
1297
+ query: {
1298
+ /**
1299
+ * Optional category filter
1300
+ */
1301
+ category?: string;
1302
+ /**
1303
+ * Optional conference filter
1304
+ */
1305
+ conference?: string;
1306
+ /**
1307
+ * Optional ending week range
1308
+ */
1309
+ endWeek?: number;
1310
+ /**
1311
+ * Optional season type filter
1312
+ */
1313
+ seasonType?: SeasonType;
1314
+ /**
1315
+ * Optional starting week range
1316
+ */
1317
+ startWeek?: number;
1318
+ /**
1319
+ * Optional team filter
1320
+ */
1321
+ team?: string;
1322
+ /**
1323
+ * Required year filter
1324
+ */
1325
+ year: number;
1326
+ };
1327
+ };
1328
+ export type GetPlayerSeasonStatsResponse = (Array<PlayerStat>);
1329
+ export type GetPlayerSeasonStatsError = unknown;
1330
+ export type GetTeamStatsData = {
1331
+ query?: {
1332
+ /**
1333
+ * Optional conference filter
1334
+ */
1335
+ conference?: string;
1336
+ /**
1337
+ * Optional week end range filter
1338
+ */
1339
+ endWeek?: number;
1340
+ /**
1341
+ * Optional week start range filter
1342
+ */
1343
+ startWeek?: number;
1344
+ /**
1345
+ * Team filter, required if year not specified
1346
+ */
1347
+ team?: string;
1348
+ /**
1349
+ * Year filter, required if team not specified
1350
+ */
1351
+ year?: number;
1352
+ };
1353
+ };
1354
+ export type GetTeamStatsResponse = (Array<TeamStat>);
1355
+ export type GetTeamStatsError = unknown;
1356
+ export type GetCategoriesResponse = (Array<(string)>);
1357
+ export type GetCategoriesError = unknown;
1358
+ export type GetAdvancedSeasonStatsData = {
1359
+ query?: {
1360
+ /**
1361
+ * Optional end week range filter
1362
+ */
1363
+ endWeek?: number;
1364
+ /**
1365
+ * Garbage time exclusion filter, defaults to false
1366
+ */
1367
+ excludeGarbageTime?: boolean;
1368
+ /**
1369
+ * Optional start week range filter
1370
+ */
1371
+ startWeek?: number;
1372
+ /**
1373
+ * Team filter, required if year not specified
1374
+ */
1375
+ team?: string;
1376
+ /**
1377
+ * Year filter, required if team not specified
1378
+ */
1379
+ year?: number;
1380
+ };
1381
+ };
1382
+ export type GetAdvancedSeasonStatsResponse = (Array<AdvancedSeasonStat>);
1383
+ export type GetAdvancedSeasonStatsError = unknown;
1384
+ export type GetAdvancedGameStatsData = {
1385
+ query?: {
1386
+ /**
1387
+ * Garbage time exclusion filter, defaults to false
1388
+ */
1389
+ excludeGarbageTime?: boolean;
1390
+ /**
1391
+ * Optional opponent filter
1392
+ */
1393
+ opponent?: string;
1394
+ /**
1395
+ * Optional season type filter
1396
+ */
1397
+ seasonType?: SeasonType;
1398
+ /**
1399
+ * Team filter, required if year not specified
1400
+ */
1401
+ team?: string;
1402
+ /**
1403
+ * Optional week filter
1404
+ */
1405
+ week?: number;
1406
+ /**
1407
+ * Year filter, required if team not specified
1408
+ */
1409
+ year?: number;
1410
+ };
1411
+ };
1412
+ export type GetAdvancedGameStatsResponse = (Array<AdvancedGameStat>);
1413
+ export type GetAdvancedGameStatsError = unknown;
1414
+ export type GetRecruitsData = {
1415
+ query?: {
1416
+ /**
1417
+ * Optional recruit type classification filter, defaults to HighSchool
1418
+ */
1419
+ classification?: RecruitClassification;
1420
+ /**
1421
+ * Optional position categorization filter
1422
+ */
1423
+ position?: string;
1424
+ /**
1425
+ * Optional state/province filter
1426
+ */
1427
+ state?: string;
1428
+ /**
1429
+ * Team filter, required when no team specified
1430
+ */
1431
+ team?: string;
1432
+ /**
1433
+ * Year filter, required when no team specified
1434
+ */
1435
+ year?: number;
1436
+ };
1437
+ };
1438
+ export type GetRecruitsResponse = (Array<Recruit>);
1439
+ export type GetRecruitsError = unknown;
1440
+ export type GetTeamRecruitingRankingsData = {
1441
+ query?: {
1442
+ /**
1443
+ * Optional team filter
1444
+ */
1445
+ team?: string;
1446
+ /**
1447
+ * Optional year filter
1448
+ */
1449
+ year?: number;
1450
+ };
1451
+ };
1452
+ export type GetTeamRecruitingRankingsResponse = (Array<TeamRecruitingRanking>);
1453
+ export type GetTeamRecruitingRankingsError = unknown;
1454
+ export type GetAggregatedTeamRecruitingRatingsData = {
1455
+ query?: {
1456
+ /**
1457
+ * Optional conference filter
1458
+ */
1459
+ conference?: string;
1460
+ /**
1461
+ * Optional end year range, defaults to current year
1462
+ */
1463
+ endYear?: number;
1464
+ /**
1465
+ * Optional recruit type filter, defaults to HighSchool
1466
+ */
1467
+ recruitType?: RecruitClassification;
1468
+ /**
1469
+ * Optional start year range, defaults to 2000
1470
+ */
1471
+ startYear?: number;
1472
+ /**
1473
+ * Optional team filter
1474
+ */
1475
+ team?: string;
1476
+ };
1477
+ };
1478
+ export type GetAggregatedTeamRecruitingRatingsResponse = (Array<AggregatedTeamRecruiting>);
1479
+ export type GetAggregatedTeamRecruitingRatingsError = unknown;
1480
+ export type GetSpData = {
1481
+ query?: {
1482
+ /**
1483
+ * Team filter, required if year not specified
1484
+ */
1485
+ team?: string;
1486
+ /**
1487
+ * Year filter, required if team not specified
1488
+ */
1489
+ year?: number;
1490
+ };
1491
+ };
1492
+ export type GetSpResponse = (Array<TeamSP>);
1493
+ export type GetSpError = unknown;
1494
+ export type GetConferenceSpData = {
1495
+ query?: {
1496
+ /**
1497
+ * Optional conference filter
1498
+ */
1499
+ conference?: string;
1500
+ /**
1501
+ * Optional year filter
1502
+ */
1503
+ year?: number;
1504
+ };
1505
+ };
1506
+ export type GetConferenceSpResponse = (Array<ConferenceSP>);
1507
+ export type GetConferenceSpError = unknown;
1508
+ export type GetSrsData = {
1509
+ query?: {
1510
+ /**
1511
+ * Optional conference filter
1512
+ */
1513
+ conference?: string;
1514
+ /**
1515
+ * Team filter, required if year not specified
1516
+ */
1517
+ team?: string;
1518
+ /**
1519
+ * Year filter, required if team not specified
1520
+ */
1521
+ year?: number;
1522
+ };
1523
+ };
1524
+ export type GetSrsResponse = (Array<TeamSRS>);
1525
+ export type GetSrsError = unknown;
1526
+ export type GetEloData = {
1527
+ query?: {
1528
+ /**
1529
+ * Optional conference filter
1530
+ */
1531
+ conference?: string;
1532
+ /**
1533
+ * Optional season type filter
1534
+ */
1535
+ seasonType?: SeasonType;
1536
+ /**
1537
+ * Optional team filter
1538
+ */
1539
+ team?: string;
1540
+ /**
1541
+ * Optional week filter, defaults to last available week in the season
1542
+ */
1543
+ week?: number;
1544
+ /**
1545
+ * Optional year filter
1546
+ */
1547
+ year?: number;
1548
+ };
1549
+ };
1550
+ export type GetEloResponse = (Array<TeamElo>);
1551
+ export type GetEloError = unknown;
1552
+ export type GetFpiData = {
1553
+ query?: {
1554
+ /**
1555
+ * Optional conference filter
1556
+ */
1557
+ conference?: string;
1558
+ /**
1559
+ * team filter, required if year not specified
1560
+ */
1561
+ team?: string;
1562
+ /**
1563
+ * year filter, required if team not specified
1564
+ */
1565
+ year?: number;
1566
+ };
1567
+ };
1568
+ export type GetFpiResponse = (Array<TeamFPI>);
1569
+ export type GetFpiError = unknown;
1570
+ export type GetRankingsData = {
1571
+ query: {
1572
+ /**
1573
+ * Optional season type filter
1574
+ */
1575
+ seasonType?: SeasonType;
1576
+ /**
1577
+ * Optional week filter
1578
+ */
1579
+ week?: number;
1580
+ /**
1581
+ * Required year filter
1582
+ */
1583
+ year: number;
1584
+ };
1585
+ };
1586
+ export type GetRankingsResponse = (Array<PollWeek>);
1587
+ export type GetRankingsError = unknown;
1588
+ export type GetPlaysData = {
1589
+ query: {
1590
+ /**
1591
+ * Optional division classification filter
1592
+ */
1593
+ classification?: DivisionClassification;
1594
+ /**
1595
+ * Optional conference filter
1596
+ */
1597
+ conference?: string;
1598
+ /**
1599
+ * Optional defensive team filter
1600
+ */
1601
+ defense?: string;
1602
+ /**
1603
+ * Optional defensive conference filter
1604
+ */
1605
+ defenseConference?: string;
1606
+ /**
1607
+ * Optional offensive team filter
1608
+ */
1609
+ offense?: string;
1610
+ /**
1611
+ * Optional offensive conference filter
1612
+ */
1613
+ offenseConference?: string;
1614
+ /**
1615
+ * Optoinal play type abbreviation filter
1616
+ */
1617
+ playType?: string;
1618
+ /**
1619
+ * Optional season type filter
1620
+ */
1621
+ seasonType?: SeasonType;
1622
+ /**
1623
+ * Optional team filter
1624
+ */
1625
+ team?: string;
1626
+ /**
1627
+ * Required week filter
1628
+ */
1629
+ week: number;
1630
+ /**
1631
+ * Required year filter
1632
+ */
1633
+ year: number;
1634
+ };
1635
+ };
1636
+ export type GetPlaysResponse = (Array<Play>);
1637
+ export type GetPlaysError = unknown;
1638
+ export type GetPlayTypesResponse = (Array<PlayType>);
1639
+ export type GetPlayTypesError = unknown;
1640
+ export type GetPlayStatsData = {
1641
+ query?: {
1642
+ /**
1643
+ * Optional athleteId filter
1644
+ */
1645
+ athleteId?: number;
1646
+ /**
1647
+ * Optional conference filter
1648
+ */
1649
+ conference?: string;
1650
+ /**
1651
+ * Optional gameId filter
1652
+ */
1653
+ gameId?: number;
1654
+ /**
1655
+ * Optional season type filter
1656
+ */
1657
+ seasonType?: SeasonType;
1658
+ /**
1659
+ * Optional statTypeId filter
1660
+ */
1661
+ statTypeId?: number;
1662
+ /**
1663
+ * Optional team filter
1664
+ */
1665
+ team?: string;
1666
+ /**
1667
+ * Optional week filter
1668
+ */
1669
+ week?: number;
1670
+ /**
1671
+ * Optional year filter
1672
+ */
1673
+ year?: number;
1674
+ };
1675
+ };
1676
+ export type GetPlayStatsResponse = (Array<PlayStat>);
1677
+ export type GetPlayStatsError = unknown;
1678
+ export type GetPlayStatTypesResponse = (Array<PlayStatType>);
1679
+ export type GetPlayStatTypesError = unknown;
1680
+ export type SearchPlayersData = {
1681
+ query: {
1682
+ /**
1683
+ * Optional position abbreviation filter
1684
+ */
1685
+ position?: string;
1686
+ /**
1687
+ * Search term for matching player name
1688
+ */
1689
+ searchTerm: string;
1690
+ /**
1691
+ * Optional team filter
1692
+ */
1693
+ team?: string;
1694
+ /**
1695
+ * Optional year filter
1696
+ */
1697
+ year?: number;
1698
+ };
1699
+ };
1700
+ export type SearchPlayersResponse = (Array<PlayerSearchResult>);
1701
+ export type SearchPlayersError = unknown;
1702
+ export type GetPlayerUsageData = {
1703
+ query: {
1704
+ /**
1705
+ * Optional conference abbreviation filter
1706
+ */
1707
+ conference?: string;
1708
+ /**
1709
+ * Optional exclude garbage time flag, defaults to false
1710
+ */
1711
+ excludeGarbageTime?: boolean;
1712
+ /**
1713
+ * Optional player id filter
1714
+ */
1715
+ playerId?: number;
1716
+ /**
1717
+ * Optional position abbreivation filter
1718
+ */
1719
+ position?: string;
1720
+ /**
1721
+ * Optional team filter
1722
+ */
1723
+ team?: string;
1724
+ /**
1725
+ * Required year filter
1726
+ */
1727
+ year: number;
1728
+ };
1729
+ };
1730
+ export type GetPlayerUsageResponse = (Array<PlayerUsage>);
1731
+ export type GetPlayerUsageError = unknown;
1732
+ export type GetReturningProductionData = {
1733
+ query?: {
1734
+ /**
1735
+ * Optional conference filter
1736
+ */
1737
+ conference?: string;
1738
+ /**
1739
+ * Team filter, required if year not specified
1740
+ */
1741
+ team?: string;
1742
+ /**
1743
+ * Year filter, required if team not specified
1744
+ */
1745
+ year?: number;
1746
+ };
1747
+ };
1748
+ export type GetReturningProductionResponse = (Array<ReturningProduction>);
1749
+ export type GetReturningProductionError = unknown;
1750
+ export type GetTransferPortalData = {
1751
+ query: {
1752
+ /**
1753
+ * Required year filter
1754
+ */
1755
+ year: number;
1756
+ };
1757
+ };
1758
+ export type GetTransferPortalResponse = (Array<PlayerTransfer>);
1759
+ export type GetTransferPortalError = unknown;
1760
+ export type GetPredictedPointsData = {
1761
+ query: {
1762
+ /**
1763
+ * Distance value
1764
+ */
1765
+ distance: number;
1766
+ /**
1767
+ * Down value
1768
+ */
1769
+ down: number;
1770
+ };
1771
+ };
1772
+ export type GetPredictedPointsResponse = (Array<PredictedPointsValue>);
1773
+ export type GetPredictedPointsError = unknown;
1774
+ export type GetPredictedPointsAddedByTeamData = {
1775
+ query?: {
1776
+ /**
1777
+ * Conference abbreviation filter
1778
+ */
1779
+ conference?: string;
1780
+ /**
1781
+ * Exclude garbage time plays
1782
+ */
1783
+ excludeGarbageTime?: boolean;
1784
+ /**
1785
+ * Team filter, required if year not specified
1786
+ */
1787
+ team?: string;
1788
+ /**
1789
+ * Year filter, required if team not specified
1790
+ */
1791
+ year?: number;
1792
+ };
1793
+ };
1794
+ export type GetPredictedPointsAddedByTeamResponse = (Array<TeamSeasonPredictedPointsAdded>);
1795
+ export type GetPredictedPointsAddedByTeamError = unknown;
1796
+ export type GetPredictedPointsAddedByGameData = {
1797
+ query: {
1798
+ /**
1799
+ * Optional conference abbreviation filter
1800
+ */
1801
+ conference?: string;
1802
+ /**
1803
+ * Optional flag to exclude garbage time plays
1804
+ */
1805
+ excludeGarbageTime?: boolean;
1806
+ /**
1807
+ * Optional season type filter
1808
+ */
1809
+ seasonType?: SeasonType;
1810
+ /**
1811
+ * Optional team filter
1812
+ */
1813
+ team?: string;
1814
+ /**
1815
+ * Optional week filter
1816
+ */
1817
+ week?: number;
1818
+ /**
1819
+ * Required year filter
1820
+ */
1821
+ year: number;
1822
+ };
1823
+ };
1824
+ export type GetPredictedPointsAddedByGameResponse = (Array<TeamGamePredictedPointsAdded>);
1825
+ export type GetPredictedPointsAddedByGameError = unknown;
1826
+ export type GetPredictedPointsAddedByPlayerGameData = {
1827
+ query: {
1828
+ /**
1829
+ * Optional flag to exclude garbage time plays
1830
+ */
1831
+ excludeGarbageTime?: boolean;
1832
+ /**
1833
+ * Optional player ID filter
1834
+ */
1835
+ playerId?: string;
1836
+ /**
1837
+ * Optional player position abbreviation filter
1838
+ */
1839
+ position?: string;
1840
+ /**
1841
+ * Optional season type filter
1842
+ */
1843
+ seasonType?: SeasonType;
1844
+ /**
1845
+ * Team filter, required if week not specified
1846
+ */
1847
+ team?: string;
1848
+ /**
1849
+ * Threshold value for minimum number of plays
1850
+ */
1851
+ threshold?: number;
1852
+ /**
1853
+ * Week filter, required if team not specified
1854
+ */
1855
+ week?: number;
1856
+ /**
1857
+ * Required year filter
1858
+ */
1859
+ year: number;
1860
+ };
1861
+ };
1862
+ export type GetPredictedPointsAddedByPlayerGameResponse = (Array<PlayerGamePredictedPointsAdded>);
1863
+ export type GetPredictedPointsAddedByPlayerGameError = unknown;
1864
+ export type GetPredictedPointsAddedByPlayerSeasonData = {
1865
+ query?: {
1866
+ /**
1867
+ * Optional conference abbreviation filter
1868
+ */
1869
+ conference?: string;
1870
+ /**
1871
+ * Optional flag to exclude garbage time plays
1872
+ */
1873
+ excludeGarbageTime?: boolean;
1874
+ /**
1875
+ * Player ID filter, required if year not specified
1876
+ */
1877
+ playerId?: string;
1878
+ /**
1879
+ * Optional position abbreviation filter
1880
+ */
1881
+ position?: string;
1882
+ /**
1883
+ * Optional team filter
1884
+ */
1885
+ team?: string;
1886
+ /**
1887
+ * Threshold value for minimum number of plays
1888
+ */
1889
+ threshold?: number;
1890
+ /**
1891
+ * Year filter, required if playerId not specified
1892
+ */
1893
+ year?: number;
1894
+ };
1895
+ };
1896
+ export type GetPredictedPointsAddedByPlayerSeasonResponse = (Array<PlayerSeasonPredictedPointsAdded>);
1897
+ export type GetPredictedPointsAddedByPlayerSeasonError = unknown;
1898
+ export type GetWinProbabilityData = {
1899
+ query: {
1900
+ /**
1901
+ * Required game ID filter
1902
+ */
1903
+ gameId: number;
1904
+ };
1905
+ };
1906
+ export type GetWinProbabilityResponse = (Array<PlayWinProbability>);
1907
+ export type GetWinProbabilityError = unknown;
1908
+ export type GetPregameWinProbabilitiesData = {
1909
+ query?: {
1910
+ /**
1911
+ * Optional season type filter
1912
+ */
1913
+ seasonType?: SeasonType;
1914
+ /**
1915
+ * Optional team filter
1916
+ */
1917
+ team?: string;
1918
+ /**
1919
+ * Optional week filter
1920
+ */
1921
+ week?: number;
1922
+ /**
1923
+ * Optional year filter
1924
+ */
1925
+ year?: number;
1926
+ };
1927
+ };
1928
+ export type GetPregameWinProbabilitiesResponse = (Array<PregameWinProbability>);
1929
+ export type GetPregameWinProbabilitiesError = unknown;
1930
+ export type GetFieldGoalExpectedPointsResponse = (Array<FieldGoalEP>);
1931
+ export type GetFieldGoalExpectedPointsError = unknown;
1932
+ export type GetLivePlaysData = {
1933
+ query: {
1934
+ /**
1935
+ * Game Id filter
1936
+ */
1937
+ gameId: number;
1938
+ };
1939
+ };
1940
+ export type GetLivePlaysResponse = (LiveGame);
1941
+ export type GetLivePlaysError = unknown;
1942
+ export type GetLinesData = {
1943
+ query?: {
1944
+ /**
1945
+ * Optional away team filter
1946
+ */
1947
+ away?: string;
1948
+ /**
1949
+ * Optional conference filter
1950
+ */
1951
+ conference?: string;
1952
+ /**
1953
+ * Optional gameId filter
1954
+ */
1955
+ gameId?: number;
1956
+ /**
1957
+ * Optional home team filter
1958
+ */
1959
+ home?: string;
1960
+ /**
1961
+ * Optional provider name filter
1962
+ */
1963
+ provider?: string;
1964
+ /**
1965
+ * Optional season type filter
1966
+ */
1967
+ seasonType?: SeasonType;
1968
+ /**
1969
+ * Optional team filter
1970
+ */
1971
+ team?: string;
1972
+ /**
1973
+ * Optional week filter
1974
+ */
1975
+ week?: number;
1976
+ /**
1977
+ * Year filter, required if game id not specified
1978
+ */
1979
+ year?: number;
1980
+ };
1981
+ };
1982
+ export type GetLinesResponse = (Array<BettingGame>);
1983
+ export type GetLinesError = unknown;
1984
+ export type GetGamesData = {
1985
+ query?: {
1986
+ /**
1987
+ * Optional away team filter
1988
+ */
1989
+ away?: string;
1990
+ /**
1991
+ * Optional division classification filter
1992
+ */
1993
+ classification?: DivisionClassification;
1994
+ /**
1995
+ * Optional conference filter
1996
+ */
1997
+ conference?: string;
1998
+ /**
1999
+ * Optional home team filter
2000
+ */
2001
+ home?: string;
2002
+ /**
2003
+ * Game id filter to retrieve a single game
2004
+ */
2005
+ id?: number;
2006
+ /**
2007
+ * Optional season type filter
2008
+ */
2009
+ seasonType?: SeasonType;
2010
+ /**
2011
+ * Optional team filter
2012
+ */
2013
+ team?: string;
2014
+ /**
2015
+ * Optional week filter
2016
+ */
2017
+ week?: number;
2018
+ /**
2019
+ * Required year filter (except when id is specified)
2020
+ */
2021
+ year?: number;
2022
+ };
2023
+ };
2024
+ export type GetGamesResponse = (Array<Game>);
2025
+ export type GetGamesError = unknown;
2026
+ export type GetGameTeamStatsData = {
2027
+ query?: {
2028
+ /**
2029
+ * Optional division classification filter
2030
+ */
2031
+ classification?: DivisionClassification;
2032
+ /**
2033
+ * Optional conference filter, required if week and team not specified
2034
+ */
2035
+ conference?: string;
2036
+ /**
2037
+ * Optional id filter to retrieve a single game
2038
+ */
2039
+ id?: number;
2040
+ /**
2041
+ * Optional season type filter
2042
+ */
2043
+ seasonType?: SeasonType;
2044
+ /**
2045
+ * Optional team filter, required if week and conference not specified
2046
+ */
2047
+ team?: string;
2048
+ /**
2049
+ * Optional week filter, required if team and conference not specified
2050
+ */
2051
+ week?: number;
2052
+ /**
2053
+ * Required year filter (along with one of week, team, or conference), unless id is specified
2054
+ */
2055
+ year?: number;
2056
+ };
2057
+ };
2058
+ export type GetGameTeamStatsResponse = (Array<GameTeamStats>);
2059
+ export type GetGameTeamStatsError = unknown;
2060
+ export type GetGamePlayerStatsData = {
2061
+ query?: {
2062
+ /**
2063
+ * Optional player statistical category filter
2064
+ */
2065
+ category?: string;
2066
+ /**
2067
+ * Optional division classification filter
2068
+ */
2069
+ classification?: DivisionClassification;
2070
+ /**
2071
+ * Optional conference filter, required if week and team not specified
2072
+ */
2073
+ conference?: string;
2074
+ /**
2075
+ * Optional id filter to retrieve a single game
2076
+ */
2077
+ id?: number;
2078
+ /**
2079
+ * Optional season type filter
2080
+ */
2081
+ seasonType?: SeasonType;
2082
+ /**
2083
+ * Optional team filter, required if week and conference not specified
2084
+ */
2085
+ team?: string;
2086
+ /**
2087
+ * Optional week filter, required if team and conference not specified
2088
+ */
2089
+ week?: number;
2090
+ /**
2091
+ * Required year filter (along with one of week, team, or conference), unless id is specified
2092
+ */
2093
+ year?: number;
2094
+ };
2095
+ };
2096
+ export type GetGamePlayerStatsResponse = (Array<GamePlayerStats>);
2097
+ export type GetGamePlayerStatsError = unknown;
2098
+ export type GetMediaData = {
2099
+ query: {
2100
+ /**
2101
+ * Optional division classification filter
2102
+ */
2103
+ classification?: DivisionClassification;
2104
+ /**
2105
+ * Optional conference filter
2106
+ */
2107
+ conference?: string;
2108
+ /**
2109
+ * Optional media type filter
2110
+ */
2111
+ mediaType?: MediaType;
2112
+ /**
2113
+ * Optional season type filter
2114
+ */
2115
+ seasonType?: SeasonType;
2116
+ /**
2117
+ * Optional team filter
2118
+ */
2119
+ team?: string;
2120
+ /**
2121
+ * Optional week filter
2122
+ */
2123
+ week?: number;
2124
+ /**
2125
+ * Required year filter
2126
+ */
2127
+ year: number;
2128
+ };
2129
+ };
2130
+ export type GetMediaResponse = (Array<GameMedia>);
2131
+ export type GetMediaError = unknown;
2132
+ export type GetWeatherData = {
2133
+ query?: {
2134
+ /**
2135
+ * Optional division classification filter
2136
+ */
2137
+ classification?: DivisionClassification;
2138
+ /**
2139
+ * Optional conference filter
2140
+ */
2141
+ conference?: string;
2142
+ /**
2143
+ * Filter for retrieving a single game
2144
+ */
2145
+ gameId?: number;
2146
+ /**
2147
+ * Optional season type filter
2148
+ */
2149
+ seasonType?: SeasonType;
2150
+ /**
2151
+ * Optional team filter
2152
+ */
2153
+ team?: string;
2154
+ /**
2155
+ * Optional week filter
2156
+ */
2157
+ week?: number;
2158
+ /**
2159
+ * Year filter, required if game id not specified
2160
+ */
2161
+ year?: number;
2162
+ };
2163
+ };
2164
+ export type GetWeatherResponse = (Array<GameWeather>);
2165
+ export type GetWeatherError = unknown;
2166
+ export type GetRecordsData = {
2167
+ query?: {
2168
+ /**
2169
+ * Optional conference filter
2170
+ */
2171
+ conference?: string;
2172
+ /**
2173
+ * Team filter, required if year not specified
2174
+ */
2175
+ team?: string;
2176
+ /**
2177
+ * Year filter, required if team not specified
2178
+ */
2179
+ year?: number;
2180
+ };
2181
+ };
2182
+ export type GetRecordsResponse = (Array<TeamRecords>);
2183
+ export type GetRecordsError = unknown;
2184
+ export type GetCalendarData = {
2185
+ query: {
2186
+ /**
2187
+ * Required year filter
2188
+ */
2189
+ year: number;
2190
+ };
2191
+ };
2192
+ export type GetCalendarResponse = (Array<CalendarWeek>);
2193
+ export type GetCalendarError = unknown;
2194
+ export type GetScoreboardData = {
2195
+ query?: {
2196
+ /**
2197
+ * Optional division classification filter, defaults to fbs
2198
+ */
2199
+ classification?: DivisionClassification;
2200
+ /**
2201
+ * Optional conference filter
2202
+ */
2203
+ conference?: string;
2204
+ };
2205
+ };
2206
+ export type GetScoreboardResponse = (Array<ScoreboardGame>);
2207
+ export type GetScoreboardError = unknown;
2208
+ export type GetDrivesData = {
2209
+ query: {
2210
+ /**
2211
+ * Optional division classification filter
2212
+ */
2213
+ classification?: DivisionClassification;
2214
+ /**
2215
+ * Optional conference filter
2216
+ */
2217
+ conference?: string;
2218
+ /**
2219
+ * Optional defensive team filter
2220
+ */
2221
+ defense?: string;
2222
+ /**
2223
+ * Optional defensive team conference filter
2224
+ */
2225
+ defenseConference?: string;
2226
+ /**
2227
+ * Optional offensive team filter
2228
+ */
2229
+ offense?: string;
2230
+ /**
2231
+ * Optional offensive team conference filter
2232
+ */
2233
+ offenseConference?: string;
2234
+ /**
2235
+ * Optional season type filter
2236
+ */
2237
+ seasonType?: SeasonType;
2238
+ /**
2239
+ * Optional team filter
2240
+ */
2241
+ team?: string;
2242
+ /**
2243
+ * Optional week filter
2244
+ */
2245
+ week?: number;
2246
+ /**
2247
+ * Required year filter
2248
+ */
2249
+ year: number;
2250
+ };
2251
+ };
2252
+ export type GetDrivesResponse = (Array<Drive>);
2253
+ export type GetDrivesError = unknown;
2254
+ export type GetDraftTeamsResponse = (Array<DraftTeam>);
2255
+ export type GetDraftTeamsError = unknown;
2256
+ export type GetDraftPositionsResponse = (Array<DraftPosition>);
2257
+ export type GetDraftPositionsError = unknown;
2258
+ export type GetDraftPicksData = {
2259
+ query?: {
2260
+ /**
2261
+ * Optional college conference filter
2262
+ */
2263
+ conference?: string;
2264
+ /**
2265
+ * Optional position classification filter
2266
+ */
2267
+ position?: string;
2268
+ /**
2269
+ * Optional college team filter
2270
+ */
2271
+ school?: string;
2272
+ /**
2273
+ * Optional NFL team filter
2274
+ */
2275
+ team?: string;
2276
+ /**
2277
+ * Optional year filter
2278
+ */
2279
+ year?: number;
2280
+ };
2281
+ };
2282
+ export type GetDraftPicksResponse = (Array<DraftPick>);
2283
+ export type GetDraftPicksError = unknown;
2284
+ export type GetCoachesData = {
2285
+ query?: {
2286
+ /**
2287
+ * Optional first name filter
2288
+ */
2289
+ firstName?: string;
2290
+ /**
2291
+ * Optional last name filter
2292
+ */
2293
+ lastName?: string;
2294
+ /**
2295
+ * Optional end year range filter
2296
+ */
2297
+ maxYear?: number;
2298
+ /**
2299
+ * Optional start year range filter
2300
+ */
2301
+ minYear?: number;
2302
+ /**
2303
+ * Optional team filter
2304
+ */
2305
+ team?: string;
2306
+ /**
2307
+ * Optional year filter
2308
+ */
2309
+ year?: number;
2310
+ };
2311
+ };
2312
+ export type GetCoachesResponse = (Array<Coach>);
2313
+ export type GetCoachesError = unknown;
2314
+ export type GetAdvancedBoxScoreData = {
2315
+ query: {
2316
+ /**
2317
+ * Required game id filter
2318
+ */
2319
+ id: number;
2320
+ };
2321
+ };
2322
+ export type GetAdvancedBoxScoreResponse = (AdvancedBoxScore);
2323
+ export type GetAdvancedBoxScoreError = unknown;