college-football-risk
Companion API for College Football Risk
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.4.0
- Package version: 1.4.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
You can install directly using:
pip install college_football_risk(you may need to run pip with root permission: sudo pip install college_football_risk)
Then import the package:
import college_football_riskGetting Started
Please follow the installation procedure and then run the following example code:
import college_football_risk as risk
# Get stats for a single player
players_api = risk.PlayersApi()
player_name = 'BlueSCar'
player = players_api.get_player(player_name)
print(player)
# Get a list of players by team
players = players_api.get_players(team='Nebraska')
for player in players:
print("Player: {0}, Turns Played: {1}".format(player.player, player.turns_played))Documentation for API Endpoints
All URIs are relative to https://collegefootballrisk.com/api
| Class | Method | HTTP request | Description |
|---|---|---|---|
| PlayersApi | get_player | GET /player | Player information |
| PlayersApi | get_players | GET /players | List of players |
| StatsApi | get_leaderboard | GET /stats/leaderboard | Game leaderboard |
| StatsApi | get_turns | GET /turns | Get turns list |
| TeamsApi | get_player_moves_by_turn | GET /team/players | Get players moves by turn |
| TeamsApi | get_team_history | GET /stats/team/history | Get historical team stats |
| TeamsApi | get_team_odds | GET /team/odds | Get team odds per territory |
| TeamsApi | get_team_strength | GET /stats/team | Get current team strength |
| TeamsApi | get_teams | GET /teams | Get list of teams |
| TerritoriesApi | get_territories | GET /territories | Get list of territories, including ownership status for the given turn |
| TerritoriesApi | get_territory_history | GET /territory/history | Get historical territory data |
| TerritoriesApi | get_territory_turn | GET /territory/turn | Get territory statistics for a specific turn |
Documentation For Models
- LeaderboardTeam
- Player
- PlayerRatings
- PlayerStats
- PlayerTeam
- PlayerTeamColors
- PlayerTurns
- Team
- TeamHistory
- TeamHistoryStarBreakdown
- TeamOdds
- TeamPlayer
- TeamPlayerLastTurn
- TeamStrength
- TeamTurnPlayer
- Territory
- TerritoryHistory
- TerritoryNeighbors
- TerritoryTurn
- TerritoryTurnPlayers
- TerritoryTurnTeams
- Turn
Documentation For Authorization
All endpoints do not require authorization.
