NHL

List players for NHL

⚠️ This endpoint is documented but not yet live. Calls return 503 until the NHL data load is in production.

get/api/v1/nhl/players

Request

  • Base URL: https://api.stat-api.com
  • URL: https://api.stat-api.com/api/v1/nhl/players
  • Auth: HTTP bearer

Query parameters

team_idinteger

Filter to players whose current team_id matches. Null team_id rows (free agents, retired) are excluded when this filter is applied.

roster_status'active' | 'injured_reserve' | 'inactive' | 'free_agent'

Filter by canonical roster status. NHL source granularity is coarse: "active" (on a current team roster), "free_agent" (no team), "inactive" (not currently rostered); injured_reserve appears where derivable. The "on a team now" set is {active, injured_reserve}.

limitinteger

Page size.

from_idinteger

Return rows with id strictly greater than this value, in ascending id order. To walk every row, start at 0 and then pass the previous response's next_from_id. Without it, the first page uses the table's default sort and returns no cursor.

format'json' | 'csv'

Response format: json (default) or csv — the same rows as CSV with raw values, a blank cell for null, and X-Next-From-Id when another page exists. With format=csv only, the API key may be passed as the key query param (for Google Sheets IMPORTDATA); use a separate, revocable key for that.

Response

players rows matching the declared filter set.

has_moreboolean required

True when a full page came back, so more rows can exist.

limitinteger required

Page size used for this response.

next_from_idinteger nullable required

Pass this as from_id on the next request to page forward. null on the terminal page, and on a first page requested without from_id (that page uses the default sort): to walk every row, start with from_id=0.

Changes

No recorded changes to this operation across all 3 revisions of this API.