API v2 Documentation

Endpoints Code Lookup

← All endpoints

news

team All data services

A query to this endpoint without an id parameter will return all news items in reverse chronological order. Results can be filtered by game, team, date, date range (start-end; last), and search. Passing an id parameter will return all metadata for a news item.

MiLB Recent News
https://api.natstat.com/v1/news/MiLB/?key=XXXX-XXXXXX&format=xml Download sample

Parameters

Path

NameRequiredTypeDescription
level required string The competition level to retrieve information for. A full glossary can be found in the Path Parameters section

Query

NameRequiredTypeDescription
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 news ID code, which returns details for that news item (A list of available news items can be retrieved from this endpoint by not passing an ID code.)
team optional string A valid team ID code. A list of teams can be retrieved from the teams endpoint
search optional string For general search of endpoint contents. Queries of four characters or less will be ignored
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

NameRequiredTypeDescription
ID number The unique identifier for the record
Headline string The headline of the news item
Abstract string A short abstract of the news item
Provider string The publisher of the news item
URL string The full URL of the news item
ShortURL string The condensed nstat.co URL of the news item
Published date The publication date of the transaction
NewsScore number A calculated relevance score of the news item from 0 to 600
Game_ID number The games ID of this game
games object Includes games metadata about the game the news item is about
GameDay date The date of this game, in YYYY-MM-DD format
Sublevel string The teams sublevel of the team, e.g A or AAA
Visitor_ID number The teams ID of the visting team
Visitor string The teams name of the visiting team
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
Winner_ID number The teams ID of the winning team
ScoreVis number The visiting team's score in the relevant game
Thumbnail string The URL of the thumbnail image from the news item, if available
Team_ID number The teams ID of the relevant team
team object Includes teams metadata about the relevant team
Name string The full name of the news item
Abbrev string The two to seven-letter team abbreviation, available via the teams endpoint