Skip to content

0.7 Player Search

Jump to bottom
Kurtis Nusbaum edited this page Jun 8, 2013 · 15 revisions

Back to 0.7 API The following methods are used to search for players.

Endpoints:

/players

GET - Search for nearby players

This method allows a client to retrieve a list players known by the server. Results can be narrowed by supplying any of the following optional parameters.

Parameters

  • latitude - The latitude to search near. (optional)
  • longitude - The longitude to search near (optional)
  • radius - The radius to search, in kilometers. Default is server-specified. This parameter is irrelevant (and ignored) unless a latitude and longitude are supplied. (optional)
  • name - The name of a player (optional)

This call supports Paging Semantics.

Example API Calls

/players?latitude=40.11241&longitude=-88.222053&radius=5

/players?name=cool+player

Returns

A JSON Array of Player objects.

Errors

HTTP 406 - Not Acceptable - Server radius is too large or too small. The response will set the X-Udj-Not-Acceptable-Reason header to bad-radius. HTTP 406 - Not Acceptable - Only one of the latitude or longitude parameters is specified. The response will set the X-Udj-Not-Acceptable-Reason header to latitude-longitude. HTTP 406 - Not Acceptable - The radius parameter is specified without specifying the latitude and longitude. The response will set the X-Udj-Not-Acceptable-Reason header to irrelevant-radius.

Clone this wiki locally