Players Endpoint

The /players endpoint contains over 60,000 players, both active and inactive - this changes infrequently. It will generally be updated once a week when new ranking information comes in, following the end of a tournament.

We recommend that you request the https://dde-api.data.imgarena.com/players REST end point once a week, for this reason, so that you have the most up-to-date information on the players in the ATP & UTR.

Due to the large response message size for requests made using the "activity=inactive" and "activity=all" parameters, the responses, although successful, will not return any information. We therefore recommend that any requests made to the /players REST endpoint are no larger than "results=10000"

This endpoint lists all the players registered with the ATP & UTR

Request Parameters

*Please note that the optional fields are dependent on data being known and available in our database.

This endpoint takes the following parameters:

Parameter	Type	Purpose
activity	string	This is an optional field. Possible values are "active" "inactive" and "all". They are not case sensitive. active returns just active players, inactive returns only the inactive players and all, returns all. If not specified, only the active players are returned. E.g. activity=all
gender	string	This is an optional field. Possible values are "male" and "female"
results	string	This is an optional field, and should be used in conjunction with the offset parameter. Possible values are numbers: "1", "2" etc, but will only return information on the first X players in the response. E.g. "activity=active&results=3" will return information for the first three active players in the response, and nothing else
offset	string	This is an optional field, and should be used in conjunction with the results parameter. Possible values are numbers: "1", "2" etc, but will only return information on players who are after X players in the response. E.g. "activity=active&offset=3" will ignore the first 3 players in the active list, and return everything from player four onwards
showRanking	boolean	By default, if no value passed or set as true, we will return ranking for players. Passing False will not return rankings.
gender	boolean	By default, feed will return both men and women. Possible values: "men" "female"

Best practice (using the results and offset parameters):

When results and offset are used together, you can specify how many players are 'ignored' and not included in the response, as well as the number of players who are included in the response. E.g. "results=10&offset=10" will bring back the first 10 players after the first 10 are ignored (Players 11 through 20)

If you would like to obtain the full list of inactive players (over 50,000 players), you can do so in increments of 5000, increasing the 'offset' value, whilst keeping 'results' the same. Examples below:

"results=5000" - this will bring back information for the first 5000 players. "results=5000&offset=5000" - this will bring back information for players 5001 through 10000. "results=5000&offset=10000" - this will bring back information for players 10001 through 15000. "results=5000&offset=15000" - this will bring back information for players 15001 through 20000. etc.