Skip to content

Latest commit

 

History

History
180 lines (128 loc) · 5.42 KB

RecruitingApi.md

File metadata and controls

180 lines (128 loc) · 5.42 KB
Raw

cfb.RecruitingApi

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

Method HTTP request Description
getRecruitingGroups GET /recruiting/groups Recruit position group ratings
getRecruitingPlayers GET /recruiting/players Player recruiting ratings and rankings
getRecruitingTeams GET /recruiting/teams Team recruiting rankings and ratings

getRecruitingGroups

[PositionGroupRecruitingRating] getRecruitingGroups(opts)

Recruit position group ratings

Gets a list of aggregated statistics by team and position grouping

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

var opts = { 
  'startYear': 56, // Number | Starting year
  'endYear': 56, // Number | Ending year
  'team': "team_example", // String | Team filter
  'conference': "conference_example" // String | conference filter
};
apiInstance.getRecruitingGroups(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
startYear Number Starting year [optional]
endYear Number Ending year [optional]
team String Team filter [optional]
conference String conference filter [optional]

Return type

[PositionGroupRecruitingRating]

Authorization

ApiKeyAuth

HTTP request headers

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

getRecruitingPlayers

[Recruit] getRecruitingPlayers(opts)

Player recruiting ratings and rankings

Get player recruiting rankings and data. Requires either a year or team to be specified.

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

var opts = { 
  'year': 56, // Number | Recruiting class year (required if team no specified)
  'classification': "HighSchool", // String | Type of recruit (HighSchool, JUCO, PrepSchool)
  'position': "position_example", // String | Position abbreviation filter
  'state': "state_example", // String | State or province abbreviation filter
  'team': "team_example" // String | Committed team filter (required if year not specified)
};
apiInstance.getRecruitingPlayers(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
year Number Recruiting class year (required if team no specified) [optional]
classification String Type of recruit (HighSchool, JUCO, PrepSchool) [optional] [default to HighSchool]
position String Position abbreviation filter [optional]
state String State or province abbreviation filter [optional]
team String Committed team filter (required if year not specified) [optional]

Return type

[Recruit]

Authorization

ApiKeyAuth

HTTP request headers

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

getRecruitingTeams

[TeamRecruitingRank] getRecruitingTeams(opts)

Team recruiting rankings and ratings

Team recruiting rankings

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

var opts = { 
  'year': 56, // Number | Recruiting class year
  'team': "team_example" // String | Team filter
};
apiInstance.getRecruitingTeams(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
year Number Recruiting class year [optional]
team String Team filter [optional]

Return type

[TeamRecruitingRank]

Authorization

ApiKeyAuth

HTTP request headers

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