# NHL — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Access data from nhl.com.

**Category:** Sports | **Website:** [nhl.com/](https://nhl.com/) | **Docs:** [parse.bot/marketplace/fc536a51-ef60-4b2f-a7ae-78ea0fe6d4d9/nhl-com-api](https://parse.bot/marketplace/fc536a51-ef60-4b2f-a7ae-78ea0fe6d4d9/nhl-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/nhl/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get gamecenter boxscore

Fetch detailed boxscore for a specific game including player stats (goals, assists, TOI, shots, hits, blocks) for both teams. Returns forwards, defense, and goalies arrays for each team with individual game statistics.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `game_id` | string | Yes | NHL game ID (e.g., 2024020705). Game IDs can be found in schedule or scores responses. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nhl/get-gamecenter-boxscore \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"game_id":"<string>"}'
```

### Get player landing

Fetch comprehensive player profile and summary stats including career totals, featured season stats, awards, and recent game log. Returns biographical details, draft info, current team, and full statistical breakdown for regular season and playoffs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `player_id` | string | Yes | NHL player ID (e.g., 8478402 for Connor McDavid, 8477939 for William Nylander, 8477934 for Leon Draisaitl). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nhl/get-player-landing \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"player_id":"<string>"}'
```

### Get projected lineups

Fetch recent NHL news articles related to projected lineups and game day content. Articles include headlines, summaries, team context, and thumbnail images. Returns paginated results from the NHL CMS.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Max number of articles to return. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nhl/get-projected-lineups \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>"}'
```

### Get schedule

Fetch the full NHL game schedule for a given date. Returns a week of games centered around the requested date, including game details, broadcast info, and scores for completed games. The gameWeek array contains one entry per day with that day's games.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `date` | string | No | Date in YYYY-MM-DD format, or 'now' for current schedule. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nhl/get-schedule \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"date":"<string>"}'
```

### Get scores

Fetch live and final scores for a given date. Returns games with scores, shots on goal, goal scorers, and broadcast information. The games array contains detailed scoring info including individual goals.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `date` | string | No | Date in YYYY-MM-DD format, or 'now' for current scores. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nhl/get-scores \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"date":"<string>"}'
```

### Get standings

Fetch current or historical NHL standings. Returns all teams with points, wins, losses, and other statistics sorted by league standing. Each entry includes division, conference, home/road splits, and streak info.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `date` | string | No | Date in YYYY-MM-DD format, or 'now' for current standings. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nhl/get-standings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"date":"<string>"}'
```

### Get team info all

Fetch all NHL teams with metadata including abbreviation, full name, logo URL, conference, and division. Derived from current standings data. Returns all 32 teams.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nhl/get-team-info-all \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get team roster

Fetch a team's roster for a given season. Returns forwards, defensemen, and goalies with biographical information including height, weight, birthdate, birthplace, and sweater number.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `season` | string | No | Season in format YYYYYYYY (e.g., 20242025). Omit for current season roster. |
| `team` | string | Yes | Three-letter team abbreviation (e.g., EDM, TOR, FLA, CAR, COL, NYR, BOS, WSH, WPG, VGK, MIN, TBL, BUF, MTL, OTT, PIT, PHI, DET, CBJ, NYI, NJD, ANA, LAK, STL, NSH, SJS, SEA, CGY, CHI, VAN, UTA). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nhl/get-team-roster \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"season":"<string>","team":"<string>"}'
```

### Search players

Search for active NHL players by name. Returns matching players with their team, position, player ID, and physical attributes. Searches across first and last names.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Player name to search for (e.g., mcdavid, connor, ovechkin). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nhl/search-players \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.