Skip to main content

NWSL — NWSL official web API (StatsPerform SDP)

sportsdataverse.soccer.nwsl — 9 endpoints.

nwsl_competitions​

All competitions StatsPerform tracks for NWSL (league + friendlies/cups).

Endpoint URL: GET https://api-sdp.nwslsoccer.com/v1/nwsl/football/competitions

Valid URL: https://api-sdp.nwslsoccer.com/v1/nwsl/football/competitions?locale=en-US

API ParameterPythonPatternRequiredNullableDescription
localelocaleYUI locale, always en-US.

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
competition_idStringComposite Competition id (Utf8 join key).
provider_idStringUnderlying StatsPerform/Opta provider id (e.g. opta:...).
nameStringStage display name.
official_nameStringOfficial team name.
short_nameStringShort team name.
acronym_nameString3-letter team code.

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
sportsdataverse.errors.NoESPNDataErrorThe host answered 404 -- the requested resource does not exist. The SDP host returned 404 (unknown composite id, or an unmapped match sub-resource).
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nwsl_competitions()

nwsl_match_lineups​

Team lineups (starting XI + bench + staff) for a match.

Endpoint URL: GET https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/{season_id}/matches/{match_id}/lineups

Valid URL: https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/nwsl::Football_Season::0b6761e4701749f593690c0f338da74c/matches/nwsl::Football_Match::0b6761e4701749f593690c0f338da74c/lineups?locale=en-US

API ParameterPythonPatternRequiredNullableDescription
season_idseason_idYseason_id path parameter.
match_idmatch_idYmatch_id path parameter.
localelocaleYUI locale, always en-US.

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
match_idStringComposite Match id (Utf8 join key).
sideString
team_idStringComposite Team id (Utf8 join key).
selectionString
provider_idStringUnderlying StatsPerform/Opta provider id (e.g. opta:...).
player_idStringComposite Player id (Utf8 join key).
bib_numberStringShirt/bib number.
role_labelStringHuman position label (e.g. Forward).
roleInt64Numeric position/role code.
media_first_nameStringMedia-style first name.
media_last_nameStringMedia-style last name.
shirt_nameStringName printed on the shirt.
short_nameStringShort team name.
display_nameString
nationalityStringNationality name.
nationality_iso_codeStringISO country code.
is_captainBooleanWhether the player wears the captain's armband.
is_goalkeeperBooleanWhether the player is the goalkeeper.
eventsStringIn-match events attributed to the player (goals/cards/subs).
tactical_x_positionStringFormation-grid X (0-1 normalized canvas).
tactical_y_positionStringFormation-grid Y (0-1 normalized canvas).
average_x_positionStringAverage pitch x-coordinate of the player over the match.
average_y_positionStringAverage pitch y-coordinate of the player over the match.

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
sportsdataverse.errors.NoESPNDataErrorThe host answered 404 -- the requested resource does not exist. The SDP host returned 404 (unknown composite id, or an unmapped match sub-resource).
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nwsl_match_lineups(match_id='nwsl::Football_Match::0b6761e4701749f593690c0f338da74c', season_id='nwsl::Football_Season::0b6761e4701749f593690c0f338da74c')

nwsl_matchdays​

Match days (rounds) for a season.

Endpoint URL: GET https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/{season_id}/matchdays

Valid URL: https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/nwsl::Football_Season::0b6761e4701749f593690c0f338da74c/matchdays?locale=en-US

API ParameterPythonPatternRequiredNullableDescription
season_idseason_idYseason_id path parameter.
localelocaleYUI locale, always en-US.

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
match_set_idStringComposite match-day (match set) id.
provider_idStringUnderlying StatsPerform/Opta provider id (e.g. opta:...).
nameStringStage display name.
season_idStringComposite Season id (Utf8 join key).
competition_idStringComposite Competition id (Utf8 join key).
round_idStringComposite id of the round.
stage_idStringComposite Stage id (nwsl::Football_Stage::{hex}).
indexStringOrdinal position of the match day within the season.
short_nameStringShort team name.
match_set_format_idStringIdentifier of the match-day format.
typeStringType discriminator for the record.
start_date_utcStringSeason window start (ISO-8601 UTC).
end_date_utcStringSeason window end (ISO-8601 UTC).
matchday_statusStringStatus of the match day (scheduled, in progress, completed).

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
sportsdataverse.errors.NoESPNDataErrorThe host answered 404 -- the requested resource does not exist. The SDP host returned 404 (unknown composite id, or an unmapped match sub-resource).
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nwsl_matchdays(season_id='nwsl::Football_Season::0b6761e4701749f593690c0f338da74c')

