Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 2.56 KB

DrivesApi.md

File metadata and controls

79 lines (58 loc) · 2.56 KB

cfb.DrivesApi

All URIs are relative to https://api.collegefootballdata.com

Method HTTP request Description
getDrives GET /drives Drive data and results

getDrives

[Drive] getDrives(year, opts)

Drive data and results

Get game drives

Example

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.DrivesApi();

var year = 56; // Number | Year filter

var opts = { 
  'seasonType': "regular", // String | Season type filter
  'week': 56, // Number | Week filter
  'team': "team_example", // String | Team filter
  'offense': "offense_example", // String | Offensive team filter
  'defense': "defense_example", // String | Defensive team filter
  'conference': "conference_example", // String | Conference filter
  'offenseConference': "offenseConference_example", // String | Offensive conference filter
  'defenseConference': "defenseConference_example", // String | Defensive conference filter
  'classification': "classification_example" // String | Division classification filter (fbs/fcs/ii/iii)
};
apiInstance.getDrives(year, 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
seasonType String Season type filter [optional] [default to regular]
week Number Week filter [optional]
team String Team filter [optional]
offense String Offensive team filter [optional]
defense String Defensive team filter [optional]
conference String Conference filter [optional]
offenseConference String Offensive conference filter [optional]
defenseConference String Defensive conference filter [optional]
classification String Division classification filter (fbs/fcs/ii/iii) [optional]

Return type

[Drive]

Authorization

ApiKeyAuth

HTTP request headers

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