{ "openapi": "3.0.1", "info": { "title": "NHL Stats API - schedule, scores, standings, rosters", "description": "Read the NHL's public web API (api-web.nhle.com) and get flat rows: standings with GP, W, L, OTL, points, GF/GA, streak; games with state, teams, scores, venue; today's scoreboard; rosters with position, number, shoots/catches; player bio + season/career totals. Default: standings now (32 rows).", "version": "0.1", "x-build-id": "HJzPCoUdgdEfSkycG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/retrainmap~nhl-stats/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-retrainmap-nhl-stats", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/retrainmap~nhl-stats/runs": { "post": { "operationId": "runs-sync-retrainmap-nhl-stats", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/retrainmap~nhl-stats/run-sync": { "post": { "operationId": "run-sync-retrainmap-nhl-stats", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "mode": { "title": "Mode", "enum": [ "standings", "schedule", "scores_now", "roster", "player" ], "type": "string", "description": "standings = one row per team from /standings/now (or /standings/{date}). schedule = one row per game for `days` days from `date` (/schedule/{date}). scores_now = one row per game on the API's current scoreboard (/score/now). roster = one row per player on each team in team_abbrevs (/roster/{team}/current). player = one row per player id with bio, season and career totals (/player/{id}/landing).", "default": "standings" }, "date": { "title": "Date (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "schedule: first day of the window (default today, UTC); when the default week has no games the Actor jumps to the API's next scheduled week and says so. standings: standings as of this date (default: now)." }, "days": { "title": "Schedule days", "minimum": 1, "maximum": 28, "type": "integer", "description": "schedule only: how many days from `date` (1-28; the API serves 7 days per request).", "default": 7 }, "team_abbrevs": { "title": "Team abbreviations (roster)", "uniqueItems": true, "type": "array", "description": "roster only: three-letter NHL team codes, e.g. TOR, EDM, BOS, NYR, COL (the `team_abbrev` values of the standings rows). An unknown code makes the API answer HTTP 404 and the run fails with that message.", "items": { "type": "string" } }, "player_ids": { "title": "Player ids (player)", "uniqueItems": true, "type": "array", "description": "player only: NHL player ids, e.g. 8478402 = Connor McDavid, 8477934 = Leon Draisaitl, 8471675 = Sidney Crosby (the number at the end of an nhl.com/player URL; also the `player_id` of roster rows). An unknown id makes the API answer HTTP 404 and the run fails with that message.", "items": { "type": "string" } }, "max_records": { "title": "Maximum records", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many rows.", "default": 500 }, "request_interval_ms": { "title": "Minimum interval between requests (ms)", "minimum": 250, "maximum": 10000, "type": "integer", "description": "Politeness delay towards api-web.nhle.com. Standings and scores are one request; schedule one per 7 days; roster one per team; player one per id. Floor 250 ms.", "default": 500 }, "contact_email": { "title": "Contact e-mail (From: header)", "type": "string", "description": "Sent in the standard From: request header so the data owner can reach the operator (RFC 9110 s10.1.2).", "default": "info@steelyardclinical.com" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }