CollegeFootballData.Api.TeamsApi

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

Method	HTTP request	Description
GetFBSTeams	GET /teams/fbs
GetMatchup	GET /teams/matchup
GetRoster	GET /roster
GetTalent	GET /talent
GetTeams	GET /teams

GetFBSTeams

List<Team> GetFBSTeams (int? year = null)

Retrieves information on teams playing in the highest division of CFB

Example

using System.Collections.Generic;
using System.Diagnostics;
using CollegeFootballData.Api;
using CollegeFootballData.Client;
using CollegeFootballData.Model;

namespace Example
{
    public class GetFBSTeamsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://apinext.collegefootballdata.com";
            // Configure Bearer token for authorization: apiKey
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new TeamsApi(config);
            var year = 56;  // int? | Year or season (optional) 

            try
            {
                List<Team> result = apiInstance.GetFBSTeams(year);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TeamsApi.GetFBSTeams: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetFBSTeamsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<List<Team>> response = apiInstance.GetFBSTeamsWithHttpInfo(year);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling TeamsApi.GetFBSTeamsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
year	int?	Year or season	[optional]

Return type

List<Team>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

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

GetMatchup

Matchup GetMatchup (string team1, string team2, int? minYear = null, int? maxYear = null)

Retrieves historical matchup details for two given teams

Example

using System.Collections.Generic;
using System.Diagnostics;
using CollegeFootballData.Api;
using CollegeFootballData.Client;
using CollegeFootballData.Model;

namespace Example
{
    public class GetMatchupExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://apinext.collegefootballdata.com";
            // Configure Bearer token for authorization: apiKey
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new TeamsApi(config);
            var team1 = "team1_example";  // string | First team to compare
            var team2 = "team2_example";  // string | Second team to compare
            var minYear = 56;  // int? | Optional starting year (optional) 
            var maxYear = 56;  // int? | Optional ending year (optional) 

            try
            {
                Matchup result = apiInstance.GetMatchup(team1, team2, minYear, maxYear);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TeamsApi.GetMatchup: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetMatchupWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<Matchup> response = apiInstance.GetMatchupWithHttpInfo(team1, team2, minYear, maxYear);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling TeamsApi.GetMatchupWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
team1	string	First team to compare
team2	string	Second team to compare
minYear	int?	Optional starting year	[optional]
maxYear	int?	Optional ending year	[optional]

Return type

Matchup

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

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

GetRoster

List<RosterPlayer> GetRoster (string? team = null, int? year = null)

Retrieves historical roster data

Example

using System.Collections.Generic;
using System.Diagnostics;
using CollegeFootballData.Api;
using CollegeFootballData.Client;
using CollegeFootballData.Model;

namespace Example
{
    public class GetRosterExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://apinext.collegefootballdata.com";
            // Configure Bearer token for authorization: apiKey
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new TeamsApi(config);
            var team = "team_example";  // string? | Optional team filter (optional) 
            var year = 56;  // int? | Optional year filter, defaults to 2023 (optional) 

            try
            {
                List<RosterPlayer> result = apiInstance.GetRoster(team, year);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TeamsApi.GetRoster: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetRosterWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<List<RosterPlayer>> response = apiInstance.GetRosterWithHttpInfo(team, year);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling TeamsApi.GetRosterWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
team	string?	Optional team filter	[optional]
year	int?	Optional year filter, defaults to 2023	[optional]

Return type

List<RosterPlayer>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

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

GetTalent

List<TeamTalent> GetTalent (int year)

Retrieve 247 Team Talent Composite for a given year

Example

using System.Collections.Generic;
using System.Diagnostics;
using CollegeFootballData.Api;
using CollegeFootballData.Client;
using CollegeFootballData.Model;

namespace Example
{
    public class GetTalentExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://apinext.collegefootballdata.com";
            // Configure Bearer token for authorization: apiKey
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new TeamsApi(config);
            var year = 56;  // int | Year filter

            try
            {
                List<TeamTalent> result = apiInstance.GetTalent(year);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TeamsApi.GetTalent: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetTalentWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<List<TeamTalent>> response = apiInstance.GetTalentWithHttpInfo(year);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling TeamsApi.GetTalentWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
year	int	Year filter

Return type

List<TeamTalent>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

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

GetTeams

List<Team> GetTeams (string? conference = null, int? year = null)

Retrieves team information

Example

using System.Collections.Generic;
using System.Diagnostics;
using CollegeFootballData.Api;
using CollegeFootballData.Client;
using CollegeFootballData.Model;

namespace Example
{
    public class GetTeamsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://apinext.collegefootballdata.com";
            // Configure Bearer token for authorization: apiKey
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new TeamsApi(config);
            var conference = "conference_example";  // string? | Optional conference abbreviation filter (optional) 
            var year = 56;  // int? | Optional year filter to get historical conference affiliations (optional) 

            try
            {
                List<Team> result = apiInstance.GetTeams(conference, year);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TeamsApi.GetTeams: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetTeamsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<List<Team>> response = apiInstance.GetTeamsWithHttpInfo(conference, year);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling TeamsApi.GetTeamsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
conference	string?	Optional conference abbreviation filter	[optional]
year	int?	Optional year filter to get historical conference affiliations	[optional]

Return type

List<Team>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

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

Files

TeamsApi.md

Latest commit

History

TeamsApi.md

File metadata and controls

CollegeFootballData.Api.TeamsApi

GetFBSTeams

Example

Using the GetFBSTeamsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetMatchup

Example

Using the GetMatchupWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetRoster

Example

Using the GetRosterWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetTalent

Example

Using the GetTalentWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetTeams

Example

Using the GetTeamsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details