Yfpy

<img src="https://raw.githubusercontent.com/uberfastman/yfpy/refs/heads/main/docs/yfpy-logo.svg" width="400"/>

YFPY - Yahoo Fantasy Sports API Wrapper

Python API wrapper for the Yahoo Fantasy Sports public API

Author: Wren J. R. (uberfastman)

---

_{Do you like the YFPY API wrapper? Star the repository on GitHub and please consider helping support its ongoing development:}

<img src="https://github.com/uberfastman/yfpy/raw/main/resources/images/donate-paypal.png" width="75"/> <img src="https://github.com/uberfastman/yfpy/raw/main/resources/images/donate-bitcoin.png" width="75"/> <img src="https://github.com/uberfastman/yfpy/raw/main/resources/images/donate-ethereum.png" width="75"/>

| _{^{Cryptocurrency}} | _^Address | |----------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------:| | _{^{Bitcoin (BTC)}} | _^bc1qataspvklhewtswm357m0677q4raag5new2xt3e | | _{^{Ethereum (ETH)}} | _^0x5eAa522e66a90577D49e9E72f253EC952CDB4059 |



---

READ THE DOCS HERE! <br/> ^{Detailed documentation on YFPY can be found at https://yfpy.uberfastman.com.}

Table of Contents

• About
• Installation
  • Pip
  • uv
  • Manual
• Setup
  • Yahoo Developer Network App
  • Environment Variables
• Usage
  • Authentication
    • Programmatic Persistent Authentication
    • Persistent Authentication Using Access Token Fields
    • Persistent Authentication Using Access Token JSON
  • Querying the Yahoo Fantasy Sports API
  • Docker
    • Docker Development
    • Docker Image Deployment
• Testing
  • Unit Tests
  • Integration Tests
  • Run Tests
• Dependencies
  • Platform
  • Python
  • Development
• Troubleshooting
  • Yahoo Fantasy Sports API
  • JetBrains and PyCharm

---

<a name="about"></a>

About

YFPY is a comprehensive wrapper around the Yahoo Fantasy Sports API. It allows for easy retrieval and parsing of almost any data you might wish to extract and use from any Yahoo fantasy league to which your Yahoo account has access (or for public leagues). The primary focus of this wrapper is on fantasy football (NFL), but it also supports usage with fantasy hockey (NHL), fantasy baseball (MLB), and fantasy basketball (NBA).

---

<a name="installation"></a>

Installation

<a name="pip"></a>

Pip

• If you wish to use YFPY within another project, from within your project directory, run:

  pip install yfpy
  

  or add yfpy to your project requirements.txt.

<a name="uv"></a>

uv

• If you wish to use YFPY within another project, from within your project directory, run:

  uv add yfpy
  

  or add yfpy to the project dependencies section in your pyproject.toml.

<a name="manual"></a>

Manual

• If you wish to download and use YFPY locally, clone the git repository:

  git clone git@github.com:uberfastman/yfpy.git
  

---

<a name="setup"></a>

Setup

<a name="yahoo-developer-network-app"></a>

Yahoo Developer Network App

In order to use YFPY with private fantasy leagues, you must set up an app on your Yahoo account to allow access. Follow the step-by-step guide below for instructions on how to do so, or see Getting Started in the Yahoo Developer Network docs for more details.

Note: If you are only planning on using YFPY to pull "read only" data from public leagues, you do not need to do this.

• Log in to a Yahoo account with access to whatever fantasy leagues from which you wish to retrieve data.
• Go to https://developer.yahoo.com/apps/create/ and create an app (you must be logged into your Yahoo account as stated above). For the app, select the following options:
  • Application Name (Required): yfpy (you can name your app whatever you want, but this is just an example).
  • Application Type (Required): select the Installed Application radio button.
  • Description (Optional): you may write a short description of what the app does.
  • Home Page URL (Optional): if you have a web address related to your app you may add it here.
  • Redirect URI(s) (Required): this field must contain a valid redirect address, so you can use https://localhost:8080
  • API Permissions (Required): check the Fantasy Sports checkbox. You can leave the Read option selected (appears in an accordion expansion underneath the Fantasy Sports checkbox once you select it).
  • Click the Create App button.
  • Once the app is created, it should redirect you to a page for your app, which will show both a Client ID and a Client Secret.
  • Copy the Client ID and Client Secret and proceed with the steps in Environment Variables or Programmatic Persistent Authentication.

<a name="environment-variables"></a>

Environment Variables

YFPY now supports the usage of environment variables, either directly within the command line or using a .env file. Any environment variables exported to the same shell in which YFPY runs will automatically be read when a YahooFantasySportsQuery object is instantiated when env_var_fallback=True (default).

• If you wish to also use environment variables stored in a .env file, you can set up a .env file by making a copy of .env.template in the root project directory and renaming it .env (you can do this in the command line by running cp .env.template .env).
• Paste the Client ID and Client Secret retrieved by following the steps in Yahoo Developer Network App into their respective environment variables in your .env file:

YAHOO_CONSUMER_KEY=<YAHOO_DEVELOPER_APP_CONSUMER_KEY_STRING>
YAHOO_CONSUMER_SECRET=<YAHOO_DEVELOPER_APP_CONSUMER_SECRET_STRING>

• YFPY is configured by default to check for environment variables for authentication with Yahoo, so you will now be able to proceed directly to Authentication.

Note: You can disable the fallback to environment variables behavior during instantiation of a YFPY query by passing the argument env_var_fallback=False to the object:

from yfpy.query import YahooFantasySportsQuery

query = YahooFantasySportsQuery(
    league_id="<YAHOO_LEAGUE_ID>",
    game_code="nfl",
    game_id=449,
    yahoo_consumer_key="<YAHOO_CONSUMER_KEY>",
    yahoo_consumer_secret="<YAHOO_CONSUMER_SECRET>",
    env_var_fallback=False
)

---

<a name="usage"></a>

Usage

<a name="authentication"></a>

Authentication

• Follow the instructions in the Installation and Setup sections.
• The first time you use YFPY, a browser window will open up asking you to allow your app to access your Yahoo fantasy sports data. You MUST hit allow, and then copy the verification code that pops up into the command line prompt where it will now be asking for verification, hit enter, and the OAuth2 three-legged handshake should be complete and your data should have been successfully retrieved.

Note: *If you are running YFPY in Docker, instead of opening a new browser window, YFPY will output a URL to the command line, which you must then copy to a br