Made in Canada
Back

API reference

Read-only JSON for player profiles, contracts and team lineups, refreshed daily.

Get an API key

First request

Every endpoint lives under this base URL:

https://capwages.com/api/gateway/v1
  1. Subscribe to the API add-on. It works with or without a CapWages plan.
  2. Generate a key in Settings. It is shown once, so store it somewhere safe, like an environment variable.
  3. Send it on every request as Authorization: ApiKey <your key>.

Try it with the first five players:

curl "https://capwages.com/api/gateway/v1/players?limit=5" \
  -H "Authorization: ApiKey $CAPWAGES_API_KEY"

Responses are JSON with apiVersion (currently 1.2), success, data and meta. Amounts are whole US dollars.

Fair use and caching

The data refreshes once a day, so most apps need one full import a day and nothing more.

  • Cache responses and import the full database at most once a day. Before importing, check meta.lastUpdated on a single /players page. If it matches your last import, nothing has changed.
  • Keep to 4 requests per second or fewer. Keys that go well past this may be suspended.
  • Page through /players with limit=100. Players are sorted by slug, and fetching every page in one run keeps the whole list on the same daily build.
  • On the player endpoints, meta.lastUpdated is when the data was last rebuilt. On /lineups it is when that team's lineup last changed.

Errors

Check the HTTP status first. Auth and routing errors come back as a plain { error } object, not the usual envelope.

401Body{ "error": "Missing API Key" }Cause and fixNo Authorization header, or it doesn't start with ApiKey and a space.
403Body{ "error": "Invalid key" }Cause and fixThe key is wrong, expired or revoked. Generate a new one in Settings.
404Body{ "apiVersion": "1.2", "success": false, "error": { "code": 404, "message": "Player not found" } }Cause and fixNo player with that slug.
404Body{ "apiVersion": "1.2", "success": false, "error": { "code": 404, "message": "Lineup not found for this team" } }Cause and fixThe team slug isn't recognised. See Team slugs.
404Body{ "error": "Not Found" }Cause and fixThe path doesn't match an endpoint. Check the /v1 prefix.
500Body{ "error": "Proxy failed" }Cause and fixTemporary server problem. Retry after a few seconds, with backoff.

GET/players

Every player in the database, sorted by slug, one page at a time. Use it to collect slugs, then fetch each player's details.

Query parameters

pageTypeintegerDefault1DescriptionPage to return, starting at 1. A page past the last one returns an empty data array.
limitTypeintegerDefault25DescriptionPlayers per page. Use 100 for a full import. Values below 1 or non-numbers fall back to the default.

Request

curl "https://capwages.com/api/gateway/v1/players?page=1&limit=100" \
  -H "Authorization: ApiKey $CAPWAGES_API_KEY"

Response

{
  "apiVersion": "1.2",
  "success": true,
  "data": [
    {
      "slug": "connor-mcdavid",
      "name": "Connor McDavid",
      "note": "C",
      "pos": "C",
      "current_team_slug": "edmonton_oilers"
    },
    {
      "slug": "mitch-marner",
      "name": "Mitch Marner",
      "note": null,
      "pos": "RW, C, LW",
      "current_team_slug": "vegas_golden_knights"
    }
  ],
  "meta": {
    "pagination": {
      "page": 2,
      "limit": 100,
      "total": 7980,
      "totalPages": 80,
      "links": {
        "first": "/v1/players?page=1&limit=100",
        "prev": "/v1/players?page=1&limit=100",
        "next": "/v1/players?page=3&limit=100",
        "last": "/v1/players?page=80&limit=100"
      }
    },
    "lastUpdated": "2026-11-11T00:11:20.000Z"
  }
}

Fields

slugTypestringMeaningThe player's ID. Pass it to /players/:slug.
nameTypestringMeaningFull name.
noteTypestring | nullMeaningCaptaincy: C or A, otherwise null.
posTypestringMeaningEvery position the player is listed at, comma separated, primary first. For example RW, C, LW.
current_team_slugTypestring | nullMeaningTeam slug, for example edmonton_oilers. Null for players without an NHL team. Pass it straight to /lineups.
meta.pagination.totalTypeintegerMeaningPlayers across all pages, including prospects and retired players.
meta.pagination.totalPagesTypeintegerMeaningLast page number for this limit. Stop paging here.
meta.pagination.linksTypeobjectMeaningfirst, prev, next and last as paths under /v1. Prefix them with https://capwages.com/api/gateway. prev and next are null at the ends.
meta.lastUpdatedTypestringMeaningWhen the data was last rebuilt (ISO 8601). It changes about once a day, so compare it with your cached copy to decide whether to re-import.

GET/players/:slug

A player's profile, draft details and every contract, season by season.

Path parameters

slugTypestringDescriptionThe player's ID from /players, for example connor-mcdavid.

Fetch only the players you need

/players returns about 8,000 players, including prospects and retired players. If you only need NHL rosters, keep the ones with a current_team_slug before calling this endpoint for each.

Request

