Skip to main content

Variable: espnNbaLeaders

const espnNbaLeaders: Wrapper<Row[], EspnLeadersParams>

Defined in: src/generated/espn/nba.ts:2165

NBA — leaders (ESPN site.web.api.espn.com (web v3)).

Endpoint: GET https://site.web.api.espn.com/apis/common/v3/sports/basketball/nba/statistics/byathlete

Param​

params.category

number | string — the statistics category.

Param​

params.season

number | string — the season year (the year the season ends for winter sports, e.g. 2025 for 2024-25).

Param​

params.season_type

number | string — the season type: 1 preseason, 2 regular season, 3 postseason.

Param​

params.limit

number | string — the maximum number of items to return; default 50.

Param​

params.page

number | string — the page of a paginated Core v2 list (1-based); default 1.

Param​

params.sort

number | string — the sort key and direction, e.g. offensive.avgPoints:desc.

Param​

params.parsed

boolean — when true, route the payload through this endpoint's tidy.js parser and return rows instead of raw JSON.

Returns​

Promise<Row[]> with { parsed: true } (rows are untyped: not parity-verified yet); the raw ESPN payload (unknown) otherwise.

Example​

await sdv.nba.espnNbaLeaders({});

See​

https://js.sportsdataverse.org/docs/nba/reference/web#espnnbaleaders