NhlApiDocumentation SDK

NHL API Documentation client, generated from the OpenAPI spec.

This is an unofficial SDK for the NHL API Documentation public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.

TypeScript, Python, PHP, Golang, Ruby, Lua SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.

Entities, not endpoints

This SDK exposes the API as a small set of semantic entities — Conference, Division, Game, Player, PlayerStat, Roster, Schedule, Standing and Team — that you call directly, instead of assembling URL paths and query strings. Entities are Capitalised to mark them as the primary surface, each with the operations they support (list, load):

const client = new NhlApiDocumentationSDK()
const items = await client.Conference().list()

Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.

Packages

Quickstart

TypeScript

import { NhlApiDocumentationSDK } from '@voxgig-sdk/nhl-api-documentation'

const client = new NhlApiDocumentationSDK()

// List all conferences (returns Conference[])
const conferences = await client.Conference().list()
for (const conference of conferences) {
  console.log(conference)
}

See the TypeScript README for the full guide.

Surfaces

Use it from an AI agent (MCP)

The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:

cd go-mcp && go build -o nhl-api-documentation-mcp .

Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):

{
  "mcpServers": {
    "nhl-api-documentation": {
      "command": "/abs/path/to/nhl-api-documentation-mcp"
    }
  }
}

Entities

The API exposes 9 entities:

The operations available across these entities are load, list — see each entity’s own list above for exactly which it supports.

Quickstart in other languages

Python

from nhlapidocumentation_sdk import NhlApiDocumentationSDK

client = NhlApiDocumentationSDK()

# List all conferences (returns a list, raises on error)
conferences = client.Conference().list()
for conference in conferences:
    print(conference)

# Load a specific conference (returns the record, raises on error)
conference = client.Conference().load({"id": "example_id"})
print(conference)

PHP

<?php
require_once 'nhlapidocumentation_sdk.php';

$client = new NhlApiDocumentationSDK();

// List all conferences (returns an array; throws on error)
$conferences = $client->Conference()->list();
print_r($conferences);

// Load a specific conference (returns the bare record; throws on error)
$conference = $client->Conference()->load(["id" => "example_id"]);
print_r($conference);

Golang

import sdk "github.com/voxgig-sdk/nhl-api-documentation-sdk/go"

client := sdk.New()

// List all conferences
conferences, err := client.Conference(nil).List(nil, nil)
fmt.Println(conferences)

Ruby

require_relative "NhlApiDocumentation_sdk"

client = NhlApiDocumentationSDK.new

# List all conferences (returns an Array; raises on error)
conferences = client.Conference.list
puts conferences

# Load a specific conference (returns the bare record; raises on error)
conference = client.Conference.load({ "id" => "example_id" })
puts conference

Lua

local sdk = require("nhl-api-documentation_sdk")

local client = sdk.new()

-- List all conferences
local conferences, err = client:Conference():list()
print(conferences)

-- Load a specific conference
local conference, err = client:Conference():load({ id = "example_id" })
print(conference)

Unit testing in offline mode

Every SDK ships a test mode that swaps the HTTP transport for an in-memory mock, so unit tests run offline.

TypeScript

const client = NhlApiDocumentationSDK.test()
const conference = await client.Conference().list()
// conference is a bare Conference populated with mock data
console.log(conference)

Python

client = NhlApiDocumentationSDK.test()
conference = client.Conference().list()
print(conference)

PHP

// Seed fixture data so offline calls resolve without a live server.
$client = NhlApiDocumentationSDK::test([
    "entity" => ["conference" => ["test01" => ["id" => "test01"]]],
]);
$conference = $client->Conference()->list();

Golang

client := sdk.Test()
result, err := client.Conference(nil).List(
    nil, nil,
)

Ruby

# Seed fixture data so offline calls resolve without a live server.
client = NhlApiDocumentationSDK.test({
  "entity" => { "conference" => { "test01" => { "id" => "test01" } } },
})
conference = client.Conference.list()

Lua

local client = sdk.test()
local result, err = client:Conference():list()

Direct and prepare

For endpoints the entity model doesn’t cover, use the low-level methods:

• direct(fetchargs) — build and send an HTTP request in one step.
• prepare(fetchargs) — build the request without sending it.

Both accept a map with path, method, params, query, headers, and body. See the How-to guides below.

How-to guides

Make a direct API call

When the entity interface does not cover an endpoint, use direct:

TypeScript:

const result = await client.direct({
  path: '/api/resource/{id}',
  method: 'GET',
  params: { id: 'example' },
})
if (result instanceof Error) {
  throw result
}
console.log(result.data)

Python:

result = client.direct({
    "path": "/api/resource/{id}",
    "method": "GET",
    "params": {"id": "example"},
})

PHP:

$result = $client->direct([
    "path" => "/api/resource/{id}",
    "method" => "GET",
    "params" => ["id" => "example"],
]);

Go:

result, err := client.Direct(map[string]any{
    "path":   "/api/resource/{id}",
    "method": "GET",
    "params": map[string]any{"id": "example"},
})

Ruby:

result = client.direct({
  "path" => "/api/resource/{id}",
  "method" => "GET",
  "params" => { "id" => "example" },
})

Lua:

local result, err = client:direct({
  path = "/api/resource/{id}",
  method = "GET",
  params = { id = "example" },
})

Advanced

Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.

Every SDK call runs the same five-stage pipeline:

1. Point — resolve the API endpoint from the operation definition.
2. Spec — build the HTTP specification (URL, method, headers, body).
3. Request — send the HTTP request.
4. Response — receive and parse the response.
5. Result — extract the result data for the caller.

A feature hook fires at each stage (e.g. PrePoint, PreSpec, PreRequest), so features can inspect or modify the pipeline without forking the SDK.

Features

Pass custom features via the extend option at construction time.

Per-language documentation

• TypeScript
• Python
• PHP
• Golang
• Ruby
• Lua

Upstream API

This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.

• Upstream API: https://gitlab.com/dword4/nhlapi

Security

Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.

Generated from the NHL API Documentation OpenAPI spec by @voxgig/sdkgen.