nwsl_player_stats​

Player-stats leaderboard for a season (paginated).

Endpoint URL: GET https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/{season_id}/stats/players

Valid URL: https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/nwsl::Football_Season::0b6761e4701749f593690c0f338da74c/stats/players?locale=en-US

API ParameterPythonPatternRequiredNullableDescription
season_idseason_idYseason_id path parameter.
localelocaleYUI locale, always en-US.
categorycategoryYStat family: general (default), attack, defence, etc.
roleroleYPosition filter, e.g. all.
directiondirectionYasc or desc.
pagepageY1-based page number.
pageNumElementpage_num_elementYPage size (e.g. 400).

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
rank_labelStringLeaderboard rank label (null unless ranked view).
player_idStringComposite Player id (Utf8 join key).
provider_idStringUnderlying StatsPerform/Opta provider id (e.g. opta:...).
bib_numberStringShirt/bib number.
role_labelStringHuman position label (e.g. Forward).
roleInt64Numeric position/role code.
media_first_nameStringMedia-style first name.
media_last_nameStringMedia-style last name.
shirt_nameStringName printed on the shirt.
short_nameStringShort team name.
display_nameString
nationalityStringNationality name.
nationality_iso_codeStringISO country code.
api_call_request_timeStringServer timestamp the payload was assembled (ISO-8601).
stats_idStringStable stat key (e.g. goals, points, Xg).
stats_labelStringHuman stat name.
stats_label_abbreviationStringShort label (e.g. PTS, GD).
stats_valueStringStat value - integer, string, or array (e.g. form).
stats_unitStringUnit name (usually null).
stats_unit_abbreviationStringUnit abbreviation (usually null).
team_team_idStringClub: Composite Team id (Utf8 join key).
team_provider_idStringClub: underlying StatsPerform/Opta provider id (e.g. opta:...).
team_short_nameStringClub: short team name.
team_official_nameStringClub: official team name.
team_acronym_nameStringClub: 3-letter team code.
team_acronym_name_localizedStringClub: localized 3-letter code.
team_is_team_fakeBooleanClub: true for placeholder/TBD teams.
team_media_nameStringClub: media-style display name.
team_media_short_nameStringClub: short media-style display name.
team_country_codeStringClub: ISO country code.
team_team_typeStringClub: team type (e.g. club).
team_overall_summaryStringClub: Season summary blurb.
team_stadiumStringClub: home venue: {id, providerId, name, cityName, country, address, capacity, yearOfConstruction, mapsGeoCodeLatitude, mapsGeoCodeLongitude, imagery}.
team_all_season_imageryStringClub: per-season crest variants.
team_editorial_social_facebookStringClub editorial: facebook handle or URL.
team_editorial_social_instagramStringClub editorial: instagram handle or URL.
team_editorial_social_xStringClub editorial: x (Twitter) handle or URL.
team_editorial_social_tik_tokStringClub editorial: tikTok handle or URL.
team_editorial_social_you_tubeStringClub editorial: youTube handle or URL.
team_editorial_social_linked_inStringClub editorial: linkedIn handle or URL.
team_editorial_website_urlStringClub editorial: official website URL.
team_editorial_shop_urlStringClub editorial: club shop URL.
team_editorial_tickets_urlStringClub editorial: ticketing URL.
team_editorial_club_primary_colourStringClub editorial: club primary colour (hex).
team_editorial_club_secondary_colourStringClub editorial: club secondary colour (hex).
team_editorial_club_text_colourStringClub editorial: club text colour (hex).
editorial_player_role_within_teamStringEditorial metadata: editorial description of the player's role in the side.

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
sportsdataverse.errors.NoESPNDataErrorThe host answered 404 -- the requested resource does not exist. The SDP host returned 404 (unknown composite id, or an unmapped match sub-resource).
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nwsl_player_stats(season_id='nwsl::Football_Season::0b6761e4701749f593690c0f338da74c')

nwsl_season_matches​

Matches across one or more seasons within a US-format date window.

Endpoint URL: GET https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/multipleSeasonMatches

Valid URL: https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/multipleSeasonMatches?locale=en-US

