Installation

From account creation to first successful NFLMeta request.

This page is the shortest setup path for new builders. It covers account creation, API key use, the first request to make, and where to go next once the connection works.

Read this first

Installation is the shortest path from zero to first successful request. It is the setup guide, not the full reference.

Then read the contract

Use API Docs for the full endpoint surface, examples, and the raw-versus-curated split.

Then confirm pricing

Use Pricing and FAQ once you know your request shape, quota expectations, and key management pattern.

Step 1

Create the account

Register, verify the sign-in flow, and let NFLMeta create the default free account state.

Step 2

Copy your API key

Open Customer Portal and copy the active key you want to use. Every protected request uses the same X-NFLMeta-Key header.

Step 3

Make one successful request

Start with a simple object route like /api/v1/teams/NE or /api/v1/coaches/mike-vrabel so you can confirm auth and payload shape quickly.

Step 4

Move into slices and drilldowns

Once the key works, move to smaller slice routes and /{field} drilldowns so your client only pulls what it actually needs.

First request

Use one clean object route first so you can confirm auth and response shape before you start composing more specialized calls.

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

How to think about the API

  • Use list endpoints to discover ids, keys, abbreviations, and available years.
  • Use object slices when you need one entity.
  • Use /{field} drilldowns when you need one value.
  • Use raw /reference routes intentionally for table-shaped exports.

Where to go next

  • API Docs for the full contract and copy-paste request patterns.
  • FAQ for plan, quota, identifier, and auth answers.
  • Pricing for quota envelopes and overage posture.
  • Trust Center for reliability, data quality, and operating posture.