Skip to main content
Breaking in 4.0.0
  • Public names are sportsdataverse-py's — athlete → player, event → game on every ESPN league; sdv-py's name_pattern on 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 was AssetFetchError), 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 to unknown (was any); verified endpoints resolve to their row interfaces; the summary dispatchers to ParsedTables. Narrow or cast a raw payload. (changelog)
  • Typed wrapper params and loader rows; strict mode — TypeScript only. A param the endpoint does not have, a missing required path param or a non-boolean bool param is a type error; parser rows are Record<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 follow DEFAULT_RETRY_STATUSES with backoff. (changelog)

sdv.nhl — ESPN reference

Sources for sdv.nhl​

ESPNno authvendored
site.api.espn.com, sports.core.api.espn.com, site.web.api.espn.com, site.web.api.espn.com (FPI), cdn.espn.com
  • ESPN site v2 25
  • ESPN core v2 90
  • ESPN web v3 5
  • ESPN fitt v3 1
  • ESPN cdn 5
wrappers
126
leagues
40 leagues
parity
—
described
67%

Site v2 / Core v2 / Web v3 / FPI / CDN, one wrapper set bound on every league.

NHL APIsno authvendored
api-web.nhle.com, api.nhle.com, records.nhl.com
  • NHL api-web (game feed) 27
  • NHL EDGE (player tracking) 35
  • NHL Stats REST 21
  • NHL Records 44
wrappers
127
namespace
sdv.nhl
parity
100/108
described
96%

api-web game feed, EDGE tracking, Stats REST and Records.

sportsdataverse-data releasesno authloaders
github.com/sportsdataverse/sportsdataverse-data
  • sdv.cfb loaders 73
  • sdv.mbb loaders 36
  • sdv.mlb loaders 35
  • sdv.nba loaders 45
  • sdv.nfl loaders 31
  • sdv.nhl loaders 28
  • sdv.pwhl loaders 21
  • sdv.wbb loaders 36
  • sdv.wnba loaders 36
loaders
341
namespace
sdv.cfb, sdv.mbb, sdv.mlb, sdv.nba, sdv.nfl, sdv.nhl, sdv.pwhl, sdv.wbb, sdv.wnba
parity
—
described
98%

Pre-built parquet datasets (`load*`) published as GitHub release assets.

  • namespace: sdv.nhl
  • sport slug: hockey
  • league slug: nhl
  • scopes: universal
  • wrappers: 113

sdv.nhl is composed from written, documented source (src/generated/espn/nhl.ts) — a phased proof of converting the runtime wrapper factory into reviewable modules. Every endpoint is a real export const with JSDoc, callable as sdv.nhl.espnNhl<Endpoint>(params) and under its snake_case alias (espn_nhl_<endpoint>) for parity with the Python / R packages.

import sdv from 'sportsdataverse';

await sdv.nhl.espnNhlScoreboard({});

Reference families​

Endpoints are grouped by ESPN API family. Pick a page for its per-function reference (endpoint URL, params, returns, example):

Familyendpoints
Site API24
Core API82
Web API5
FPI API (fitt v3)1
CDN (espn.com page data)1
Native API127
Dataset loaders28

Parsed output: pass { parsed: true } to any endpoint to get tidy rows instead of raw JSON. The columns are determined by each endpoint's parser — see ESPN parsed returns for the full column reference.

Generated by tools/codegen/generate.mjs from tools/codegen/endpoints/espn*.yaml (vendored from sdv-py) — see How this library is built._