griddy-sdk / Games

Class: Games¶

Defined in: src/griddy/nfl/endpoints/regular/football/games.ts:95

Games endpoint class for regular NFL API.

Extends¶

BaseSDK

Constructors¶

Constructor¶

new Games(sdkConfig, parentRef?): Games

Defined in: src/griddy/nfl/endpoints/regular/football/games.ts:96

Parameters¶

sdkConfig¶

SDKConfiguration

parentRef?¶

object

Returns¶

Games

Overrides¶

BaseSDK.constructor

Properties¶

parentRef¶

protected parentRef: object = null

Defined in: src/griddy/nfl/baseSdk.ts:76

Inherited from¶

BaseSDK.parentRef

sdkConfiguration¶

protected sdkConfiguration: SDKConfiguration

Defined in: src/griddy/nfl/baseSdk.ts:75

Inherited from¶

BaseSDK.sdkConfiguration

Methods¶

buildRequest()¶

protected buildRequest(config): Request

Defined in: src/griddy/nfl/baseSdk.ts:270

Build an HTTP request.

Parameters¶

config¶

EndpointConfig

Returns¶

Request

Inherited from¶

BaseSDK.buildRequest

createHookContext()¶

protected createHookContext(operationId, baseUrl): HookContext

Defined in: src/griddy/nfl/baseSdk.ts:152

Create a hook context for request execution.

Parameters¶

operationId¶

string

baseUrl¶

string

Returns¶

HookContext

Inherited from¶

BaseSDK.createHookContext

doRequest()¶

protected doRequest(hookCtx, request, errorStatusCodes, retryConfig?): Promise\<Response>

Defined in: src/griddy/nfl/baseSdk.ts:338

Execute an HTTP request with hooks and retries.

Parameters¶

hookCtx¶

HookContext

request¶

Request

errorStatusCodes¶

string[]

retryConfig?¶

config¶

RetryConfig

statusCodes¶

string[]

Returns¶

Promise\<Response>

Inherited from¶

BaseSDK.doRequest

executeEndpoint()¶

protected executeEndpoint\<T>(config): Promise\<T>

Defined in: src/griddy/nfl/baseSdk.ts:522

Execute an endpoint and return the response.

Type Parameters¶

T¶

T

Parameters¶

config¶

EndpointConfig\<T>

Returns¶

Promise\<T>

Inherited from¶

BaseSDK.executeEndpoint

generateUrl()¶

protected generateUrl(baseUrl, path, request, requestMeta?): string

Defined in: src/griddy/nfl/baseSdk.ts:168

Generate URL with path parameters substituted.

Parameters¶

baseUrl¶

string

path¶

string

request¶

Record\<string, unknown>

requestMeta?¶

Record\<string, ParamMetadata>

Returns¶

string

Inherited from¶

BaseSDK.generateUrl

getBoxScore()¶

getBoxScore(gameId, options?): Promise\<BoxScoreResponse>

Defined in: src/griddy/nfl/endpoints/regular/football/games.ts:201

Get Game Box Score.

Retrieves comprehensive box score data for a specific game including team statistics, individual player statistics, and scoring summary.

Parameters¶

gameId¶

string

Game identifier (UUID)

options?¶

RequestOptions

Request options

Returns¶

Promise\<BoxScoreResponse>

Box score response

getGames()¶

getGames(season, seasonType, week, withExternalIds?, options?): Promise\<FootballGamesResponse>

Defined in: src/griddy/nfl/endpoints/regular/football/games.ts:149

Get Games by Season, Type, and Week.

Retrieves game information for a specific season, season type, and week from the Football API.

Parameters¶

season¶

number

Season year

seasonType¶

SeasonTypeEnum

Type of season

week¶

number

Week number

withExternalIds?¶

boolean

Include external IDs in response

options?¶

RequestOptions

Request options

Returns¶

Promise\<FootballGamesResponse>

Football games response

getHeaders()¶

protected getHeaders(request, requestMeta?): Record\<string, string>

Defined in: src/griddy/nfl/baseSdk.ts:222

Get headers from request.

Parameters¶

request¶

Record\<string, unknown>

requestMeta?¶

Record\<string, ParamMetadata>

Returns¶

Record\<string, string>

Inherited from¶

BaseSDK.getHeaders

getLiveGameStats()¶

getLiveGameStats(season, seasonType, week, options?): Promise\<GameStatsResponse>

Defined in: src/griddy/nfl/endpoints/regular/football/games.ts:314

Get Live Game Statistics.

