griddy-sdk¶
Griddy SDK - TypeScript SDK for accessing NFL data.
Example¶
import { GriddyNFL } from 'griddy-sdk';
const nfl = new GriddyNFL({
nflAuth: { accessToken: 'your_access_token' }
});
// Get games
const games = await nfl.games.getGames(2024, 'REG', 1);
// Get box score
const boxScore = await nfl.games.getBoxScore('game-id');
Classes¶
- BaseSDK
- Games
- GriddyNFL
- GriddyNFLDefaultError
- GriddyNFLError
- NoResponseError
- ResponseValidationError
- SDKConfiguration
- SDKHooks
Interfaces¶
- AfterErrorContext
- AfterErrorHook
- AfterSuccessContext
- AfterSuccessHook
- AsyncHttpClient
- AuthInfo
- BeforeRequestContext
- BeforeRequestHook
- BoxScoreTeamStats
- BroadcastInfo
- DefensiveStats
- EndpointConfig
- ExternalID
- FantasyStats
- FootballGamesResponse
- Game
- GameExtension
- GetDefensiveStatsRequest
- GetFootballBoxScoreRequest
- GetFootballGamesRequest
- GetLiveGameStatsRequest
- GetPassingStatsRequest
- GetPlayByPlayRequest
- GetPlayerRequest
- GetReceivingStatsRequest
- GetRostersRequest
- GetRushingStatsRequest
- GetStandingsRequest
- GetWeeklyGameDetailsRequest
- GriddyNFLOptions
- HookContext
- Hooks
- HttpClient
- Logger
- NFLSettings
- ParamMetadata
- PassingStats
- Player
- PlayerDetail
- PlayerGameStats
- PlayerProjection
- PlayerSearchResult
- ProTeam
- ReceivingStats
- RequestOptions
- RetryConfig
- RushingStats
- ScheduleTeam
- SDKConfigurationOptions
- SDKInitHook
- SearchPlayersRequest
- Security
- SecurityMetadata
- Team
- TeamDefenseStats
- TeamNeeds
- TeamOffenseStats
- TeamSocialMedia
- TeamVenue
- TicketVendor
- Venue
Type Aliases¶
- BinaryFlagEnum
- ConferenceEnum
- DefenseNGSPositionEnum
- DefenseNGSPositionGroupEnum
- DefensePositionEnum
- DefensePositionGroupEnum
- DefensiveSplitsEnum
- DownEnum
- GameCategory
- GameLocationEnum
- GamePhaseEnum
- GameResultEnum
- GameStatus
- GameStatusEnum
- HttpMethod
- MeridiemEnum
- Nullable
- OffensivePlayerPositionEnum
- OffensiveSkillPositionEnum
- OptionalNullable
- PassingStatsCategoryEnum
- PlayTypeEnum
- PracticeStatusEnum
- QuarterEnum
- ReceivingStatsCategoryEnum
- SeasonTypeEnum
- ServerType
- SiteRoofTypeEnum
- SortOrderEnum
- TeamNeedsPositionEnum
- TeamTypeEnum
- Unset
- WeekSlugEnum
- YardsToGoEnum
Variables¶
- BinaryFlagEnum
- COLLECTION_ERROR_CODES
- ConferenceEnum
- DEFAULT_RETRY_CONFIG
- DefenseNGSPositionEnum
- DefenseNGSPositionGroupEnum
- DefensePositionEnum
- DefensePositionGroupEnum
- DefensiveSplitsEnum
- DownEnum
- GameLocationEnum
- GamePhaseEnum
- GameResultEnum
- GameStatusEnum
- GetFootballBoxScoreRequestMeta
- GetFootballGamesRequestMeta
- GetLiveGameStatsRequestMeta
- GetPassingStatsRequestMeta
- GetPlayByPlayRequestMeta
- GetPlayerRequestMeta
- GetRostersRequestMeta
- GetStandingsRequestMeta
- GetWeeklyGameDetailsRequestMeta
- MeridiemEnum
- NFL
- NFL_AUTH_METADATA
- OffensivePlayerPositionEnum
- OffensiveSkillPositionEnum
- PassingStatsCategoryEnum
- PlayTypeEnum
- PracticeStatusEnum
- QuarterEnum
- ReceivingStatsCategoryEnum
- RESOURCE_ERROR_CODES
- RETRY_STATUS_CODES
- SeasonTypeEnum
- SECURED_RESOURCE_ERROR_CODES
- SERVERS
- SiteRoofTypeEnum
- SortOrderEnum
- STATS_ERROR_CODES
- TeamNeedsPositionEnum
- TeamTypeEnum
- UNSET
- USER_AGENT
- VERSION
- YardsToGoEnum
Functions¶
- createNFLSettings
- createRetryConfig
- createSDKHooks
- createSecurity
- isUnset
- matchResponse
- matchStatusCodes
References¶
NFLAuth¶
Renames and re-exports AuthInfo