- Public names are sportsdataverse-py's —
athlete→player,event→gameon every ESPN league; sdv-py'sname_patternon the native families (nhlApiWeb*→nhl*,nflApi*→nfl*, CBS's 16 shorts, the 3.0.0 file-stem names). Every pre-v4 name still works as a deprecated alias that warns once. (changelog) - Integer id columns are decimal strings — Every id column of integers (
id,*_id,game_pk,playerId, …) comes back as exact decimal strings on every surface — parsers, producers, loaders, HockeyTech analytics. Compare and join ids as strings;Number(row.game_id)for a safe number back. (changelog) - 400 / 422 raise
InvalidParameterError— For every family (it wasAssetFetchError), never retried; the message names host, path and status with a redacted excerpt of the body. (changelog) - Typed returns — generated row types for
parsed: true— TypeScript only. A wrapper's raw payload resolves tounknown(wasany); verified endpoints resolve to their row interfaces; the summary dispatchers toParsedTables. Narrow or cast a raw payload. (changelog) - Typed wrapper params and loader rows;
strictmode — TypeScript only. A param the endpoint does not have, a missing required path param or a non-booleanboolparam is a type error; parser rows areRecord<string, unknown>; loader rows are their generated row types. (changelog) - Wrapper failures raise
NoDataError/AssetFetchError— Instead of raw axios errors.NoDataError= the fetch worked and there is nothing there (404, ESPN{ code: 404 });AssetFetchError= the fetch failed (403 / 429 / 5xx after retries, network). Retries followDEFAULT_RETRY_STATUSESwith backoff. (changelog)
wnba — CDN (espn.com page data)
4 endpoints on sdv.wnba. Each is exposed under a camelCase canonical name and a snake_case alias (py/R parity), accepts snake_case or camelCase params, and returns raw ESPN JSON by default ({ parsed: true } for tidy rows).
espnWnbaCdnBoxscore
WNBA — cdn boxscore (ESPN cdn.espn.com (espn.com page data)).
Endpoint URL: GET https://cdn.espn.com/core/wnba/boxscore?xhr=1
| API param | JS | required | description |
|---|---|---|---|
gameId | game_id | no | number | string — ESPN game (event) id |
| — | parsed | no | boolean — return tidy rows instead of raw JSON |
| — | section | no | with parsed, return one named sub-frame (e.g. boxscore, plays, winprobability) instead of all |
Returns: raw ESPN Dict by default. With { parsed: true } the page's gamepackageJSON (a Site v2 summary) goes through the summary dispatcher, which returns an object of 21 sub-frames keyed by section ({ parsed: true, section: '<name>' } for one); see ESPN parsed returns.
Rows are untyped Row[] (not parity-verified yet).
Example:
await sdv.wnba.espnWnbaCdnBoxscore({});
// snake_case alias (py/R parity): sdv.wnba.espn_wnba_cdn_boxscore(...)
espnWnbaCdnPlaybyplay
WNBA — cdn playbyplay (ESPN cdn.espn.com (espn.com page data)).
Endpoint URL: GET https://cdn.espn.com/core/wnba/playbyplay?xhr=1
| API param | JS | required | description |
|---|---|---|---|
gameId | game_id | no | number | string — ESPN game (event) id |
| — | parsed | no | boolean — return tidy rows instead of raw JSON |
| — | section | no | with parsed, return one named sub-frame (e.g. boxscore, plays, winprobability) instead of all |
Returns: raw ESPN Dict by default. With { parsed: true } the page's gamepackageJSON (a Site v2 summary) goes through the summary dispatcher, which returns an object of 21 sub-frames keyed by section ({ parsed: true, section: '<name>' } for one); see ESPN parsed returns.
Rows are untyped Row[] (not parity-verified yet).
Example:
await sdv.wnba.espnWnbaCdnPlaybyplay({});
// snake_case alias (py/R parity): sdv.wnba.espn_wnba_cdn_playbyplay(...)
espnWnbaCdnSchedule
WNBA — cdn schedule (ESPN cdn.espn.com (espn.com page data)).
Endpoint URL: GET https://cdn.espn.com/core/wnba/schedule?xhr=1
| API param | JS | required | description |
|---|---|---|---|
date | date | no | number | string — Single date (YYYYMMDD). Ignored by cfb and nfl, which are week-oriented. Defaults to today |
week | week | no | number | string — Week number (cfb and nfl) |
year | season | no | number | string — Season year that week belongs to (cfb and nfl) |
seasontype | season_type | no | number | string — Season phase for week: 1=preseason, 2=regular season, 3=postseason (cfb and nfl) |
| — | parsed | no | boolean — return tidy rows instead of raw JSON |
Returns (with { parsed: true }, via parse_cdn_schedule):
| col_name | type | description |
|---|---|---|
game_id | character | Unique game identifier. |
uid | character | ESPN UID string. |
date | character | Match start timestamp (ISO 8601, UTC). |
name | character | Full event name (e.g. 'Team A at Team B'). |
short_name | character | Abbreviated event name (e.g. 'TA @ TB'). |
season_year | integer | Integer season year ESPN assigns the event (e.g. 2025 for the 2025-26 season). |
season_type | integer | ESPN season-type id of the event's season: 1 preseason, 2 regular season, 3 postseason, 4 offseason for the US leagues; soccer competitions carry their own competition-specific ids (e.g. 13481). |
season_slug | character | Season slug. |
status_type_id | character | Unique identifier for status type. |
status_type_name | character | Status type name. |
status_type_state | character | Status type state. |
status_type_completed | logical | Status type completed. |
status_type_description | character | Status type description. |
status_type_detail | character | Status type detail. |
status_type_short_detail | character | Status type short detail. |
status_clock | integer | Game clock in seconds as ESPN reports it: time remaining in the period for clock sports, elapsed seconds for soccer (e.g. 5400.0 at full time); 0.0 once a game has ended. |
status_display_clock | character | Status display clock. |
status_period | integer | Current or final period number (quarter, half, inning or period, depending on the sport). |
neutral_site | logical | Whether the match is played at a neutral venue. |
conference_competition | logical | Conference competition. |
attendance | integer | Reported attendance. |
venue_id | character | Unique venue identifier. |
venue_full_name | character | Venue full name. |
venue_city | character | Venue city. |
venue_state | character | Venue state / region. |
venue_indoor | logical | TRUE if the venue is indoors. |
broadcast | character | Broadcast information string. |
note | character | Event note text from the competition (e.g. a series or game label such as 'World Series - Game 1', or a shootout result); an empty string when there is none. |
home_id | character | Unique identifier for home. |
home_name | character | Home name. |
home_abbreviation | character | Home team's abbreviation. |
home_display_name | character | Home display name. |
home_location | character | Home team's location. |
home_color | character | Color code (hex) for home. |
home_alternate_color | character | Color code (hex) for home alternate. |
home_logo | character | Home team logo URL. |
home_score | character | Home team's score. For cricket, the innings string (e.g. '161/5 (18/20 ov, target 156)'). |
home_winner | logical | Home team's winner. |
home_rank | character | |
away_id | character | Unique identifier for away. |
away_name | character | Away name. |
away_abbreviation | character | Away team's abbreviation. |
away_display_name | character | Away display name. |
away_location | character | Away team's location. |
away_color | character | Color code (hex) for away. |
away_alternate_color | character | Color code (hex) for away alternate. |
away_logo | character | Away team logo URL. |
away_score | character | Away team's score. For cricket, the innings string. |
away_winner | logical | Away team's winner. |
away_rank | character |
Rows are untyped Row[] (not parity-verified yet).
Example:
await sdv.wnba.espnWnbaCdnSchedule({});
// snake_case alias (py/R parity): sdv.wnba.espn_wnba_cdn_schedule(...)
espnWnbaCdnScoreboard
WNBA — cdn scoreboard (ESPN cdn.espn.com (espn.com page data)).
Endpoint URL: GET https://cdn.espn.com/core/wnba/scoreboard?xhr=1
| API param | JS | required | description |
|---|---|---|---|
date | date | no | number | string — Single date (YYYYMMDD). Ignored by cfb and nfl, which are week-oriented. Defaults to today |
week | week | no | number | string — Week number (cfb and nfl) |
year | season | no | number | string — Season year that week belongs to (cfb and nfl) |
seasontype | season_type | no | number | string — Season phase for week: 1=preseason, 2=regular season, 3=postseason (cfb and nfl) |
| — | parsed | no | boolean — return tidy rows instead of raw JSON |
Returns (with { parsed: true }, via parse_cdn_scoreboard):
| col_name | type | description |
|---|---|---|
game_id | character | Unique game identifier. |
uid | character | ESPN UID string. |
date | character | Match start timestamp (ISO 8601, UTC). |
name | character | Full event name (e.g. 'Team A at Team B'). |
short_name | character | Abbreviated event name (e.g. 'TA @ TB'). |
season_year | integer | Integer season year ESPN assigns the event (e.g. 2025 for the 2025-26 season). |
season_type | integer | ESPN season-type id of the event's season: 1 preseason, 2 regular season, 3 postseason, 4 offseason for the US leagues; soccer competitions carry their own competition-specific ids (e.g. 13481). |
season_slug | character | Season slug. |
status_type_id | character | Unique identifier for status type. |
status_type_name | character | Status type name. |
status_type_state | character | Status type state. |
status_type_completed | logical | Status type completed. |
status_type_description | character | Status type description. |
status_type_detail | character | Status type detail. |
status_type_short_detail | character | Status type short detail. |
status_clock | integer | Game clock in seconds as ESPN reports it: time remaining in the period for clock sports, elapsed seconds for soccer (e.g. 5400.0 at full time); 0.0 once a game has ended. |
status_display_clock | character | Status display clock. |
status_period | integer | Current or final period number (quarter, half, inning or period, depending on the sport). |
neutral_site | logical | Whether the match is played at a neutral venue. |
conference_competition | logical | Conference competition. |
attendance | integer | Reported attendance. |
venue_id | character | Unique venue identifier. |
venue_full_name | character | Venue full name. |
venue_city | character | Venue city. |
venue_state | character | Venue state / region. |
venue_indoor | logical | TRUE if the venue is indoors. |
broadcast | character | Broadcast information string. |
note | character | Event note text from the competition (e.g. a series or game label such as 'World Series - Game 1', or a shootout result); an empty string when there is none. |
home_id | character | Unique identifier for home. |
home_name | character | Home name. |
home_abbreviation | character | Home team's abbreviation. |
home_display_name | character | Home display name. |
home_location | character | Home team's location. |
home_color | character | Color code (hex) for home. |
home_alternate_color | character | Color code (hex) for home alternate. |
home_logo | character | Home team logo URL. |
home_score | character | Home team's score. For cricket, the innings string (e.g. '161/5 (18/20 ov, target 156)'). |
home_winner | logical | Home team's winner. |
home_rank | character | |
away_id | character | Unique identifier for away. |
away_name | character | Away name. |
away_abbreviation | character | Away team's abbreviation. |
away_display_name | character | Away display name. |
away_location | character | Away team's location. |
away_color | character | Color code (hex) for away. |
away_alternate_color | character | Color code (hex) for away alternate. |
away_logo | character | Away team logo URL. |
away_score | character | Away team's score. For cricket, the innings string. |
away_winner | logical | Away team's winner. |
away_rank | character |
Rows are untyped Row[] (not parity-verified yet).
Example:
await sdv.wnba.espnWnbaCdnScoreboard({});
// snake_case alias (py/R parity): sdv.wnba.espn_wnba_cdn_scoreboard(...)
Generated by tools/codegen/generate.mjs from tools/codegen/endpoints/espn*.yaml (vendored from sdv-py) — see How this library is built._