Retrieves live game statistics and summaries for games in progress or completed games.

Parameters¶

season¶

number

Season year

seasonType¶

SeasonTypeEnum

Type of season

week¶

number

Week number

options?¶

RequestOptions

Request options

Returns¶

Promise\<GameStatsResponse>

Game stats response

getPlayByPlay()¶

getPlayByPlay(gameId, includePenalties?, includeFormations?, options?): Promise\<PlayByPlayResponse>

Defined in: src/griddy/nfl/endpoints/regular/football/games.ts:255

Get Play-by-Play Data.

Retrieves detailed play-by-play data for a specific game including all plays, drives, scoring events, and key statistics.

Parameters¶

gameId¶

string

Game identifier (UUID)

includePenalties?¶

boolean

Include penalty details

includeFormations?¶

boolean

Include offensive/defensive formations

options?¶

RequestOptions

Request options

Returns¶

Promise\<PlayByPlayResponse>

Play-by-play response

getQueryParams()¶

protected getQueryParams(request, requestMeta?): Record\<string, string>

Defined in: src/griddy/nfl/baseSdk.ts:197

Get query parameters from request.

Parameters¶

request¶

Record\<string, unknown>

requestMeta?¶

Record\<string, ParamMetadata>

Returns¶

Record\<string, string>

Inherited from¶

BaseSDK.getQueryParams

getSecurityParams()¶

protected getSecurityParams(security): object

Defined in: src/griddy/nfl/baseSdk.ts:247

Get security headers and query params.

Parameters¶

security¶

Security | () => Security

Returns¶

object

headers¶

headers: Record\<string, string>

queryParams¶

queryParams: Record\<string, string>

Inherited from¶

BaseSDK.getSecurityParams

getUrl()¶

protected getUrl(baseUrl, urlVariables): string

Defined in: src/griddy/nfl/baseSdk.ts:86

Get the URL with template variables.

Parameters¶

baseUrl¶

string

urlVariables¶

Record\<string, string>

Returns¶

string

Inherited from¶

BaseSDK.getUrl

getWeeklyGameDetails()¶

getWeeklyGameDetails(season, type, week, includeDriveChart?, includeReplays?, includeStandings?, includeTaggedVideos?, options?): Promise\<WeeklyGameDetail[]>

Defined in: src/griddy/nfl/endpoints/regular/football/games.ts:385

Get Weekly Game Details.

Retrieves detailed game information for a specific week including team standings, drive charts, replays, and tagged videos.

Parameters¶

season¶

number

Season year

type¶

SeasonTypeEnum

Season type

week¶

number

Week number

includeDriveChart?¶

boolean

Include drive chart data

includeReplays?¶

boolean

Include replay videos

includeStandings?¶

boolean

Include team standings

includeTaggedVideos?¶

boolean

Include tagged video content

options?¶

RequestOptions

Request options

Returns¶

Promise\<WeeklyGameDetail[]>

Weekly game details

handleJsonResponse()¶

protected handleJsonResponse\<T>(response, errorStatusCodes): Promise\<T>

Defined in: src/griddy/nfl/baseSdk.ts:490

Handle JSON response with error handling.

Type Parameters¶

T¶

T

Parameters¶

response¶

Response

errorStatusCodes¶

string[]

Returns¶

Promise\<T>

Inherited from¶

BaseSDK.handleJsonResponse

resolveBaseUrl()¶

protected resolveBaseUrl(serverUrl?, urlVariables?): string

Defined in: src/griddy/nfl/baseSdk.ts:106

Resolve the base URL for a request.

Parameters¶

serverUrl?¶

string

urlVariables?¶

Record\<string, string>

Returns¶

string

Inherited from¶

BaseSDK.resolveBaseUrl

resolveRetryConfig()¶

protected resolveRetryConfig(retries, retryStatusCodes?): object

Defined in: src/griddy/nfl/baseSdk.ts:129

Resolve retry configuration.

Parameters¶

retries¶

typeof UNSET | RetryConfig

retryStatusCodes?¶

string[]

Returns¶

object

config¶

config: RetryConfig

statusCodes¶

statusCodes: string[]

Inherited from¶

BaseSDK.resolveRetryConfig

resolveTimeout()¶

protected resolveTimeout(timeoutMs?): number

Defined in: src/griddy/nfl/baseSdk.ts:119

Resolve timeout, falling back to SDK configuration.

Parameters¶

timeoutMs?¶

number

Returns¶

number

Inherited from¶

BaseSDK.resolveTimeout