playerperfs
A query to this endpoint without an id parameter will return a list of all player performances for the competition level with their id codes, in reverse chronological order. Results can be filtered by season, sublevel, player, game, team, date or date range (start-end; last). Passing an id parameter will return a single performance (with no additional metadata).
Please note that this endpoint can be used synonymously as playerperf.
All KHL Player Performances
https://api.natstat.com/v1/playerperfs/KHL/?key=XXXX-XXXXXX&format=xml
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 performance ID code, which returns details for that performance (A list of available performances can be retrieved from this endpoint by not passing an ID code.) |
sublevel |
optional | number | A valid sublevel (leagues, conferences) ID code. A list of sublevels can be retrieved from the glossary endpoint |
team |
optional | number | A valid team ID code. A list of teams can be retrieved from the teams endpoint |
season |
optional | number | A valid season ID code, formatted as the year that a season completes, in YYYY format. A list of available seasons can be retrieved from the seasons endpoint |
player |
optional | number | A valid player ID code. A list of teams can be retrieved from the players endpoint. |
game |
optional | number | A valid game ID code. A list of games can be retrieved from the games endpoint |
date |
optional | string | The date to limit matched results to. The API will attempt to translate the date, but YYYYMMDD or YYYY-MM-DD are preferred |
start |
optional | string | The start date from which to include matched results (inclusive). The API will attempt to translate the date, but YYYYMMDD or YYYY-MM-DD are preferred |
end |
optional | string | The end date to which to include matched results (inclusive). The API will attempt to translate the date, but YYYYMMDD or YYYY-MM-DD are preferred |
last |
optional | number | Number of days previous to today's date, to specify a date range from which to match results |
Response
| Name | Required | Type | Description |
|---|---|---|---|
performances |
object | Contains player performance info for the game | |
ID |
number | The unique identifier for the record | |
Player |
string | The players name of the most relevant player in the event | |
Player_ID |
string | The players ID of the most relevant player in the event | |
PlayerNo |
string | The uniform number of the most relevant player in the event | |
Position |
string | The position of the player | |
Starter |
boolean | Whether the player started the game, in Y/N format | |
PlayerType |
string | The code for the player type (hockey: S or G; baseball: B or P) | |
game |
object | Includes games metadata about the game the event took place in | |
Game_ID |
number | The games ID of this game | |
GameDay |
date | The date of this game, in YYYY-MM-DD format | |
Description |
string | A plain text description of the event | |
Visitor |
string | The teams name of the visiting team | |
Home |
string | The teams name of the home team | |
Loc |
string | Returns H, V or N | |
WinOrLoss |
string | Returns W or L | |
Playoffs |
boolean | Whether the game was a playoff game, in Y/N format | |
Finals |
boolean | Whether the game was in the championship round, in Y/N format | |
venue |
object | Contains venues metadata about the location of the game | |
Name |
string | The full name of the player | |
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 | |
team |
object | Includes teams metadata about the relevant team | |
Team |
string | The teams name of the relevant team | |
opponent |
object | Contains teams metadata about the opposing team | |
Opponent |
string | The teams name of the opposing team | |
Series |
string | Description of the playoff series, when applicable | |
SeriesName |
string | The playoff series name, when applicable | |
SeriesGameNo |
number | The playoff series game number, when applicable | |
SeriesStatus |
string | The W-L status of the playoff series, when applicable | |
Statline |
string | A plain text readout of the player's statline | |
League |
string | The abbreviation of the league (FC only) | |
LeagueName |
string | The name of the league (FC only) | |
LeagueType |
string | The type of league: Domestic, Cup, International (FC only) | |
LeagueNation |
string | The country or scope of the league (FC only) | |
LeagueGender |
string | The gender of the league: M,W (FC only) | |
LeagueFactor |
number | The relative strength of the league from 0.0 to 1.0 (FC only) |