API Endpoints

This is a full list of the available Shield API root nodes. Root nodes can be queried directly. Nested nodes are queried via root nodes or "edges". If you want to learn how to use Shield, read the Playbook. If you want to know which APIs can solve some frequent issues, try our Formations guide.

Bootstrap, Configuration

Node Description Notes
/v1/config Client bootstrap / configuration.

Root Endpoints

Node Description Notes
/v1/games A game. Played or not yet Played including matchup, sponsorship, location and stats! Limited query support at this time. Click node for details.
/v1/teams A NFL franchise that plays or has played in a game. Limited query support at this time. Click node for details.
/v1/persons A NFL person. (Player, Coach, etc) Limited query support at this time. Click node for details.
/v1/achievements A NFL person achievement in a season Limited query support at this time. Click node for details.
/v1/currentWeek The current week within the NFL season.
/v1/playerGameStats Player statistics by game. Limited query support at this time. Click node for details.
/v1/playerTeamStats Player statistics by team. Limited query support at this time. Click node for details.
/v1/seasonPlayerTeamStats Season's worth of Player statistics by team including league wide aggregation Limited query support at this time. Click node for details.
/v1/prospectCombineStats List of combine prospects' results for each event Limited query support at this time. Click node for details.
/v1/drafts List of of draft picks Limited query support at this time. Click node for details.
/v1/lists Lists (content, etc.) Management Limited query support at this time. Click node for details.
/v1/videos Videos Limited query support at this time. Click node for details.
/v1/articles Articles Limited query support at this time. Click node for details.
/v1/geo Geolocation and reverse geolocation for regional games. Converts zip codes or lat-long coordinates to live game ids.

Register

Node Description Notes
/v1/users Adds a User based on HTTP method (PUT)
/v1/users/{username}/exists Checks if username already exists

Auth

Node Description Notes
/v1/oauth/token Request tokens for api calls

Entitlement

Node Description Notes
/v1/users/{username}/roles Roles of the given User
/v1/devices/{username}/roles Roles of the given Device

Concurrent Users Service

Node Description Notes
/v1/concurrentusers Limit number of concurrent devices for the same user allowed to stream concurrently GET for Check, POST for START