Finding Identifiers

Find keys and ids before you hit single-record routes.

Users should not have to guess identifiers. Start from a list, search, or catalog endpoint, then carry the returned key or id into the object route you actually want.

Identifiers

Discover, Then Drill Down

This API uses stable route identifiers such as abbr, player_key, coach_key,venue_key, and numeric game ids. Use the discovery pattern below instead of guessing them.

Best For

Finding The Right Key First

Use this page when you know the person, team, venue, or game concept but do not yet know the exact route identifier required by the single-record endpoint.

Common IDs

Player Keys, Coach Keys, Game IDs, And Team Abbreviations

The most common discovery path is list or search first, then carry the returned player_key, coach_key, numeric game id, or abbr into a narrower object route.

Discovery Rule

Lists For Discovery, Objects For Reads

Use browse and search endpoints to discover identifiers, then switch to the specific object or field route you actually need instead of repeatedly querying the list surface.

Avoid

Do Not Guess Identifiers

Do not assume a slug, abbreviation, or legacy id format without checking. This page exists to keep clients from generating avoidable 404 responses and brittle integrations.

Find The Identifier First

Find a team abbreviation

Use the teams list first when you do not already know the canonical NFL abbreviation used by team routes.

1.GET /api/v1/teams?q=ravens
2.Use the returned abbr with /api/v1/teams/{abbr} and team subroutes
Find The Identifier First

Find a game id

Use the games index first, then take the returned id into the single-game routes.

1.GET /api/v1/games?season=2024&team=PIT
2.Use the returned id with /api/v1/games/{id}, /api/v1/games/{id}/{field}, or /api/v1/games/{id}/extras
Find The Identifier First

Find a player key

Use the player catalog/list endpoint first, then copy the canonical player_key from the matching row.

1.GET /api/v1/players?q=lamar
2.Use the returned player_key with /api/v1/players/{player_key} and player subroutes
Find The Identifier First

Find a coach key

Use the coach list endpoint first if you do not already know the canonical coach_key slug.

1.GET /api/v1/coaches?q=tomlin
2.Use the returned coach_key with /api/v1/coaches/{coach_key} and coach subroutes
Find The Identifier First

Find a contributor key

Use the contributor list endpoint first when you know the contributor name but not the canonical contributor_key.

1.GET /api/v1/contributors?search=nunn
2.Use the returned contributor_key with /api/v1/contributors/{contributor_key} and contributor subroutes
Find The Identifier First

Find a staff key

Use the staff list endpoint first when you know the current coach or staffer name but not the canonical staff_key.

1.GET /api/v1/staff?search=cignetti
2.Use the returned staff_key with /api/v1/staff/{staff_key} and staff subroutes
Find The Identifier First

Find an executive key

Use the executive list endpoint first when you know the executive name or team text but not the canonical executive_key.

1.GET /api/v1/executives?search=kraft
2.Use the returned executive_key with /api/v1/executives/{executive_key} and executive subroutes
Find The Identifier First

Find a Hall of Fame election year

Use the Hall of Fame list first when you want to inspect ballot coverage, then switch to one election-year route.

1.GET /api/v1/hall-of-fame?year_from=2021&year_to=2021
2.Use the returned year with /api/v1/hall-of-fame/{election_year} and /api/v1/hall-of-fame/{election_year}/{field}
Find The Identifier First

Find a venue key

Use the raw venue reference list first when you need a canonical venue_key for one stadium or historical venue record.

1.GET /api/v1/reference/venues?q=arrowhead
2.Use the returned venue_key with /api/v1/reference/venues/{venue_key}
Find The Identifier First

Find an official key

Use the raw officials reference list first when you want the canonical official_key for one referee or crew member.

1.GET /api/v1/reference/officials?q=blakeman
2.Use the returned official_key with /api/v1/reference/officials/{official_key}
Find The Identifier First

Find a playoff game id

Start from the Super Bowl or playoff summary routes, then take the returned playoff game id into postseason detail routes.

1.GET /api/v1/super-bowls/2024 or GET /api/v1/playoffs/picture?season=2024
2.Use the returned id with /api/v1/playoff-games/{id}, /api/v1/playoff-games/{id}/{field}, or /api/v1/playoff-games/{id}/extras
Find The Identifier First

Find a season year

Season routes use the canonical year directly, so discover it from the season catalog if you are browsing available coverage.

1.GET /api/v1/seasons
2.Use the returned year with /api/v1/season/{year} and season subroutes