NFL API

The nflapi library provides an interface for the NFL.com api. It essentially acts like a browser, accessing the same functionality available through nfl.com.

Installing

The library has not yet been released on PyPI, since it's still in a pretty rough state. There's a distinct risk that this might not ever change. To install, you can use pip's ability to to install directly from a git repository:

pip install -e git+ssh://git@github.com:rasher/nflapi.git#egg=nflapi

Examples

Basic boilerplate to getting going:

>>> from nflapi import NFL
>>> nfl = NFL(ua="nflapi example script")

That's it. You can now use the nfl object to query various objects off the NFL api. A couple of helpers are added to perform common queries and return the results as reasonable objects.

Getting the current season and week:

>>> week = nfl.schedule.current_week()
>>> print(("{w.current_season[default]}"
           " {w.current_season_type[default]}"
           " {w.current_week[default]}").format(w=week))
2018 PRE 2

Getting standings information:

>>> records = nfl.standings.current()
>>> for team, record in records:
...     print("{t.nick_name} {r.overall_pct:.3f}".format(t=team, r=record))
...
Cardinals 0.500

Have a look at [nflcli.py](nflapi/cli/nflcli.py) for more examples.

TODOs

• Helpers for more object types
• Documentation
• Tests, in a perfect world