API ParameterPythonPatternRequiredNullableDescription
seasonIdsseason_idsYComma-separated composite Season ids.
localelocaleYUI locale, always en-US.
startDatestart_dateYWindow start, MM/DD/YYYY (US format).
endDateend_dateYWindow end, MM/DD/YYYY (US format).

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
provider_idStringUnderlying StatsPerform/Opta provider id (e.g. opta:...).
season_idStringComposite Season id (Utf8 join key).
match_idStringComposite Match id (Utf8 join key).
statusStringNormalized match status (e.g. PostMatch, PreMatch, Live).
provider_statusStringRaw provider status string.
phaseStringSeason phase (e.g. RegularSeason, Final Series).
match_date_utcStringKickoff time in UTC (ISO-8601).
match_date_localStringKickoff time in venue-local time.
local_time_utc_offsetStringVenue UTC offset.
is_unknown_kick_off_timeBooleanTrue if kickoff time is TBD.
home_score_pushInt64Home club: live score pushed by the feed for this side.
away_score_pushInt64Away club: live score pushed by the feed for this side.
provider_penalty_score_homeStringProvider-reported: home side's penalty-shootout score.
provider_penalty_score_awayStringProvider-reported: away side's penalty-shootout score.
aggregateStringTwo-leg aggregate label.
win_reasonStringHow the result was decided.
win_team_idStringComposite Team id of the winner (null if draw/unplayed).
previous_legs_resultStringAggregate result of previous legs in a two-legged tie.
stadium_idStringComposite Stadium id for the venue.
stadium_nameStringStadium: stage display name.
city_nameStringCity the stadium is in.
groupString
group_nameString
round_idStringComposite id of the round.
round_nameStringName of the round or series this match belongs to.
schedule_statusStringScheduling status.
provider_home_scoreInt64Provider-reported: home side's score.
provider_away_scoreInt64Provider-reported: away side's score.
group_idString
sub_leagueStringSub-league label.
timeString
additional_timeStringStoppage time added, in minutes.
previous_leg_idStringComposite Match id of the previous leg (two-legged ties).
editorial_broadcasters_broadcaster_national1StringBroadcast listing: first national broadcaster carrying the match.
editorial_broadcasters_broadcaster_national2StringBroadcast listing: second national broadcaster carrying the match.
editorial_broadcasters_broadcaster_national3StringBroadcast listing: third national broadcaster carrying the match.
editorial_broadcasters_broadcaster_international1StringBroadcast listing: first international broadcaster carrying the match.
editorial_broadcasters_broadcaster_international2StringBroadcast listing: second international broadcaster carrying the match.
editorial_broadcasters_broadcaster_international3StringBroadcast listing: third international broadcaster carrying the match.
editorial_highlights_urlStringEditorial metadata: Match highlights URL.
editorial_highlights_national_urlStringEditorial metadata: nationally-geofenced match highlights URL.
editorial_highlights_international_urlStringEditorial metadata: internationally-geofenced match highlights URL.
editorial_tickets_urlStringEditorial metadata: ticketing URL.
editorial_sponsor_imageStringEditorial metadata: sponsor image asset, JSON-encoded.
editorial_theme_nightStringEditorial metadata: theme-night promotion attached to the match.
editorial_editorialsStringEditorial metadata: editorial blurbs attached to the record, JSON-encoded.
home_team_idStringHome club: Composite Team id (Utf8 join key).
home_provider_idStringHome club: underlying StatsPerform/Opta provider id (e.g. opta:...).
home_short_nameStringHome club: short team name.
home_official_nameStringHome club: official team name.
home_acronym_nameStringHome club: 3-letter team code.
home_acronym_name_localizedStringHome club: localized 3-letter code.
home_is_team_fakeBooleanHome club: true for placeholder/TBD teams.
home_media_nameStringHome club: media-style display name.
home_media_short_nameStringHome club: short media-style display name.
home_country_codeStringHome club: ISO country code.
home_team_typeStringHome club: team type (e.g. club).
home_overall_summaryStringHome club: Season summary blurb.
home_stadiumStringHome club: home venue: {id, providerId, name, cityName, country, address, capacity, yearOfConstruction, mapsGeoCodeLatitude, mapsGeoCodeLongitude, imagery}.
home_all_season_imageryStringHome club: per-season crest variants.
home_editorial_social_facebookStringHome club editorial: facebook handle or URL.
home_editorial_social_instagramStringHome club editorial: instagram handle or URL.
home_editorial_social_xStringHome club editorial: x (Twitter) handle or URL.
home_editorial_social_tik_tokStringHome club editorial: tikTok handle or URL.
home_editorial_social_you_tubeStringHome club editorial: youTube handle or URL.
home_editorial_social_linked_inStringHome club editorial: linkedIn handle or URL.
home_editorial_website_urlStringHome club editorial: official website URL.
home_editorial_shop_urlStringHome club editorial: club shop URL.
home_editorial_tickets_urlStringHome club editorial: ticketing URL.
home_editorial_club_primary_colourStringHome club editorial: club primary colour (hex).
home_editorial_club_secondary_colourStringHome club editorial: club secondary colour (hex).
home_editorial_club_text_colourStringHome club editorial: club text colour (hex).
away_team_idStringAway club: Composite Team id (Utf8 join key).
away_provider_idStringAway club: underlying StatsPerform/Opta provider id (e.g. opta:...).
away_short_nameStringAway club: short team name.
away_official_nameStringAway club: official team name.
away_acronym_nameStringAway club: 3-letter team code.
away_acronym_name_localizedStringAway club: localized 3-letter code.
away_is_team_fakeBooleanAway club: true for placeholder/TBD teams.
away_media_nameStringAway club: media-style display name.
away_media_short_nameStringAway club: short media-style display name.
away_country_codeStringAway club: ISO country code.
away_team_typeStringAway club: team type (e.g. club).
away_overall_summaryStringAway club: Season summary blurb.
away_stadiumStringAway club: home venue: {id, providerId, name, cityName, country, address, capacity, yearOfConstruction, mapsGeoCodeLatitude, mapsGeoCodeLongitude, imagery}.
away_all_season_imageryStringAway club: per-season crest variants.
away_editorial_social_facebookStringAway club editorial: facebook handle or URL.
away_editorial_social_instagramStringAway club editorial: instagram handle or URL.
away_editorial_social_xStringAway club editorial: x (Twitter) handle or URL.
away_editorial_social_tik_tokStringAway club editorial: tikTok handle or URL.
away_editorial_social_you_tubeStringAway club editorial: youTube handle or URL.
away_editorial_social_linked_inStringAway club editorial: linkedIn handle or URL.
away_editorial_website_urlStringAway club editorial: official website URL.
away_editorial_shop_urlStringAway club editorial: club shop URL.
away_editorial_tickets_urlStringAway club editorial: ticketing URL.
away_editorial_club_primary_colourStringAway club editorial: club primary colour (hex).
away_editorial_club_secondary_colourStringAway club editorial: club secondary colour (hex).
away_editorial_club_text_colourStringAway club editorial: club text colour (hex).
match_set_match_set_idStringMatch day (round): Composite match-day (match set) id.
match_set_provider_idStringMatch day (round): underlying StatsPerform/Opta provider id (e.g. opta:...).
match_set_nameStringMatch day (round): stage display name.
match_set_season_idStringMatch day (round): Composite Season id (Utf8 join key).
match_set_competition_idStringMatch day (round): Composite Competition id (Utf8 join key).
match_set_round_idStringMatch day (round): Composite id of the round.
match_set_stage_idStringMatch day (round): Composite Stage id (nwsl::Football_Stage::{hex}).
match_set_indexStringMatch day (round): ordinal position of the match day within the season.
match_set_short_nameStringMatch day (round): short team name.
match_set_match_set_format_idStringMatch day (round): identifier of the match-day format.
match_set_typeStringMatch day (round): type discriminator for the record.
match_set_start_date_utcStringMatch day (round): Season window start (ISO-8601 UTC).
match_set_end_date_utcStringMatch day (round): Season window end (ISO-8601 UTC).
match_set_matchday_statusStringMatch day (round): status of the match day (scheduled, in progress, completed).

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
sportsdataverse.errors.NoESPNDataErrorThe host answered 404 -- the requested resource does not exist. The SDP host returned 404 (unknown composite id, or an unmapped match sub-resource).
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nwsl_season_matches()

