Skip to content

Function: get

Jump to bottom
Todd Roberts edited this page Oct 26, 2024 · 3 revisions

Call MLB StatsAPI and return JSON data.

This function is for advanced querying of the MLB StatsAPI, and is used by the functions in this library.

statsapi.get(endpoint, params, force=False)

endpoint is one of the keys in the ENDPOINT dict.

params is a dict of parameters, as defined in the ENDPOINT dict for each endpoint. Defaults to empty dict ({}) as of v1.8.

force=True will force unrecognized parameters into the query string, and ignore parameter requirements.

Note: results from Stats API may not be as expected when forcing.

Example

statsapi.get('team', {'teamId':143}) will call the team endpoint for teamId=143 (Phillies)

Return value will be the raw response from MLB Stats API in json format.

Note: This information is provided for reference only, without warranty or guarantee, and is not official documentation provided by MLB. This package and its author are not affiliated with MLB or any MLB team. This API wrapper interfaces with MLB's Stats API. Use of MLB data is subject to the notice posted at http://gdx.mlb.com/components/copyright.txt.

Clone this wiki locally