curl "https://capwages.com/api/gateway/v1/players/connor-mcdavid" \
  -H "Authorization: ApiKey $CAPWAGES_API_KEY"

Response

{
  "apiVersion": "1.2",
  "success": true,
  "data": {
    "name": "Connor McDavid",
    "slug": "connor-mcdavid",
    "team": "Edmonton Oilers",
    "position": "C",
    "leagueStatus": "NHL",
    "acquisition": {
      "method": "Draft",
      "details": "2015 EDM, 1st round, 1st pick (1st overall)",
      "year": 2015,
      "round": 1,
      "overallPick": 1,
      "draftTeam": "EDM"
    },
    "nhlId": 8478402,
    "jerseyNumber": 97,
    "personalInfo": {
      "birthDate": "1997-01-13",
      "birthPlace": "Richmond Hill, Ontario, CAN",
      "nationality": "CAN"
    },
    "physicalAttributes": {
      "hand": "Left",
      "height": { "imperial": "6'1\"", "metric": 185 },
      "weight": { "imperial": "194 lbs", "metric": 88 }
    },
    "ageLimits": {
      "entryLevelContractSigningAge": 18,
      "waiversEligibilityAge": 18
    },
    "contracts": [
      {
        "contractType": "Standard Contract (Extension)",
        "contractLength": "2 years",
        "contractYears": 2,
        "contractValue": 25000000,
        "expiryStatus": "UFA",
        "signingTeam": "Edmonton Oilers",
        "signingDate": "2025-10-06",
        "signedBy": "Stan Bowman",
        "seasons": [
          {
            "season": "2026-27",
            "clause": "NMC",
            "capHit": 12500000,
            "aav": 12500000,
            "performanceBonuses": 0,
            "signingBonuses": 13400000,
            "baseSalary": 850000,
            "totalSalary": 14250000,
            "minorsSalary": 0
          }
        ]
      }
    ]
  },
  "meta": {
    "lastUpdated": "2026-11-11T00:11:20.000Z"
  }
}

Fields

teamTypestring | nullMeaningCurrent team's full name.
positionTypestringMeaningPrimary position only, the first entry of pos from /players.
leagueStatusTypestringMeaningWhere the player is now. See League status values.
acquisition.methodTypestringMeaningHow the current team got him: Draft, Trade, Signed, Waivers claim, PTO and others.
acquisition.detailsTypestring | nullMeaningFree text describing the acquisition. Null when it isn't known.
acquisition.year, .round, .overallPickTypeinteger | nullMeaningDraft year, round and overall pick. Null for undrafted players.
acquisition.draftTeamTypestring | nullMeaningThree-letter code of the drafting team.
nhlIdTypeinteger | nullMeaningNHL.com player ID.
jerseyNumberTypeinteger | nullMeaningCurrent sweater number.
personalInfo.birthDateTypestring | nullMeaningYYYY-MM-DD.
personalInfo.nationalityTypestring | nullMeaningCountry code, usually three letters.
physicalAttributes.handTypestring | nullMeaningLeft or Right. Shoots for skaters, catches for goalies.
…height.metric, …weight.metricTypeinteger | nullMeaningCentimetres and kilograms.
ageLimitsTypeobjectMeaningAge at first contract signing, which sets entry-level length and waiver exemption under the CBA.
contracts[]TypearrayMeaningEvery contract the player has signed, oldest first by signingDate.
contracts[].contractTypeTypestringMeaningFree text, for example Entry-Level Contract or 35+ Contract.
contracts[].contractLengthTypestringMeaningTerm as text, for example "2 years".
contracts[].contractYearsTypeintegerMeaningTerm in years, for example 2.
contracts[].contractValueTypeintegerMeaningTotal value in US dollars.
contracts[].expiryStatusTypestringMeaningStatus when it ends: UFA, RFA, RFA (Arb), UFA (No QO) and others.
contracts[].signedByTypestring | nullMeaningGeneral manager who signed it.
seasons[].seasonTypestringMeaningSeason label, for example 2026-27. Seasons are in order.
seasons[].clauseTypestring | nullMeaningTrade protection: NMC, NTC, M-NTC and combinations.
seasons[].capHit, .aavTypeintegerMeaningCap hit and average annual value for the season, in US dollars.
seasons[].baseSalary, .signingBonuses, .performanceBonusesTypeintegerMeaningPay components in US dollars. totalSalary is base salary plus signing bonuses.
seasons[].minorsSalaryTypeintegerMeaningPay while in the minors on a two-way deal, in US dollars. 0 when the contract doesn't set one.
seasons[].buyoutTypeobjectMeaningOnly on bought-out seasons: teamName, teamSlug (may be null), cost, earning, savings, capHit.
seasons[].retentionTypeobjectMeaningOnly when salary is retained. Keyed by team name: { "San Jose Sharks": { "capHit": 2924000, "retainedPct": 86 } }.
meta.lastUpdatedTypestringMeaningWhen the data was last rebuilt, the same value as on /players.

GET/lineups/:teamSlug

A team's current lines: the latest game-day lineup once training camp opens, and projected lines before that.