nwsl_stages​

Competition stages for a season (may be empty for league play).

Endpoint URL: GET https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/{season_id}/stages

Valid URL: https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/nwsl::Football_Season::0b6761e4701749f593690c0f338da74c/stages?locale=en-US

API ParameterPythonPatternRequiredNullableDescription
season_idseason_idYseason_id path parameter.
localelocaleYUI locale, always en-US.

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
stage_idStringComposite Stage id (nwsl::Football_Stage::{hex}).
nameStringStage display name.

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
sportsdataverse.errors.NoESPNDataErrorThe host answered 404 -- the requested resource does not exist. The SDP host returned 404 (unknown composite id, or an unmapped match sub-resource).
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nwsl_stages(season_id='nwsl::Football_Season::0b6761e4701749f593690c0f338da74c')

nwsl_standings​

Overall standings table for a season (table/home/away splits).

Endpoint URL: GET https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/{season_id}/standings/overall

Valid URL: https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/nwsl::Football_Season::0b6761e4701749f593690c0f338da74c/standings/overall?locale=en-US

API ParameterPythonPatternRequiredNullableDescription
season_idseason_idYseason_id path parameter.
localelocaleYUI locale, always en-US.
orderByorder_byYSort field, e.g. rank.
directiondirectionYasc or desc.

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
split_typeString
achievement_statusesStringAchievement flags (champion, clinched, etc.).
noteStringFree-text standings note (null when none).
team_idStringComposite Team id (Utf8 join key).
provider_idStringUnderlying StatsPerform/Opta provider id (e.g. opta:...).
short_nameStringShort team name.
official_nameStringOfficial team name.
acronym_nameString3-letter team code.
acronym_name_localizedStringLocalized 3-letter code.
is_team_fakeBooleanTrue for placeholder/TBD teams.
media_nameStringMedia-style display name.
media_short_nameStringShort media-style display name.
country_codeStringISO country code.
team_typeStringTeam type (e.g. club).
overall_summaryStringSeason summary blurb.
stadiumStringHome venue: {id, providerId, name, cityName, country, address, capacity, yearOfConstruction, mapsGeoCodeLatitude, mapsGeoCodeLongitude, imagery}.
all_season_imageryStringPer-season crest variants.
rankInt64Position within the group/table.
teamStringTeam identity block the player belongs to.
pointsInt64Competition points.
qualification_qualification_idStringQualification band: identifier of the qualification band.
qualification_qualification_labelStringQualification band: display label of the qualification band.
qualificationStringQualification band (e.g. playoff/Final Series).
matches_playedInt64Matches played in this split.
winInt64Matches won.
drawInt64Matches drawn.
loseInt64Matches lost.
goals_forInt64Goals scored.
goals_againstInt64Goals conceded.
goal_differenceInt64Goals scored minus goals conceded.
movementStringPosition movement versus the previous matchday.
formStringRecent results sequence, JSON-encoded (the API sends an array).

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
sportsdataverse.errors.NoESPNDataErrorThe host answered 404 -- the requested resource does not exist. The SDP host returned 404 (unknown composite id, or an unmapped match sub-resource).
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nwsl_standings(season_id='nwsl::Football_Season::0b6761e4701749f593690c0f338da74c')

