Developer Reference

NFLMeta API

Version 1.0.0. Structured endpoint reference with authentication, parameters, and live-ready request examples.

Curated

Build Team Pages

Best for: App pages, profile screens, and browse UX

Start here for customer-facing team experiences. These payloads are joined and presentation-ready.

  • /api/v1/teams/{abbr}/profile
  • /api/v1/teams/{abbr}
  • /api/v1/teams/{abbr}/games
Raw

Export Raw Team History

Best for: Branding, timelines, and research exports

Use these when you need table-shaped team history and do not want the app-facing profile wrapper.

  • /api/v1/teams/{abbr}/history
  • /api/v1/reference/team-name-histories
  • /api/v1/reference/team-logo-histories
Mixed

Player Lookup

Best for: Player profiles and career data

Use the list/detail endpoints for lookup, history for honors and roster data, and games for week-level stat lines like passing yards, touchdowns, and interceptions.

  • /api/v1/players
  • /api/v1/players/{player_key}
  • /api/v1/players/{player_key}/history
  • /api/v1/players/{player_key}/games
Mixed

Game Data

Best for: Schedules, scoreboards, and game exports

Choose extras for joined app-ready data and stats for one-game raw stat table exports.

  • /api/v1/games
  • /api/v1/games/{id}/extras
  • /api/v1/games/{id}/stats
Mixed

Playoff and Super Bowl

Best for: Playoff apps, bracket data, and full postseason exports

Use supplemental for field-complete playoff rows and the Super Bowl endpoints for curated historical packages.

  • /api/v1/playoffs/picture
  • /api/v1/playoff-games/{id}/extras
  • /api/v1/playoff-games/{id}/supplemental
  • /api/v1/super-bowls/{season_year}
Raw

Reference Tables

Best for: Research, warehousing, and direct table-style access

These routes are the fastest path to raw reference rows without the curated wrappers.

  • /api/v1/reference/coaches
  • /api/v1/reference/officials
  • /api/v1/reference/venues
  • /api/v1/reference/stadiums

Authentication

All protected endpoints require the header below on every request.

X-NFLMeta-Key: <YOUR_KEY>

Responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-RateLimit-Policy.

GETCurated/api/v1/assets/images

List curated image assets

Best For

General integration and programmatic access

Operation ID: listImageAssets

Parameters

Path parameters are part of the URL itself. Query parameters are optional filters you add after a ?.

NameInWhat it meansTypeRequiredExample
groupqueryall|brand|playersnobrand
searchquerystringnologo
limitqueryMaximum number of rows to return in one response.integerno50
offsetqueryNumber of rows to skip before returning results. Use with limit for pagination.integerno0

Example Request

GET /api/v1/assets/images?limit=50

Example Response

{
  "data": [
    {
      "id": "brand-nflmeta-logo",
      "group": "brand",
      "key": "nflmeta_logo",
      "label": "NFLMeta Logo",
      "url": "https://nfldb.org/hero_main/NFLMeta_Logo.png",
      "source": "local"
    }
  ],
  "meta": {
    "total": 11,
    "limit": 100,
    "offset": 0,
    "returned": 1,
    "has_more": false,
    "groups": [
      "all",
      "brand",
      "players"
    ]
  }
}
GETCurated/api/v1/assets/logos

List logo assets

Best For

General integration and programmatic access

Operation ID: listLogoAssets

Parameters

Path parameters are part of the URL itself. Query parameters are optional filters you add after a ?.

NameInWhat it meansTypeRequiredExample
categoryqueryall|team|season|super_bowl|stadiumnoteam
searchquerystringnosteelers
limitqueryMaximum number of rows to return in one response.integerno50
offsetqueryNumber of rows to skip before returning results. Use with limit for pagination.integerno0

Example Request

GET /api/v1/assets/logos?limit=50

Example Response

{
  "data": [
    {
      "id": "team-pit",
      "category": "team",
      "key": "PIT",
      "label": "Pittsburgh Steelers",
      "url": "https://nfldb.org/hero_main/logos/pittsburgh-steelers-logo-transparent.png",
      "source": "local"
    }
  ],
  "meta": {
    "total": 32,
    "limit": 100,
    "offset": 0,
    "returned": 1,
    "has_more": false,
    "categories": [
      "all",
      "team",
      "season",
      "super_bowl",
      "stadium"
    ]
  }
}