Skip to content

Latest commit

 

History

History
363 lines (279 loc) · 11.6 KB

RatingsApi.md

File metadata and controls

363 lines (279 loc) · 11.6 KB
Raw

CFBSharp.Api.RatingsApi

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

Method HTTP request Description
GetConferenceSPRatings GET /ratings/sp/conferences Historical SP+ ratings by conference
GetEloRatings GET /ratings/elo Historical Elo ratings
GetFPIRatings GET /ratings/fpi Historical FPI ratings
GetSPRatings GET /ratings/sp Historical SP+ ratings
GetSRSRatings GET /ratings/srs Historical SRS ratings

GetConferenceSPRatings

ICollection GetConferenceSPRatings (int? year = null, string conference = null)

Historical SP+ ratings by conference

Get average SP+ historical rating data by conference

Example

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

namespace Example
{
    public class GetConferenceSPRatingsExample
    {
        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 RatingsApi();
            var year = 56;  // int? | Season filter (optional) 
            var conference = conference_example;  // string | Conference abbreviation filter (optional) 

            try
            {
                // Historical SP+ ratings by conference
                ICollection<ConferenceSPRating> result = apiInstance.GetConferenceSPRatings(year, conference);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RatingsApi.GetConferenceSPRatings: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
year int? Season filter [optional]
conference string Conference abbreviation 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]

GetEloRatings

ICollection GetEloRatings (int? year = null, int? week = null, string seasonType = null, string team = null, string conference = null)

Historical Elo ratings

Elo rating data

Example

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

namespace Example
{
    public class GetEloRatingsExample
    {
        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 RatingsApi();
            var year = 56;  // int? | Season filter (optional) 
            var week = 56;  // int? | Maximum week filter (optional) 
            var seasonType = seasonType_example;  // string | Maximum season type to consider (defaults to regular if week is specified else defaults to postseason) (optional) 
            var team = team_example;  // string | Team filter (optional) 
            var conference = conference_example;  // string | Conference filter (optional) 

            try
            {
                // Historical Elo ratings
                ICollection<TeamEloRating> result = apiInstance.GetEloRatings(year, week, seasonType, team, conference);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RatingsApi.GetEloRatings: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
year int? Season filter [optional]
week int? Maximum week filter [optional]
seasonType string Maximum season type to consider (defaults to regular if week is specified else defaults to postseason) [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]

GetFPIRatings

ICollection GetFPIRatings (int? year = null, string team = null, string conference = null)

Historical FPI ratings

FPI rating data

Example

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

namespace Example
{
    public class GetFPIRatingsExample
    {
        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 RatingsApi();
            var year = 56;  // int? | Season filter (optional) 
            var team = team_example;  // string | Team filter (optional) 
            var conference = conference_example;  // string | Conference filter (optional) 

            try
            {
                // Historical FPI ratings
                ICollection<TeamFPIRating> result = apiInstance.GetFPIRatings(year, team, conference);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RatingsApi.GetFPIRatings: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
year int? Season filter [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]

GetSPRatings

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

Historical SP+ ratings

SP+ rating data

Example

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

namespace Example
{
    public class GetSPRatingsExample
    {
        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 RatingsApi();
            var year = 56;  // int? | Season filter (required if team not specified) (optional) 
            var team = team_example;  // string | Team filter (required if year not specified) (optional) 

            try
            {
                // Historical SP+ ratings
                ICollection<TeamSPRating> result = apiInstance.GetSPRatings(year, team);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RatingsApi.GetSPRatings: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
year int? Season filter (required if team not specified) [optional]
team string 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]

GetSRSRatings

ICollection GetSRSRatings (int? year = null, string team = null, string conference = null)

Historical SRS ratings

SRS rating data (requires either a year or team specified)

Example

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

namespace Example
{
    public class GetSRSRatingsExample
    {
        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 RatingsApi();
            var year = 56;  // int? | Season filter (required if team not specified) (optional) 
            var team = team_example;  // string | Team filter (required if year not specified) (optional) 
            var conference = conference_example;  // string | Conference filter (optional) 

            try
            {
                // Historical SRS ratings
                ICollection<TeamSRSRating> result = apiInstance.GetSRSRatings(year, team, conference);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RatingsApi.GetSRSRatings: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
year int? Season filter (required if team not specified) [optional]
team string Team filter (required if year not specified) [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]