CollegeFootballData 1.0.0

CollegeFootballData - the C# library for the College Football Data API

This is an API for query various college football datasets and analytics. API keys can be acquired from the CollegeFootballData.com website.

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 5.5.1
• SDK version: 1.0.0
• Generator version: 7.11.0
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen

<a id="frameworks-supported"></a>

Frameworks supported

<a id="dependencies"></a>

Dependencies

• RestSharp - 112.0.0 or later
• Json.NET - 13.0.2 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a id="installation"></a>

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using CollegeFootballData.Api;
using CollegeFootballData.Client;
using CollegeFootballData.Model;

<a id="packaging"></a>

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out CollegeFootballData.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

<a id="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a id="getting-started"></a>

Getting Started

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

namespace Example
{
    public class Example
    {
        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 AdjustedMetricsApi(config);
            var year = 56;  // int? | Optional year filter (optional) 
            var team = "team_example";  // string? | Optional team filter (optional) 
            var conference = "conference_example";  // string? | Optional conference abbreviation filter (optional) 
            var position = "position_example";  // string? | Optional position abbreviation filter (optional) 

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

        }
    }
}

<a id="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

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

<a id="documentation-for-models"></a>

Documentation for Models

• Model.AdjustedTeamMetrics
• Model.AdjustedTeamMetricsEpa
• Model.AdjustedTeamMetricsRushing
• Model.AdjustedTeamMetricsSuccessRate
• Model.AdvancedBoxScore
• Model.AdvancedBoxScoreGameInfo
• Model.AdvancedBoxScorePlayers
• Model.AdvancedBoxScoreTeams
• Model.AdvancedGameStat
• Model.AdvancedGameStatOffense
• Model.AdvancedGameStatOffensePassingDowns
• Model.AdvancedGameStatOffensePassingPlays
• Model.AdvancedSeasonStat
• Model.AdvancedSeasonStatDefense
• Model.AdvancedSeasonStatOffense
• Model.AdvancedSeasonStatOffenseFieldPosition
• Model.AdvancedSeasonStatOffenseHavoc
• Model.AdvancedSeasonStatOffensePassingDowns
• Model.AdvancedSeasonStatOffensePassingPlays
• Model.AggregatedTeamRecruiting
• Model.BettingGame
• Model.CalendarWeek
• Model.Coach
• Model.CoachSeason
• Model.Conference
• Model.ConferenceSP
• Model.ConferenceSPDefense
• Model.ConferenceSPOffense
• Model.DivisionClassification
• Model.DraftPick
• Model.DraftPickHometownInfo
• Model.DraftPosition
• Model.DraftTeam
• Model.Drive
• Model.FieldGoalEP
• Model.Game
• Model.GameLine
• Model.GameMedia
• Model.GamePlayerStatCategories
• Model.GamePlayerStatPlayer
• Model.GamePlayerStatTypes
• Model.GamePlayerStats
• Model.GamePlayerStatsTeam
• Model.GameStatus
• Model.GameTeamStats
• Model.GameTeamStatsTeam
• Model.GameTeamStatsTeamStat
• Model.GameWeather
• Model.KickerPAAR
• Model.LiveGame
• Model.LiveGameDrive
• Model.LiveGamePlay
• Model.LiveGameTeam
• Model.Matchup
• Model.MatchupGame
• Model.MediaType
• Model.Play
• Model.PlayClock
• Model.PlayStat
• Model.PlayStatClock
• Model.PlayStatType
• Model.PlayType
• Model.PlayWinProbability
• Model.PlayerGamePredictedPointsAdded
• Model.PlayerGamePredictedPointsAddedAveragePPA
• Model.PlayerGameUsage
• Model.PlayerPPA
• Model.PlayerPPAChartItem
• Model.PlayerSearchResult
• Model.PlayerSeasonPredictedPointsAdded
• Model.PlayerSeasonPredictedPointsAddedAveragePPA
• Model.PlayerStat
• Model.PlayerStatsByQuarter
• Model.PlayerTransfer
• Model.PlayerUsage
• Model.PlayerUsageUsage
• Model.PlayerWeightedEPA
• Model.Poll
• Model.PollRank
• Model.PollWeek
• Model.PredictedPointsValue
• Model.PregameWinProbability
• Model.Recruit
• Model.RecruitClassification
• Model.RecruitHometownInfo
• Model.ReturningProduction
• Model.RosterPlayer
• Model.ScoreboardGame
• Model.ScoreboardGameBetting
• Model.ScoreboardGameHomeTeam
• Model.ScoreboardGameVenue
• Model.ScoreboardGameWeather
• Model.SeasonType
• Model.StatsByQuarter
• Model.Team
• Model.TeamElo
• Model.TeamExplosiveness
• Model.TeamFPI
• Model.TeamFPIEfficiencies
• Model.TeamFPIResumeRanks
• Model.TeamFieldPosition
• Model.TeamGamePredictedPointsAdded
• Model.TeamGamePredictedPointsAddedOffense
• Model.TeamHavoc
• Model.TeamPPA
• Model.TeamRecord
• Model.TeamRecords
• Model.TeamRecruitingRanking
• Model.TeamRushingStats
• Model.TeamSP
• Model.TeamSPDefense
• Model.TeamSPOffense
• Model.TeamSPSpecialTeams
• Model.TeamSRS
• Model.TeamScoringOpportunities
• Model.TeamSeasonPredictedPointsAdded
• Model.TeamSeasonPredictedPointsAddedOffense
• Model.TeamStat
• Model.TeamStatStatValue
• Model.TeamSuccessRates
• Model.TeamTalent
• Model.TransferEligibility
• Model.Venue

<a id="documentation-for-authorization"></a>

Documentation for Authorization

Authentication schemes defined for the API: <a id="apiKey"></a>

apiKey

• Type: Bearer Authentication