package details

Team Scraper

usau_scraper.teamScraper.getTeamInfo(**kwargs)

getTeamInfo() returns all information about the first 20 teams matching the query

Args:

schoolName (string): The school that the team is affiliated with (ex. Columbia).

teamName (string): The name of the team (ex. Pleiades).

genderDivision (string): The gender division that the team competes in. Must be one of: Women, Men, Mixed, Boys, Girls.

state (string): Postal abbreviation of the state the team is in.

competitionLevel (string): The competition level that the team plays at. Must be one of: Club, College, High School, or Middle School.

competitionDivision (string): The competition division that the team plays in. Must be one of: Classic, Developmental, Division 1, or Division 3.

teamDesignation (string): If the team is a B or a C team. Must be B or C.

teamURI (string): If querying based on team URI, will simply return the results of the team with this URI andignore other parameters.

Returns:

results:

{
    res: OK, NOTFOUND
    teams: [
        {
            schoolName,
            teamName,
            competitionLevel,
            genderDivision,
            location,
            coaches,
            website,
            facebook,
            twitter,
        },
        ...
    ]
}

usau_scraper.teamScraper.getTeamRoster(**kwargs)

getTeamRoster() returns the roster of the first 20 teams matching the query

Args:

schoolName (string): The school that the team is affiliated with (ex. Columbia).

teamName (string): The name of the team (ex. Pleiades).

genderDivision (string): The gender division that the team competes in. Must be one of: Women, Men, Mixed, Boys, Girls.

state (string): Postal abbreviation of the state the team is in.

competitionLevel (string): The competition level that the team plays at. Must be one of: Club, College, High School, or Middle School.

competitionDivision (string): The competition division that the team plays in. Must be one of: Classic, Developmental, Division 1, or Division 3.

teamDesignation (string): If the team is a B or a C team. Must be B or C.

teamURI (string): If querying based on team URI, will simply return the results of the team with this URI and ignore other parameters.

Returns:

results:

{
    res: OK, NOTFOUND
    teams: [
        {
            schoolName,
            teamName,
            competitionLevel,
            genderDivision,
            roster: [
                {
                    no,
                    name,
                    pronouns,
                    position,
                    year,
                    height,
                },
                ...
            ]
        },
        ...
    ]
}

usau_scraper.teamScraper.getTeamSchedule(**kwargs)

getTeamSchedule() returns the season schedule and record of the first 20 teams matching the query

Args:

schoolName (string): The school that the team is affiliated with (ex. Columbia).

teamName (string): The name of the team (ex. Pleiades).

genderDivision (string): The gender division that the team competes in. Must be one of: Women, Men, Mixed, Boys, Girls.

state (string): Postal abbreviation of the state the team is in.

competitionLevel (string): The competition level that the team plays at. Must be one of: Club, College, High School, or Middle School.

competitionDivision (string): The competition division that the team plays in. Must be one of: Classic, Developmental, Division 1, or Division 3.

teamDesignation (string): If the team is a B or a C team. Must be B or C.

teamURI (string): If querying based on team URI, will simply return the results of the team with this URI and ignore other parameters.

Returns:

{
    res: OK, NOTFOUND
    teams: [
        {
            schoolName,
            teamName,
            competitionLevel,
            genderDivision,
            wins,
            losses,
            tournaments: {
                name: {
                    games: [
                        {
                            date,
                            score,
                            opponentCollege,
                            opponentTeamPage
                        },
                        ...
                    ]
                },
                ...
            },
        },
        ...
    ]
}

Tournament Scraper

usau_scraper.tournamentScraper.getTournamentBracketResults(competitionLevel, genderDivision, **kwargs)

getTournamentBracketResults() returns the bracket results of a tournament.

If the query returns multiple tournaments, returns the result of the first tournament that appears on the usau site which the query is issued.

Args:

competitionLevel (string) (required): The competition level of the tournament. Must be one of: Club, College, or High School.

genderDivision (string) (required): The gender division to view tournament results for. Must be one of: Women, Men, Mixed, Boys, Girls.

eventName (string): The name of the tournament.

state (string): Postal abbreviation of the state the tournament was in.

season (int): The season that the tournament occured in. Must be after 2006

Returns:

results:

{
    res: OK, NOTFOUND
    tournamentName: {
        bracketName: {
            roundName: [
                {
                    date,
                    time,
                    field,
                    winner,
                    loser,
                    score,
                    status
                },
                ...
            ]
        }
    }
}

usau_scraper.tournamentScraper.getTournamentPoolPlayResults(competitionLevel, genderDivision, **kwargs)

getTournamentPoolPlayResults() returns the pool play and consolation results of a tournament.

If the query returns multiple tournaments, returns the result of the first tournament that appears on the usau site which the query is issued.

Args:

competitionLevel (string) (required): The competition level of the tournament. Must be one of: Club, College, or High School.

genderDivision (string) (required): The gender division to view tournament results for. Must be one of: Women, Men, Mixed, Boys, Girls.

eventName (string): The name of the tournament.

state (string): Postal abbreviation of the state the tournament was in.

season (int): The season that the tournament occured in. Must be after 2006

Returns:

results:

{
    res: OK, NOTFOUND
    tournamentName: {
        pools: {
            poolName: [
                {
                    name,
                    wins,
                    losses
                },
                ...
            ],
            ...
        },
        rounds: {
            roundName: {
                sectionName: [
                    {
                        date,
                        time,
                        field,
                        team1Name,
                        team2Name,
                        score,
                        status
                    },
                    ...
                ]
            }
        }
    }
}

usau_scraper.tournamentScraper.getTournamentWinner(competitionLevel, genderDivision, **kwargs)

getTournamentWinner() returns the first and second place results of a tournament.

If the query returns multiple tournaments, returns the result of the first tournament that appears on the usau site which the query is issued.

Args:

competitionLevel (string) (required): The competition level of the tournament. Must be one of: Club, College, or High School.

genderDivision (string) (required): The gender division to view tournament results for. Must be one of: Women, Men, Mixed, Boys, Girls.

eventName (string): The name of the tournament.

state (string): Postal abbreviation of the state the tournament was in.

season (int): The season that the tournament occured in. Must be after 2006

Returns:

results:

{
    res: OK, NOTFOUND
    tournamentName: {
        firstPlace,
        secondPlace
    }
}

Rankings Scraper

usau_scraper.rankingScraper.getClubRankings(**kwargs)

getClubRankings() returns top 20 teams for inputted gender at the club competition level.

Args:

genderDivision (string): Women, Men, or Mixed (for Club only)

Returns:

results:

{
    res: OK, NOTFOUND
    teams: [
        {
            rank,
            team,
            powerRating,
            genderDivison,
            competitionDivision,
            city,
            state,
            clubRegion,
            clubSection,
            wins,
            losses
        },
        ...
    ]
}

usau_scraper.rankingScraper.getCollegeRankings(**kwargs)

getCollegeRankings() returns top 20 teams for inputted gender at the college competition level.

Args:

genderDivision (string): Women, Men, or Mixed (for Club only)

Returns:

results:

{
    res: OK, NOTFOUND
    teams: [
        {
            rank,
            team,
            powerRating,
            competitionLevel,
            genderDivison,
            competitionDivision,
            collegeRegion,
            collegeConference,
            wins,
            losses
        },
        ...
    ]
}