nwsl_team_stats​

Team-stats leaderboard for a season.

Endpoint URL: GET https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/{season_id}/stats/teams

Valid URL: https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/nwsl::Football_Season::0b6761e4701749f593690c0f338da74c/stats/teams?locale=en-US

API ParameterPythonPatternRequiredNullableDescription
season_idseason_idYseason_id path parameter.
localelocaleYUI locale, always en-US.
categorycategoryYStat family: general (default), attack, defence, etc.

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
rank_labelStringLeaderboard rank label (null unless ranked view).
team_idStringComposite Team id (Utf8 join key).
provider_idStringUnderlying StatsPerform/Opta provider id (e.g. opta:...).
short_nameStringShort team name.
official_nameStringOfficial team name.
acronym_nameString3-letter team code.
acronym_name_localizedStringLocalized 3-letter code.
is_team_fakeBooleanTrue for placeholder/TBD teams.
media_nameStringMedia-style display name.
media_short_nameStringShort media-style display name.
country_codeStringISO country code.
team_typeStringTeam type (e.g. club).
overall_summaryStringSeason summary blurb.
stadiumStringHome venue: {id, providerId, name, cityName, country, address, capacity, yearOfConstruction, mapsGeoCodeLatitude, mapsGeoCodeLongitude, imagery}.
all_season_imageryStringPer-season crest variants.
stats_idStringStable stat key (e.g. goals, points, Xg).
stats_labelStringHuman stat name.
stats_label_abbreviationStringShort label (e.g. PTS, GD).
stats_valueStringStat value - integer, string, or array (e.g. form).
stats_unitStringUnit name (usually null).
stats_unit_abbreviationStringUnit abbreviation (usually null).
editorial_social_facebookStringEditorial metadata: facebook handle or URL.
editorial_social_instagramStringEditorial metadata: instagram handle or URL.
editorial_social_xStringEditorial metadata: x (Twitter) handle or URL.
editorial_social_tik_tokStringEditorial metadata: tikTok handle or URL.
editorial_social_you_tubeStringEditorial metadata: youTube handle or URL.
editorial_social_linked_inStringEditorial metadata: linkedIn handle or URL.
editorial_website_urlStringEditorial metadata: official website URL.
editorial_shop_urlStringEditorial metadata: club shop URL.
editorial_tickets_urlStringEditorial metadata: ticketing URL.
editorial_club_primary_colourStringEditorial metadata: club primary colour (hex).
editorial_club_secondary_colourStringEditorial metadata: club secondary colour (hex).
editorial_club_text_colourStringEditorial metadata: club text colour (hex).

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
sportsdataverse.errors.NoESPNDataErrorThe host answered 404 -- the requested resource does not exist. The SDP host returned 404 (unknown composite id, or an unmapped match sub-resource).
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nwsl_team_stats(season_id='nwsl::Football_Season::0b6761e4701749f593690c0f338da74c')

