Python client for xmlstats API
Project description
A python module for interacting with the xmlstats API
This module aims to closely mirror the methods provided by the xmlstats API in terms of parameters and output structure.
Installing
pip install xmlstats-py
Usage
Xmlstats can return “objectified” data, in which nested JSON objects from the xmlstats API are accessible as attributes, or it can return data in native python objects, as if parsed with json.load().
stats = Xmlstats(access_token=MY_ACCESS_TOKEN, user_agent=MY_USER_AGENT, objectify=True)
# if objectify=False, data will be returned in native python objects
stats.objectify_off() # set objectify = False
stats.objectify_on() # set objectify = True
Methods
See the API documentation for a complete explanation of parameters and results. #####get_boxscore(sport, event_id) sport = “nba” or “mlb”
get_events(date, sport)
Date must be in YYYYmmdd format
get_teams(sport)
get_roster(sport, team_id, status=None)
status = “expanded” will return the 40-man roster for an MLB team, rather than 25-man roster
get_nba_team_stats(date, team_id=None)
get_team_results(team_id, season=None, since=None, until=None, order=None)
get_nba_draft_results(season=None, team_id=None)
get_nba_leaders(category, limit=None,qualified=None, season_type=None)
For list of category IDs, see here. Qualified parameter (default=True) determines whether players who meet NBA’s minimum qualifications will be returned, or all players.
get_standings(sport, date=None)
get_wildcard_standings(date)
Examples
Get Boxscores for a given date - yyyymmdd
stats = Xmlstats(access_token=MY_ACCESS_TOKEN, user_agent=MY_USER_AGENT)
events = stats.get_events(date=20141028, sport="nba") # returns event objects for all nba events on given date
event_ids = [event.event_id for event in events.event]
boxscores = []
for event_id in event_ids:
boxscores.append(stats.get_boxscore(sport="nba", event_id))
Note: As in the xmlstats API, the get_events() method returns an instance with 2 attributes: events_date is a date string; event is an array of event objects
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for Xmlstats_py-0.1.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd5330ca4e4920699aa6cd00e7dfa1583909928ba357a0e8ecb9fa01438b057f |
|
MD5 | 6dc88d1d1be040622385377fd0976ead |
|
BLAKE2b-256 | e4ae0657e3787ec2ff06877058ede97e797c0bb4103e4a59e1c5a08cce9867ba |