Range Parameters
The third of three path parameters consists of one or more range values. Multiple parameters can be included by using comma-separated values. A valid query to game, player, team or meta must include at least one range parameter. ‡ indicates range parameters not applicable to the events endpoint.
| Team Code Lookup | A valid team code(s) for the chosen scope, case insensitive. More than one team can be specified as comma separated values. For the player endpoint, this is handled as opponent team code(s). Alabama Crimson Tide (CFB) https://interst.at/team/cfb/ala | |
| League Code‡ Lookup | A valid league code(s) for the chosen scope, case insensitive. More than one league can be specified as comma separated values. English Premier League teams https://interst.at/team/fc/eng-pre | |
| Season‡ XXXX | A four-character year of the last date in the season. Defaults to the current season. 2022 WNBA Schedule https://interst.at/game/wnba/2022 | |
| Season Range‡ XXXX-XXXX | A beginning and end season, inclusive. Cleveland Indians players, 1960-1964 https://interst.at/player/mlb/cle,1960-1964 | |
| Game ID | A valid numeric game identification number, which can be obtained from team or game queries. 2022 FIFA World Cup Final https://interst.at/game/fc/48752627 | |
| Player ID‡ | A valid numeric player identification number, which can be obtained from team, game or meta queries. Stephen Curry https://interst.at/player/nba/826 | |
| Date‡ XXXX-XX-XX | A date in YYYY-MM-DD format. Pro Football games on Nov 11, 2022 https://interst.at/game/pfb/2022-11-13 | |
| Date Range‡ XXXX-XX-XX, XXXX-XX-XX | A beginning and end date, comma separated, inclusive. (Any additional dates, beyond two, will be ignored by the system.) Kolten Wong between May 20-26, 2018 https://interst.at/player/mlb/12036,2018-05-20,2018-05-26 |
The meta endpoint has its own set of specialized parameters.
| status | The current status of a service, an array of available data, and a listing of known data issues. Current KBO Status https://interst.at/meta/kbo/status |
| teams | A simplified team directory for the specified service. Includes team codes that can be used at other endpoints, as well as team endpoint URIs. May be used in conjunction with League Code, Season or Season Range parameters. 2013 NCAA Division I Men's Basketball Teams https://interst.at/meta/mbb/teams,2013 |
| leagues | A simplified league directory for the specified service. Includes league codes that can be used at other endpoints. MiLB Leagues https://interst.at/meta/milb/leagues |
| players | A simplified player directory for the specified service. Includes player IDs that can be used at other endpoints, as well as player endpoint URIs. May be used in conjunction with Team Code, League Code, Season or Season Range parameters. 2017 Minnesota Twins https://interst.at/meta/mlb/players,min,2017 |
| venues | A list of venues with available metadata (e.g. locations, capacity, history). May be used in conjunction with Team Code, League Code, Season or Season Range parameters. 2023 NBA Venues https://interst.at/meta/nba/venues,2023 |
| officials | A listing of officials or umpires for a season, with stats if available. May be used in conjunction with a Season or Season Range parameter. 2021 WNBA Officials https://interst.at/meta/wnba/officials,2021 |
Using additional parameters can change the output format, as well as limit or hydrate certain query responses.
| Parameter | Endpoint(s) | Function | |
| json | all | format | Returns data in JavaScript Object Notation format. JSON is the default when a format is not specified. |
| xml | all | format | Returns data in W3C's Extensible Markup Language format. |
| php | all | format | Returns data in PHP SimpleXML Object format. |
| minimize | all | limit | Strips all data except for basic information: IDs, abbreviation codes, and/or names. |
| forecast | game | hydrate | Inserts a node containing all available forecast data (ELO, O/U, spread, simulated scorelines) in game lists. |
| playbyplay | player, team | hydrate | Inserts a node containing full detailed play-by-play data for the specified context. This node is automatically included in individual game payloads. |
| lineups | player, team | hydrate | Inserts a node containing full detailed lineup analysis and statistics for the specified context (basketball only). This node is automatically included in individual game payloads. |