nwsl_teams​

Teams participating in a season.

Endpoint URL: GET https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/{season_id}/teams

Valid URL: https://api-sdp.nwslsoccer.com/v1/nwsl/football/seasons/nwsl::Football_Season::0b6761e4701749f593690c0f338da74c/teams?locale=en-US

API ParameterPythonPatternRequiredNullableDescription
season_idseason_idYseason_id path parameter.
localelocaleYUI locale, always en-US.

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
team_idStringComposite Team id (Utf8 join key).
provider_idStringUnderlying StatsPerform/Opta provider id (e.g. opta:...).
short_nameStringShort team name.
official_nameStringOfficial team name.
acronym_nameString3-letter team code.
acronym_name_localizedStringLocalized 3-letter code.
is_team_fakeBooleanTrue for placeholder/TBD teams.
media_nameStringMedia-style display name.
media_short_nameStringShort media-style display name.
country_codeStringISO country code.
team_typeStringTeam type (e.g. club).
overall_summaryStringSeason summary blurb.
all_season_imageryStringPer-season crest variants.
stadium_idStringComposite Stadium id for the venue.
stadium_provider_idStringStadium: underlying StatsPerform/Opta provider id (e.g. opta:...).
stadium_nameStringStadium: stage display name.
stadium_city_nameStringStadium: city the stadium is in.
stadium_countryStringStadium: country the stadium is in.
stadium_addressStringStadium: street address of the stadium.
stadium_capacityInt64Stadium: seating capacity of the stadium.
stadium_year_of_constructionInt64Stadium: year the stadium was built.
stadium_maps_geo_code_latitudeStringStadium: latitude in decimal degrees.
stadium_maps_geo_code_longitudeStringStadium: longitude in decimal degrees.
editorial_social_facebookStringEditorial metadata: facebook handle or URL.
editorial_social_instagramStringEditorial metadata: instagram handle or URL.
editorial_social_xStringEditorial metadata: x (Twitter) handle or URL.
editorial_social_tik_tokStringEditorial metadata: tikTok handle or URL.
editorial_social_you_tubeStringEditorial metadata: youTube handle or URL.
editorial_social_linked_inStringEditorial metadata: linkedIn handle or URL.
editorial_website_urlStringEditorial metadata: official website URL.
editorial_shop_urlStringEditorial metadata: club shop URL.
editorial_tickets_urlStringEditorial metadata: ticketing URL.
editorial_club_primary_colourStringEditorial metadata: club primary colour (hex).
editorial_club_secondary_colourStringEditorial metadata: club secondary colour (hex).
editorial_club_text_colourStringEditorial metadata: club text colour (hex).

return_parsed=False — the raw JSON Dict payload, unparsed.

Raises​

ExceptionDescription
sportsdataverse.errors.NoESPNDataErrorThe host answered 404 -- the requested resource does not exist. The SDP host returned 404 (unknown composite id, or an unmapped match sub-resource).
ValueErrorThe host answered 400 / 422 -- the request is wrong; retrying cannot help.
AssetFetchErrorThe fetch failed (a non-2xx answer or a connection failure after retries, e.g. 401/403/429/5xx, or an empty or unreadable 200 body) -- the answer is unknown, not empty.

Example​

nwsl_teams(season_id='nwsl::Football_Season::0b6761e4701749f593690c0f338da74c')