Path parameters

teamSlugTypestringDescriptionTeam slug, for example toronto_maple_leafs. The hyphenated form (toronto-maple-leafs) also works.

Request

curl "https://capwages.com/api/gateway/v1/lineups/toronto_maple_leafs" \
  -H "Authorization: ApiKey $CAPWAGES_API_KEY"

Response

{
  "apiVersion": "1.2",
  "success": true,
  "data": {
    "teamSlug": "toronto_maple_leafs",
    "players": [
      { "playerSlug": "oliver-ekman-larsson", "line": "d1", "position": "ld" },
      { "playerSlug": "chris-tanev", "line": "d1", "position": "rd" },
      { "playerSlug": "jake-mccabe", "line": "d2", "position": "ld" },
      { "playerSlug": "darren-raddysh", "line": "d2", "position": "rd" }
    ]
  },
  "meta": {
    "lastUpdated": "2026-11-11T00:00:00Z",
    "source": "game_day"
  }
}

Fields

data.teamSlugTypestringMeaningThe slug as you sent it.
data.players[]TypearrayMeaningOne entry per slot, sorted alphabetically by line then position: defense, then forwards, then goalies.
players[].playerSlugTypestringMeaningPass it to /players/:slug.
players[].line, .positionTypestringMeaningWhere the player slots in. See the code map below.
meta.sourceTypestringMeaninggame_day for the latest real lineup, projected for preseason projections. The API falls back to the other one when a team has none.
meta.lastUpdatedTypestringMeaningWhen this lineup last changed. Unlike the player endpoints, this is real data freshness.

Line and position codes

Forwards
linelwcrw
f11st line LW1st line C1st line RW
f22nd line LW2nd line C2nd line RW
f33rd line LW3rd line C3rd line RW
f44th line LW4th line C4th line RW
Defense
lineldrd
d11st pair LD1st pair RD
d22nd pair LD2nd pair RD
d33rd pair LD3rd pair RD
d4Extra LDExtra RD
Goalies
lineg1g2
gStarterBackup
A slot can be empty when a team dressed a short lineup. d4 (dashed) appears only when a team dresses a seventh defenseman.

Team slugs

The slug is what current_team_slug returns and what /lineups takes. /lineups also accepts it with hyphens.

Anaheim DucksSluganaheim_ducksCodeANA
Boston BruinsSlugboston_bruinsCodeBOS
Buffalo SabresSlugbuffalo_sabresCodeBUF
Calgary FlamesSlugcalgary_flamesCodeCGY
Carolina HurricanesSlugcarolina_hurricanesCodeCAR
Chicago BlackhawksSlugchicago_blackhawksCodeCHI
Colorado AvalancheSlugcolorado_avalancheCodeCOL
Columbus Blue JacketsSlugcolumbus_blue_jacketsCodeCBJ
Dallas StarsSlugdallas_starsCodeDAL
Detroit Red WingsSlugdetroit_red_wingsCodeDET
Edmonton OilersSlugedmonton_oilersCodeEDM
Florida PanthersSlugflorida_panthersCodeFLA
Los Angeles KingsSluglos_angeles_kingsCodeLAK
Minnesota WildSlugminnesota_wildCodeMIN
Montréal CanadiensSlugmontreal_canadiensCodeMTL
Nashville PredatorsSlugnashville_predatorsCodeNSH
New Jersey DevilsSlugnew_jersey_devilsCodeNJD
New York IslandersSlugnew_york_islandersCodeNYI
New York RangersSlugnew_york_rangersCodeNYR
Ottawa SenatorsSlugottawa_senatorsCodeOTT
Philadelphia FlyersSlugphiladelphia_flyersCodePHI
Pittsburgh PenguinsSlugpittsburgh_penguinsCodePIT
San Jose SharksSlugsan_jose_sharksCodeSJS
Seattle KrakenSlugseattle_krakenCodeSEA
St. Louis BluesSlugst_louis_bluesCodeSTL
Tampa Bay LightningSlugtampa_bay_lightningCodeTBL
Toronto Maple LeafsSlugtoronto_maple_leafsCodeTOR
Utah MammothSlugutah_mammothCodeUTA
Vancouver CanucksSlugvancouver_canucksCodeVAN
Vegas Golden KnightsSlugvegas_golden_knightsCodeVGK
Washington CapitalsSlugwashington_capitalsCodeWSH
Winnipeg JetsSlugwinnipeg_jetsCodeWPG

League status values

Values of leagueStatus on /players/:slug.

NHLMeaningOn an NHL roster.
MinorMeaningPlaying in the minors.
IRMeaningOn injured reserve.
LoanMeaningLoaned to another league.
ProspectMeaningUnsigned. current_team_slug is the team holding his rights, when there is one.
JuniorMeaningSigned, playing junior hockey.
UndraftedMeaningNever drafted and not under contract.
KHLMeaningPlaying in the KHL.
InactiveMeaningNo current contract or rights. Most of the table.
RetiredMeaningRetired.
DeceasedMeaningDeceased.