cfb.js
Version:
This_is_an_API_for_accessing_all_sorts_of_college_football_data___Please_note_that_API_keys_should_be_supplied_with_Bearer__prepended__e_g__Bearer_your_key__API_keys_can_be_acquired_from_the_CollegeFootballData_com_website_
236 lines (169 loc) • 7.36 kB
Markdown
# cfb.StatsApi
All URIs are relative to *https://api.collegefootballdata.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getAdvancedTeamGameStats**](StatsApi.md#getAdvancedTeamGameStats) | **GET** /stats/game/advanced | Advanced team metrics by game
[**getAdvancedTeamSeasonStats**](StatsApi.md#getAdvancedTeamSeasonStats) | **GET** /stats/season/advanced | Advanced team metrics by season
[**getStatCategories**](StatsApi.md#getStatCategories) | **GET** /stats/categories | Team stat categories
[**getTeamSeasonStats**](StatsApi.md#getTeamSeasonStats) | **GET** /stats/season | Team statistics by season
<a name="getAdvancedTeamGameStats"></a>
# **getAdvancedTeamGameStats**
> [AdvancedGameStat] getAdvancedTeamGameStats(opts)
Advanced team metrics by game
Advanced team game stats
### Example
```javascript
var cfb = require('cfb.js');
var defaultClient = cfb.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
var apiInstance = new cfb.StatsApi();
var opts = {
'year': 56, // Number | Year filter (required if no team specified)
'week': 56, // Number | Week filter
'team': "team_example", // String | Team filter (required if no year specified)
'opponent': "opponent_example", // String | Opponent filter
'excludeGarbageTime': true, // Boolean | Filter to remove garbage time plays from calculations
'seasonType': "seasonType_example" // String | Season type filter (regular, postseason, or both)
};
apiInstance.getAdvancedTeamGameStats(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**year** | **Number**| Year filter (required if no team specified) | [optional]
**week** | **Number**| Week filter | [optional]
**team** | **String**| Team filter (required if no year specified) | [optional]
**opponent** | **String**| Opponent filter | [optional]
**excludeGarbageTime** | **Boolean**| Filter to remove garbage time plays from calculations | [optional]
**seasonType** | **String**| Season type filter (regular, postseason, or both) | [optional]
### Return type
[**[AdvancedGameStat]**](AdvancedGameStat.md)
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getAdvancedTeamSeasonStats"></a>
# **getAdvancedTeamSeasonStats**
> [AdvancedSeasonStat] getAdvancedTeamSeasonStats(opts)
Advanced team metrics by season
Advanced team season stats
### Example
```javascript
var cfb = require('cfb.js');
var defaultClient = cfb.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
var apiInstance = new cfb.StatsApi();
var opts = {
'year': 56, // Number | Year filter (required if no team specified)
'team': "team_example", // String | Team filter (required if no year specified)
'excludeGarbageTime': true, // Boolean | Filter to remove garbage time plays from calculations
'startWeek': 56, // Number | Starting week filter
'endWeek': 56 // Number | Starting week filter
};
apiInstance.getAdvancedTeamSeasonStats(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**year** | **Number**| Year filter (required if no team specified) | [optional]
**team** | **String**| Team filter (required if no year specified) | [optional]
**excludeGarbageTime** | **Boolean**| Filter to remove garbage time plays from calculations | [optional]
**startWeek** | **Number**| Starting week filter | [optional]
**endWeek** | **Number**| Starting week filter | [optional]
### Return type
[**[AdvancedSeasonStat]**](AdvancedSeasonStat.md)
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getStatCategories"></a>
# **getStatCategories**
> ['String'] getStatCategories()
Team stat categories
Stat category list
### Example
```javascript
var cfb = require('cfb.js');
var defaultClient = cfb.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
var apiInstance = new cfb.StatsApi();
apiInstance.getStatCategories().then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
**['String']**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getTeamSeasonStats"></a>
# **getTeamSeasonStats**
> [TeamSeasonStat] getTeamSeasonStats(opts)
Team statistics by season
Team season stats
### Example
```javascript
var cfb = require('cfb.js');
var defaultClient = cfb.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
var apiInstance = new cfb.StatsApi();
var opts = {
'year': 56, // Number | Year filter (required if no team specified)
'team': "team_example", // String | Team filter (required if no year specified)
'conference': "conference_example", // String | Conference abbreviation filter
'startWeek': 56, // Number | Starting week filter
'endWeek': 56 // Number | Starting week filter
};
apiInstance.getTeamSeasonStats(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**year** | **Number**| Year filter (required if no team specified) | [optional]
**team** | **String**| Team filter (required if no year specified) | [optional]
**conference** | **String**| Conference abbreviation filter | [optional]
**startWeek** | **Number**| Starting week filter | [optional]
**endWeek** | **Number**| Starting week filter | [optional]
### Return type
[**[TeamSeasonStat]**](TeamSeasonStat.md)
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json