Official SDK
Build against NFLMeta with a typed, official client layer instead of hand-rolling every request.
NFLMeta now has official SDKs for TypeScript/JavaScript and Python. This page is the high-level landing page. The actual SDK documentation lives under /api-docs/sdk.
Pass an API key once and the SDK sends X-NFLMeta-Key automatically on protected requests.
You still get the real API envelope: data, optional meta, response status, and parsed rate-limit headers.
Wrapped resource clients cover the main surfaces, but raw client.get(path, { query }) is still available for new routes.
Package Names
Use the official package names consistently
This page stays intentionally high level. For client setup, examples, typed errors, and method usage, go straight to /api-docs/sdk.
Package Targets
@nfldb/sdk
nfldbCurrent Source Of Truth
sdk/typescript
sdk/pythonDocumentation Path
/api-docs/sdk
/api-docs/identifiers
/api-docs/core-endpoints
/api-docs/reference-dataChoose Your Client
Pick the runtime first, then read the SDK docs
The SDKs are thin on purpose. They help with auth headers, typed errors, rate-limit parsing, and resource methods, but they do not replace the API contract.
What To Expect
The SDK is a client layer, not a second docs system
Keep endpoint behavior, identifiers, filters, and response contracts in the API docs. Use the SDK docs for package setup, method usage, typed errors, and raw escape-hatch examples.
/api-docs/sdk -> SDK setup and examples/api-docs/identifiers -> canonical ids and keys/api-docs/core-endpoints -> app-facing endpoint families/api-docs/reference-data -> raw and historical exports