officials
Support for WBB is limited due to poor inbound data quality, use at your own risk. A query to this endpoint without an id parameter will return a list of all officials/umpires for the competition level with their id codes. Results can be filtered by season. Passing an id parameter will return metadata for a single official/umpire, and their game record plus statistics. Results are limited to a single season; if no season parameter is passed, the current season is the default.
Please note that this endpoint can be used synonymously as official, umpire and umpires.
All MBB Officials for 2017-18
https://api.natstat.com/v1/officials/MBB/?key=XXXX-XXXXXX&format=xml&id=39560
Download sample
Parameters
Path
| Name | Required | Type | Description |
|---|---|---|---|
level |
required | string | The competition level to retrieve information for. A full glossary can be found in the Path Parameters section |
Query
| Name | Required | Type | Description |
|---|---|---|---|
key |
required | string | A valid API key in XXXX-XXXXXX format |
format |
optional | string | The preferred data format: xml, json or php (presented as a SimpleXML object). The default is json |
max |
optional | number | The number of results per page to return. The default value is 100, and the maximum allowed parameter value is 1000. This value is echoed back as Max_Results in the meta block |
page |
optional | number | The pagination page number. This value is echoed back as Page in the meta block. The meta block also contains the Total_Results of the query. If there are further results, a fully-formed Next_Page URI containing a pre-filled &page=X value will be returned |
id |
optional | number | A valid official ID code, which returns details for one season of that official (A list of available officials can be retrieved from this endpoint by not passing an ID code.) |
season |
optional | number | A valid season ID code, formatted as the year the season completes, in YYYY format. A list of available seasons can be retrieved from the seasons endpoint. The default value is the current season |
Response
| Name | Required | Type | Description |
|---|---|---|---|
ID |
number | The unique identifier for the record | |
Name |
string | The full name of the official | |
FirstName |
string | The first name of the official | |
LastName |
string | The last name of the official | |
URL |
string | The National Statistical page for the official | |
Season_ID |
number | The seasons ID of the season, in YYYY format | |
Games |
number | The number of games the official has worked in the season | |
AvgFouls |
number | The average number of fouls called by crews including this official | |
AvgFoulsRank |
number | The ranking of average fouls among this season's officials | |
FoulsHomeTeamDifferential |
number | The differential of fouls by the home and visiting team during the game | |
lastgame |
object | Contains games metadata for the last game the official worked in | |
LastGame |
string | A text description of the last game the official worked in | |
GameDay |
date | The date of this game, in YYYY-MM-DD format | |
Game_ID |
number | The games ID of this game | |
games |
object | Includes games metadata about the game the official worked in | |
Visitor_ID |
number | The teams ID of the visting team | |
Visitor |
string | The teams name of the visiting team | |
ScoreVis |
number | The visiting team's score in the relevant game | |
FoulsVis |
number | The number of fouls the visiting team committed during the game | |
Home_ID |
number | The teams ID of the home team | |
Home |
string | The teams name of the home team | |
ScoreHome |
number | The home team's score in the relevant game | |
FoulsHome |
number | The number of fouls the home team committed during the game | |
GameStatus |
string | The period and time of the game, or Final. Returns empty value if game has not started | |
Winner_ID |
number | The teams ID of the winning team | |
venue |
object | Contains venues metadata about the location of the game | |
CityState |
string | The city and state where the game was played | |
Longitude |
number | The longitude of the venue where the relevant game was played | |
Latitude |
number | The latitude of the venue where the relevant game was played | |
Neutral |
boolean | Whether the game is played at a neutral location, in Y/N format |