Quickstart

Make your first successful NFLMeta API request.

This is the fastest path from account creation to a working request. Start here if you are evaluating the API or wiring up a client for the first time.

Docs Overview Search Docs OpenAPI FAQ

Quickstart

Learn The Model In Four Steps

The shortest path is simple: get a key, call one stable object endpoint, learn how identifiers work, then expand into the endpoint family that fits your use case. If you already know you want a client library instead of raw HTTP, switch to /api-docs/sdk.

Step By Step

How To Use This API

1. Get a key

Create an account, open Customer Portal, and copy your API key. Every protected request uses the same X-NFLMeta-Key header.

2. Pick the smallest endpoint

If you need one object, start with the narrowest slice for that object. If you need one field, use the matching /{field} drilldown.

3. Use list endpoints only for lists

Collection endpoints are best for browse, search, and pagination. Do not treat them like item-addressable objects.

4. Move to raw exports intentionally

Use /reference or raw stats endpoints only when you want table-shaped rows for ETL, warehousing, or research workflows.

Copy And Paste

First Successful Request

curl

curl -H 'X-NFLMeta-Key: YOUR_KEY' https://nflmeta.org/api/v1/teams/NE

JavaScript

const res = await fetch("https://nflmeta.org/api/v1/teams/NE", {
  headers: { "X-NFLMeta-Key": process.env.NFLMETA_KEY! }
});
const json = await res.json();

Python

import requests

res = requests.get(
    "https://nflmeta.org/api/v1/teams/NE",
    headers={"X-NFLMeta-Key": "YOUR_KEY"},
)
print(res.json())

Live Example

Pull one stable team object

Good first check for auth, object shape, and the general naming model used throughout the API.

Request

curl -H 'X-NFLMeta-Key: YOUR_KEY' https://nflmeta.org/api/v1/teams/NE

Response Shape

{
  "data": {
    "abbr": "NE",
    "team_name": "New England Patriots",
    "conference": "AFC",
    "division": "East"
  }
}

Live Example

Pull one field instead of a full object

This is the model to prefer when the client only needs one stable value and does not want to trim the object client-side.

Request

curl -H 'X-NFLMeta-Key: YOUR_KEY' https://nflmeta.org/api/v1/season/2024/champion_team_abbr

Response Shape

{
  "data": {
    "field": "champion_team_abbr",
    "value": "PHI"
  }
}

Live Sample

Check current usage and quota

Good first account-level request after signup if you want to confirm auth, quota headers, and live key wiring before product work.

Request

curl -H 'X-NFLMeta-Key: YOUR_KEY' https://nflmeta.org/api/v1/usage

Response Shape

{
  "data": {
    "billing_plan": "free",
    "monthly_quota": 500,
    "monthly_usage": 12,
    "remaining": 488
  }
}

Live Sample

Inspect one game object

Useful when the integration is matchup pages, recaps, schedules, or game detail pages and you want one stable item payload first.

Request

curl -H 'X-NFLMeta-Key: YOUR_KEY' https://nflmeta.org/api/v1/games/11565

Response Shape

{
  "data": {
    "id": 11565,
    "season": 2024,
    "week": 1,
    "away_team_abbr": "PIT",
    "home_team_abbr": "ATL"
  }
}

Start Here

Start with one team object

Best first request if you want to confirm auth, inspect shape, and understand the slice-and-field model.

/api/v1/teams/NE

Start Here

Fetch one single field

Best first drilldown request when you want the smallest stable payload possible.

/api/v1/season/2024/champion_team_abbr

Start Here

Inspect one full game object

Best first app-style payload if your integration is schedule, recaps, matchups, or game detail heavy.

/api/v1/games/11565

Start Here

Pull one raw reference row

Best first raw export request if you are evaluating warehouse or ETL-style access.

/api/v1/reference/venues/geha-field-at-arrowhead-stadium