Skip to content

Latest commit

 

History

History
225 lines (173 loc) · 7.77 KB

RecruitingApi.md

File metadata and controls

225 lines (173 loc) · 7.77 KB
Raw

CFBSharp.Api.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

ICollection GetRecruitingGroups (int? startYear = null, int? endYear = null, string team = null, string conference = null)

Recruit position group ratings

Gets a list of aggregated statistics by team and position grouping

Example

using System;
using System.Diagnostics;
using CFBSharp.Api;
using CFBSharp.Client;
using CFBSharp.Model;

namespace Example
{
    public class GetRecruitingGroupsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new RecruitingApi();
            var startYear = 56;  // int? | Starting year (optional) 
            var endYear = 56;  // int? | Ending year (optional) 
            var team = team_example;  // string | Team filter (optional) 
            var conference = conference_example;  // string | conference filter (optional) 

            try
            {
                // Recruit position group ratings
                ICollection<PositionGroupRecruitingRating> result = apiInstance.GetRecruitingGroups(startYear, endYear, team, conference);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecruitingApi.GetRecruitingGroups: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
startYear int? Starting year [optional]
endYear int? Ending year [optional]
team string Team filter [optional]
conference string conference filter [optional]

Return type

ICollection

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRecruitingPlayers

ICollection GetRecruitingPlayers (int? year = null, string classification = null, string position = null, string state = null, string team = null)

Player recruiting ratings and rankings

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

Example

using System;
using System.Diagnostics;
using CFBSharp.Api;
using CFBSharp.Client;
using CFBSharp.Model;

namespace Example
{
    public class GetRecruitingPlayersExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new RecruitingApi();
            var year = 56;  // int? | Recruiting class year (required if team no specified) (optional) 
            var classification = classification_example;  // string | Type of recruit (HighSchool, JUCO, PrepSchool) (optional)  (default to HighSchool)
            var position = position_example;  // string | Position abbreviation filter (optional) 
            var state = state_example;  // string | State or province abbreviation filter (optional) 
            var team = team_example;  // string | Committed team filter (required if year not specified) (optional) 

            try
            {
                // Player recruiting ratings and rankings
                ICollection<Recruit> result = apiInstance.GetRecruitingPlayers(year, classification, position, state, team);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecruitingApi.GetRecruitingPlayers: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
year int? 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

ICollection

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRecruitingTeams

ICollection GetRecruitingTeams (int? year = null, string team = null)

Team recruiting rankings and ratings

Team recruiting rankings

Example

using System;
using System.Diagnostics;
using CFBSharp.Api;
using CFBSharp.Client;
using CFBSharp.Model;

namespace Example
{
    public class GetRecruitingTeamsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new RecruitingApi();
            var year = 56;  // int? | Recruiting class year (optional) 
            var team = team_example;  // string | Team filter (optional) 

            try
            {
                // Team recruiting rankings and ratings
                ICollection<TeamRecruitingRank> result = apiInstance.GetRecruitingTeams(year, team);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecruitingApi.GetRecruitingTeams: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
year int? Recruiting class year [optional]
team string Team filter [optional]

Return type

ICollection

Authorization

ApiKeyAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]