mdryden/cfl-api.net

.Net Implementation of the Canadian Football League (CFL) public API.

cfl-api.net v2.1.24 (API v1.24)

.Net Implementation of the Canadian Football League (CFL) public API.

For information on the underlying API, see http://api.cfl.ca/docs

NuGet

https://www.nuget.org/packages/mdryden.cflapi.v1/

GitHub

https://github.com/pudds/cfl-api.net

Install-Package mdryden.cflapi.v1

Requirements

• A CFL API key is required for all requests. See CFL documentation for details on obtaining a key.
• To run the tests, make a local copy of "appSettings.template.config", rename it "appSettings.config" and add your API key.

Versioning

• The minor and build digits of the version number for this project will match with the version number of the CFL API it fully supports. See the release notes at http://api.cfl.ca/release-notes to determine which features are available.
• The first digit of the version number represents the major version within this project. It will only be incremented when the library API is updated with a breaking change.
• The last digit represents a revision, and will usually be 1 unless a bug fix has been released.

Reporting issues

Feel free to report any issues you find on the GitHub issue tracker (https://github.com/pudds/cfl-api.net/issues). Comments are also welcome.

When reporting issues, please ensure you have verified the underlying API call is returning the data you expect. For all API client classes, the LastRequestUrl will be populated with the actual api url which was created. You can paste this url into a browser or view the LastResponse property to see what the API returned.

Please include the value of the LastRequestUrl in any bug reports if applicable.

cfl-api.net's Issues

Game filter [temperature][in] returns no results

Request url: http://api.cfl.ca/v1/games?key=&filter[temperature][in]=21,24&page[number]=1

This should return several games (for example, game 1156 was 24 degrees, game 1103 was 21 degrees), but no games are returned.

This appears to be an API issue, but has not yet been reported to the CFL.

Some player list API requests return no data

Request url: http://api.cfl.ca/v1/players?key=&sort=cfl_central_id&page[number]=77

This request blows up and returns no data (not even the standard json container). The next page works fine.

This is definitely an API issue, probably some kind of serialization exception that the API hides from us. It's been reported to the CFL last year, but I will report again.

Game filter [date_start][eq] never returns any results

Request Url: http://api.cfl.ca/v1/games?key=&filter[date_start][eq]=2015-06-08&page[number]=1

This should return 1 game (2276), but it returns zero. Using the [ge] filter returns the expected game (and others of course).

I suspect this is an issue with the API either requiring a different format for date matching (I've tried "2016-06-23T19:30:00-04:00" as well, the value from the game itself), or some kind of time zone issue.

This has been reported to the CFL last year, but I will report again.

Game filter [event_type_id][in] returns only the first in filter value

Request url: http://api.cfl.ca/v1/games/2015?key=&filter[event_type_id][in]=2,3&page[number]=1

EventTypeID 2 is Playoffs, 3 is GreyCup. There should be 5 games returned by this query, but there are only 4 (only the "Playoff" games).

If you change the url to this:
http://api.cfl.ca/v1/games/2015?key=&filter[event_type_id][in]=3,2&page[number]=1

You get 1 game (only the grey cup) instead.

This appears to be an API bug; only the first filter value is actually used. This has not yet been reported to the CFL.

Player filter [offence_defence_or_special][eq] returns no results

Request url: http://api.cfl.ca/v1/players?key=&filter[offence_defence_or_special][eq]=S&page[number]=1&page[size]=20

This should return a full recordset, but no values are ever returned by this query. Using "O" or "D" instead does not work either.

This appears to be an API bug, and was reported to the CFL last year, but has not been fixed. I will report again.

Game filter [temperature][eq] does not work

Filtering games with an exact temperate does not appear to work, even though the greater/less filters work fine.

Request url: http://api.cfl.ca/v1/games/2015?key=&filter[temperature][eq]=21&page[number]=1

This request should return several games (2181, for example), but no matches are returned. Using the [ge] filter returns multiple games with a temperature of 21 degrees (and others, of course).

This appears to be an API issue, but has not yet been reported to the CFL.

Game filter [date_start][in] never returns any results

Request Url: http://api.cfl.ca/v1/games?key=&filter[date_start][in]=2015-06-23,2015-06-24&page[number]=1

There were 2 games on these 2 dates, but no values are returned by the API.

This appears to be an issue with the API, but has not yet been reported to the CFL.