Skip to main content

Variable: espnMbbPlayersIndex

const espnMbbPlayersIndex: Wrapper<Row[], EspnAthletesIndexParams>

Defined in: src/generated/espn/mbb.ts:720

MBB — players index (ESPN sports.core.api.espn.com (core v2)).

Endpoint: GET https://sports.core.api.espn.com/v2/sports/basketball/leagues/mens-college-basketball/athletes

Param​

params.active

boolean — the active ESPN query parameter; default true.

Param​

params.limit

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

Param​

params.page

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

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.mbb.espnMbbPlayersIndex({});

See​

https://js.sportsdataverse.org/docs/mbb/reference/core#espnmbbplayersindex