added lookup_player() and lookup_team()

Author: toddrob99

README.md

@@ -15,40 +15,41 @@ If you install manually, be sure to also install requests.
 
 ## Available Functions
 
-* `statsapi.get()` - make calls directly to MLB StatsAPI endpoints;
-  supports the most flexibility in request parameters, and returns raw json data
+* `statsapi.get()` - make calls directly to MLB StatsAPI endpoints; supports the most flexibility in request parameters, and returns raw json data
 
-* `statsapi.meta()` - retrieve available values from StatsAPI for use in other queries,
-  or look up descriptions for values found in API results
+* `statsapi.meta()` - retrieve available values from StatsAPI for use in other queries, or look up descriptions for values found in API results
 
-* `statsapi.notes()` - retrieve notes for a given endpoint, 
-  including a list of required parameters, as well as hints for some endpoints
+* `statsapi.notes()` - retrieve notes for a given endpoint, including a list of required parameters, as well as hints for some endpoints
+
+* `statsapi.lookup_player()` - get a list of player data based on first, last, or full name, jersey number, current team Id, position, etc.
+
+* `statsapi.lookup_team()` - get a lsit of teams info based on the team name, city, abbreviation, or file code
 
 * `statsapi.schedule()` - retrieve a list of games on a given date/range and/or team/opponent
 
 * `statsapi.boxscore()` - generate a formatted boxscore for a given game
 
 * `statsapi.linescore()` - generate a formatted linescore for a given game
 
-* `statsapi.roster()` - generate a list of players on a team's roster
+* `statsapi.roster()` - generate a formatted list of players on a team's roster
 
 * `statsapi.standings()` - generate a formatted list of standings for a given league/date
 
-* `statsapi.team_leaders()` - generate a list of a team's leaders for a given stat
+* `statsapi.team_leaders()` - generate a formatted list of a team's leaders for a given stat
 
-* `statsapi.league_leaders()` - generate a list of stat leaders for all-time (single season) or a given season
+* `statsapi.league_leaders()` - generate a formatted list of stat leaders for all-time (single season) or a given season
 
-* `statsapi.player_stats()` - get a list of a player's career or season stats
+* `statsapi.player_stats()` - generate a formatted list of a player's career or season stats
 
 * `statsapi.last_game()` - get the game id for the given team's most recent game
 
 * `statsapi.next_game()` - get the game id for the given team's next game
 
-* `statsapi.game_highlights()` - generate a list of highlights with video links for a given game
+* `statsapi.game_highlights()` - generate a formatted list of highlights with video links for a given game
 
-* `statsapi.game_pace()` - get information about pace of game for a given season (back to 1999)
+* `statsapi.game_pace()` - generate a formatted list of pace of game information for a given season (back to 1999)
 
-* `statsapi.game_scoring_plays()` - get a list of scoring plays for a given game
+* `statsapi.game_scoring_plays()` - generate a formatted list of scoring plays for a given game
 
 ## Example Use
 

statsapi/__init__.py

@@ -883,6 +883,87 @@ def player_stats(personId,group='[hitting,pitching,fielding]',type='season'):
 
     return stats
 
+def lookup_player(lookup_value,gameType='R',season=datetime.now().year,sportId=1):
+    """Get data about players based on first, last, or full name.
+
+    Example use:
+
+    Look up player id for Aaron Nola
+    Note: if using a full last name as the lookup_value and that last name could be part of another player's lastname,
+    e.g. 'Nola' is part of 'Nolan', include a comma on the end of the last name in order to match on the 'initLastName'
+    field which looks like 'Nola, A'
+
+    player = statsapi.lookup_player('nola,')
+    print(player[0]['id']) #assume only 1 record returned for demo purposes
+
+    Output:
+
+    605400
+
+
+    Print full name and position for all players named Harper
+
+    for player in statsapi.lookup_player('Harper'):
+        print('Full name: {}, Position: {}'.format(player['fullName'], player['primaryPosition']['abbreviation']))
+
+    Output:
+
+    Full name: Bryce Harper, Position: RF
+    Full name: Ryne Harper, Position: P
+    """
+    params = {'gameType':gameType, 'season':season, 'sportId':sportId, 'fields':'people,id,fullName,firstName,lastName,primaryNumber,currentTeam,id,primaryPosition,code,abbreviation,useName,boxscoreName,nickName,mlbDebutDate,nameFirstLast,firstLastName,lastFirstName,lastInitName,initLastName,fullFMLName,fullLFMName'}
+    r = get('sports_players',params)
+
+    players = []
+    for player in r['people']:
+        for v in player.values():
+            if str(lookup_value).lower() in str(v).lower():
+                players.append(player)
+                break
+
+    return players
+
+def lookup_team(lookup_value,activeStatus='Y',season=datetime.now().year,sportIds=1):
+    """Get a info about a team based on the team name, city, abbreviation, or file code.
+
+    Values for activeStatus: Y, N, B (Both)
+
+    Return value will be a list of teams matching the lookup_value. 
+    If no matches are found, an empty list will be returned.
+
+    Example use:
+
+    Get teamId for team with code cwa
+
+    team = statsapi.lookup_team('chn')
+    print(team[0]['id']) #assume only 1 record returned for demo purposes
+
+    Output:
+
+    112
+
+
+    Get info about all teams from NY
+
+    for team in statsapi.lookup_team('ny'):
+        print(team)
+
+    Output:
+
+    {'id': 147, 'name': 'New York Yankees', 'teamCode': 'nya', 'fileCode': 'nyy', 'teamName': 'Yankees', 'locationName': 'Bronx', 'shortName': 'NY Yankees'}
+    {'id': 121, 'name': 'New York Mets', 'teamCode': 'nyn', 'fileCode': 'nym', 'teamName': 'Mets', 'locationName': 'New York', 'shortName': 'NY Mets'}
+    """
+    params = {'activeStatus':activeStatus, 'season':season, 'sportIds':sportIds, 'fields':'teams,id,name,teamCode,fileCode,teamName,locationName,shortName'}
+    r = get('teams',params)
+
+    teams = []
+    for team in r['teams']:
+        for v in team.values():
+            if str(lookup_value).lower() in str(v).lower():
+                teams.append(team)
+                break
+    return teams
+
 def team_leaders(teamId,leaderCategories,season=datetime.now().year,leaderGameTypes='R',limit=10):
     """Get stat leaders for a given team.
 

statsapi/endpoints.py

@@ -859,7 +859,7 @@
                                                                                         'required': True
                                                                                     }
                                                                     },
-                                                    'query_params': ['season','gameType'],
+                                                    'query_params': ['season','gameType','fields'],
                                                     'required_params': [['season']]
                                                 },
                 'standings':                    {