teams
A query to this endpoint without an id parameter will return a list of all teams for the competition level with their id codes. Filtering by season will show all teams active in that season. Passing an id parameter will return all metadata for the team, a list of seasons played, current ELO rating and social account information.
Please note that this endpoint can be used synonymously as team.
Florida Panthers
https://api.natstat.com/v1/teams/NHL/?key=XXXX-XXXXXX&format=xml&id=152
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 team ID code, which returns details for that team (A list of available teams can be retrieved from this endpoint by not passing an ID code.) |
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 |
search |
optional | string | For general search of endpoint contents. Queries of four characters or less will be ignored |
Response
| Name | Required | Type | Description |
|---|---|---|---|
ID |
number | The unique identifier for the record | |
Name |
string | The full name of the team | |
City |
string | The home city of the team | |
Nickname |
string | The nickname of the team | |
Abbrev |
string | The three to five letter abbreviation of the team | |
URL |
string | The National Statistical homepage of the team | |
Active |
boolean | Whether the team currently exists, in Y/N format | |
League |
string | The league the team plays in, if available | |
Division |
string | The division the team plays in, if available | |
GamesCompleted |
number | The number of games the team has completed in the season | |
Wins |
number | The number of wins the team has in the season | |
Losses |
string | The number of losses the team has in the season | |
venue |
object | Contains venues metadata about the location of the game | |
elo |
object | Includes recent ELO rating data of the team | |
CurrentELO |
number | The current ELO rating of the team | |
ELORank |
number | The ELO ranking number of the team | |
ELOLastUpdated |
date | The last updated date of this record | |
social |
object | Includes social metadata related to the team's Twitter account | |
Twitter |
string | The Twitter account of the team | |
LastTweet |
string | The text of the most recent tweet from this team's account | |
LastTweetID |
number | The Twitter ID of the most recent tweet from this team's account | |
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) | |
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) |