Glossary
Our list of useful definitions and links to relevant sections
- API Key
- The first step in the security process. Each client using our API is assigned an API Key and must pass it to the
api_key
parameter and pass a hashed signature to thesig
parameter in all RESTful URLs to access and retrieve data from the API. For more information, see our guide. - API signature
- Your unique API key and secret along with the current timestamp are used to create a SHA-256 hash string signature. See the our Authentication guide for more information.
- Assets
- Assets, or content entities, are the data objects that can be returned using the Stats API.
- Box score
- A box score provide a detailed summary of completed game; a wide variety of box score statistics are used to illustrate both team and individual performances.
- Endpoint
- A branch of an API at its final point. It is normally possible to explore an endpoint using query parameters.
- Gamelog
- A record of a game. The level of detail available in a game log depends on the moment in time that your application retrieves it - for example, if it is before a game has started (pre-game), during a game (contains pre-game and live data, correct up until that moment in time), or after a game has ended (post-game data, correct up to the current time/date).
- Query Parameters
- Also known as ‘Parameters’ or ‘Query String Parameters’. The parameters are added after the base URL to filter or control the returned content in the specified way. Our API has a set of common query parameters, such as
api_key
,sig
,accept
andlanguageId
; however, while many more parameters are available, they are not supported in all endpoints or in combination with each other. For more information, see the specific guide for a sport, league and endpoint. - RESTful
- RESTful APIs are a way of revealing functionality using the HTTP protocol. For more information, see our API Overview and Authorisation guide.