SharkScope API - API Documentation

Name	Location	Type	Required	Description
`hash`	query	string	Optional	A unique identifier used to identify a copy of a dataset for consistency.

Name	Location	Type	Required	Description
`appname`	path	string	Required	Name of your application used to access the API
`question`	query	string	Optional	-
`timezone`	query	string	Optional	The timezone to use, as a string.
`locale`	query	string	Optional	-

Name	Location	Type	Required	Description
`appname`	path	string	Required	Name of your application used to access the API
`langCode`	query	string	Optional	-

Name	Location	Type	Required	Description
`limit`	query	integer	Optional	The maximum number of items to return in the response. If not specified, no limit is applied.

Name	Location	Type	Required	Description
`downloadType`	path	string	Required	Download type for client application.

Name	Location	Type	Required	Description
`downloadType`	path	string	Required	Download type for client application.
`version`	query	integer	Optional	The version of the client application to check.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`nlq`	query	string	Optional	The natural language query to use; see Natural Language Query for more details.
`nativecurrency`	query	string	Optional	The ISO 4217 currency code to use.
`displaycurrency`	query	string	Optional	The ISO 4217 currency code to use.
`currency`	query	string	Optional	The ISO 4217 currency code to use.
`lastUpdateTime`	query	integer	Optional	UNIX timestamp. If the last activity is less than or equal to this timestamp, returns 'Unchanged' response.
`timezone`	query	string	Optional	The timezone to use, as a string.
`groupsExcludeOptedOut`	query	boolean	Optional	Specifies if the groups that have opted out should be excluded from the response.
`groupsExcludeNotOptedIn`	query	boolean	Optional	Specifies if the groups that have not opted in should be excluded from the response.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`nativecurrency`	query	string	Optional	The ISO 4217 currency code to use.
`displaycurrency`	query	string	Optional	The ISO 4217 currency code to use.
`currency`	query	string	Optional	The ISO 4217 currency code to use.
`order`	query	string	Optional	player ordering (e.g. order=player,1~1000) to return the tournaments for each player in order.
`expandMultiEntries`	query	boolean	Optional	Specifies if the multi-entries should be expanded in the response.
`lastUpdateTime`	query	integer	Optional	UNIX timestamp. If the last activity is less than or equal to this timestamp, returns 'Unchanged' response.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`limit`	query	integer	Optional	The maximum number of items to return in the response. If not specified, no limit is applied.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`nativecurrency`	query	string	Optional	The ISO 4217 currency code to use.
`displaycurrency`	query	string	Optional	The ISO 4217 currency code to use.
`expandMultiEntries`	query	boolean	Optional	Specifies if the multi-entries should be expanded in the response.
`timezone`	query	string	Optional	The timezone to use, as a string.
`currency`	query	string	Optional	The ISO 4217 currency code to use.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`nativecurrency`	query	string	Optional	The ISO 4217 currency code to use.
`displaycurrency`	query	string	Optional	The ISO 4217 currency code to use.
`currency`	query	string	Optional	The ISO 4217 currency code to use.
`lastUpdateTime`	query	integer	Optional	UNIX timestamp. If the last activity is less than or equal to this timestamp, returns 'Unchanged' response.
`groupsExcludeOptedOut`	query	boolean	Optional	Specifies if the groups that have opted out should be excluded from the response.
`groupsExcludeNotOptedIn`	query	boolean	Optional	Specifies if the groups that have not opted in should be excluded from the response.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`statistics`	path	string	Required	-
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`nativecurrency`	query	string	Optional	The ISO 4217 currency code to use.
`displaycurrency`	query	string	Optional	The ISO 4217 currency code to use.
`currency`	query	string	Optional	The ISO 4217 currency code to use.
`lastUpdateTime`	query	integer	Optional	UNIX timestamp. If the last activity is less than or equal to this timestamp, returns 'Unchanged' response.
`groupsExcludeOptedOut`	query	boolean	Optional	Specifies if the groups that have opted out should be excluded from the response.
`groupsExcludeNotOptedIn`	query	boolean	Optional	Specifies if the groups that have not opted in should be excluded from the response.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`limit`	query	integer	Optional	The maximum number of items to return in the response.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`email`	query	string	Optional	The email address of the user; used to uniquely identify a SharkScope user.
`create`	query	string	Optional	-

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`email`	query	string	Optional	The email address of the user; used to uniquely identify a SharkScope user.
`create`	query	string	Optional	-

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`date`	query	string	Optional	The date in YYYY-MM-DD format for the request, defaulting to use the Pacific Time Zone.
`resetemail`	query	string	Optional	-
`force`	query	string	Optional	-

Name	Description	Width	Height
MiniSummary	A plaque showing several player statistics including an animated leaderboard icon (if present). Values are colored according to profit/loss	130	65
ProfitHistory	A small graph showing the player's profit history. The graph does not contain any player text.	250	250
ProfitHistoryLarge	A large graph showing the player's profit history. The graph also shows a few other player statiistics that put the chart in context.	600	250
ByStake	A small graph showing the player's ROI and number of games by most frequent stakes played.	250	250
ByEntrants	A small graph showing the player's ROI and profit history by their most frequent game sizes (entrants).	250	250
AvatarText (Deprecated)	A plaque showing several player statistics including an animated leaderboard icon (if present). Values are colored according to profit/loss	130	65
AvatarSmall (Deprecated)	A small graph showing the player's profit history. The graph does not contain any player text.	180	180
AvatarLarge (Deprecated)	A large graph showing the player's profit history. The graph also shows a few other player statiistics that put the chart in context.	600	250

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`type`	query	string	Optional	The type of the graph to use.
`currency`	query	string	Optional	The ISO 4217 currency code to use.
`freshness`	query	integer	Optional	Interval in seconds after which the underlying data will be refreshed and thus another cost incurred
`width`	query	integer	Optional	Used to scale a graph to the desired size.
`height`	query	integer	Optional	Used to scale a graph to the desired size.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`lastUpdateTime`	query	integer	Optional	UNIX timestamp. If the last activity is less than or equal to this timestamp, returns 'Unchanged' response.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`nativecurrency`	query	string	Optional	The ISO 4217 currency code to use.
`displaycurrency`	query	string	Optional	The ISO 4217 currency code to use.
`currency`	query	string	Optional	The ISO 4217 currency code to use.
`lastUpdateTime`	query	integer	Optional	UNIX timestamp. If the last activity is less than or equal to this timestamp, returns 'Unchanged' response.
`groupsExcludeOptedOut`	query	boolean	Optional	Specifies if the groups that have opted out should be excluded from the response.
`groupsExcludeNotOptedIn`	query	boolean	Optional	Specifies if the groups that have not opted in should be excluded from the response.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`id`	path	string	Required	-
`nativecurrency`	query	string	Optional	The ISO 4217 currency code to use.
`displaycurrency`	query	string	Optional	The ISO 4217 currency code to use.
`currency`	query	string	Optional	The ISO 4217 currency code to use.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.
`currency`	query	string	Optional	The ISO 4217 currency code to use.
`timezoneOffset`	query	integer	Optional	The timezone offset to use, timezoneOffset from GMT in hours.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`name`	path	string	Required	The name of the player.

Name	Location	Type	Required	Description
`playergroup`	path	string	Required	Name of the player group to use.

Name	Location	Type	Required	Description
`playergroup`	path	string	Required	Name of the player group to use.
`public`	query	string	Optional	Defines if the data is public or private.
`consolidated`	query	string	Optional	Determines if a group is consolidated or not, consolidated groups behave as a single player.
`name`	query	string	Optional	The name of the player group.

Name	Location	Type	Required	Description
`playergroup`	path	string	Required	Name of the player group to use.
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`playername`	path	string	Required	Name of the player to use.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`blogicon`	query	string	Optional
`vsplayer`	query	string	Optional	-

Name	Location	Type	Required	Description
`playergroup`	path	string	Required	Name of the player group to use.
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`playername`	path	string	Required	Name of the player to use.
`blogicon`	query	string	Optional

Name	Location	Type	Required	Description
`playergroup`	path	string	Required	Name of the player group to use.
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`playername`	path	string	Required	Name of the player to use.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.

Name	Location	Type	Required	Description
`playergroup`	path	string	Required	Name of the player group to use.

Name	Location	Type	Required	Description
`playergroup`	path	string	Required	Name of the player group to use.
`name`	query	string	Optional	The name of the player.

Name	Location	Type	Required	Description
`playergroup`	path	string	Required	Name of the player group to use.
`email`	query	string	Optional	The email address of the user; used to uniquely identify a SharkScope user.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`id`	path	string	Required	-
`nativecurrency`	query	string	Optional	The ISO 4217 currency code to use.
`displaycurrency`	query	string	Optional	The ISO 4217 currency code to use.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`limit`	query	integer	Optional	The maximum number of items to return in the response. If not specified, no limit is applied.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`order`	query	string	Optional	player ordering (e.g. order=player,1~1000) to return the tournaments for each player in order.
`expandMultiEntries`	query	boolean	Optional	Specifies if the multi-entries should be expanded in the response.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`nativecurrency`	query	string	Optional	The ISO 4217 currency code to use.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`tournamentID`	path	integer	Required	The tournament ID to use, as defined by the network.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`id`	path	string	Required	The ID of the tournament to use.
`lastUpdateTime`	query	integer	Optional	UNIX timestamp. If the last activity is less than or equal to this timestamp, returns 'Unchanged' response.
`nativecurrency`	query	string	Optional	The ISO 4217 currency code to use.
`displaycurrency`	query	string	Optional	The ISO 4217 currency code to use.
`expandMultiEntries`	query	boolean	Optional	Specifies if the multi-entries should be expanded in the response.
`noPlayers`	query	boolean	Optional	Strip out players from the response.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`id`	path	string	Required	The ID of the tournament to use.
`lastUpdateTime`	query	integer	Optional	UNIX timestamp. If the last activity is less than or equal to this timestamp, returns 'Unchanged' response.
`nativecurrency`	query	string	Optional	The ISO 4217 currency code to use.
`displaycurrency`	query	string	Optional	The ISO 4217 currency code to use.
`expandMultiEntries`	query	boolean	Optional	Specifies if the multi-entries should be expanded in the response.
`noPlayers`	query	boolean	Optional	Strip out players from the response.

Name	Location	Type	Required	Description
`year`	path	string	Required	The year to use.

Name	Location	Type	Required	Description
`year`	path	string	Required	The year to use.
`category`	path	string	Required	-

Name	Location	Type	Required	Description
`year`	path	string	Required	The year to use.
`category`	path	string	Required	-
`subcategory`	path	string	Required	-
`rankingstatistic`	query	string	Optional	The ranking statistic to use.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.

Name	Location	Type	Required	Description
`network`	path	string	Required	The network to use, where * denotes all networks and @ denotes any network.
`appname`	path	string	Required	Name of your application used to access the API

GET

/{appname}/user

Free

Performs a login confirmation. The response only contains the UserInfo element if successful.

Parameters

Name	Location	Type	Required	Description
`permission`	query	string	Optional	-

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default Response A response object containing the UserInfo element if successful.

GET

/{appname}/user/preferences

Auth Required Free

Requests the user's preferences.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserPreferencesResponse A user preferences response object.

GET

/{appname}/user/blogurl

Auth Required Free

Requests the user's Blog URL. The blog URL is used only when the user sets up a personal group. The blog URL is then added as a blog icon to selected members of that group. When setting, the value must be URL encoded. To be able to set the blog URL the user must have the appropriate authorization.

Parameters

Name	Location	Type	Required	Description
`value`	query	string	Optional	The URL of the blog to use.
`appname`	path	string	Required	Name of your application used to access the API

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default BlogUrlResponse A blog url response object.

DELETE

/{appname}/user/blogurl

Auth Required Free

Deletes the user's Blog URL. The blog URL is used only when the user sets up a personal group. The blog URL is then added as a blog icon to selected members of that group. When setting, the value must be URL encoded. To be able to set the blog URL the user must have the appropriate authorization.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default BlogUrlResponse A blog url response object.

GET

/{appname}/user/metadata

Auth Required Free

Requests user-specific metadata information from the server.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserMetadataResponse A user metadata response object.

POST

/{appname}/user/preferences/update

Auth Required Free

Updates the value of one or more user preferences. If the value is empty the preference is removed.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserPreferencesResponse A user preferences response object.

GET

/{appname}/user/preferences/update

Auth Required Free

Updates the value of one or more user preferences. If the value is empty the preference is removed.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserPreferencesResponse A user preferences response object.

GET

/{appname}/user/payments

Auth Required Free

Requests the user's payments

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserPaymentsResponse A user payments response object.

GET

/{appname}/user/create

Auth Required Free

The optional affID parameter specifies the affiliation ID, the country specifies the user's country (if not specified it is determined by the IP address, and the emailOption parameter (Y/N) specifies if the user should be added to the sharkscope mailing list.
The password passed as part of the authentication should be encoded only once using MD5 and not encoded using the application key as described in section 1.4.

Example:

String password = “ab1234”;
byte[] defaultBytes = password.getBytes();
try {
  MessageDigest algorithm = MessageDigest.getInstance("MD5");
  algorithm.reset();
  algorithm.update(defaultBytes);
  byte messageDigest[] = algorithm.digest();
  StringBuffer hexString = new StringBuffer();
  for (int co = 0; co < messageDigest.length; co++) {
    hexString.append(Integer.toHexString(0xFF & messageDigest[co]));
  }
}

Parameters

Name	Location	Type	Required	Description
`country`	query	string	Optional	the country specifies the user’s country, ISO 3166-1 alpha-2 code e.g US.
`emailOption`	query	string	Optional	Specifies if the user should be added to the SharkScope mailing list for news and updates.
`attributionData`	query	string	Optional	-

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default Response A response object containing the UserInfo element if successful.

GET

/{appname}/user/filters

Auth Required Free

Request to get the saved filter list. The response contains the UserFilters element if there are any saved filters available for the logged in user.

Parameters

Name	Location	Type	Required	Description
`types`	query	string	Optional	The types of filters to use

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserFiltersResponse A user filters response object.

GET

/{appname}/user/filters/{filterName}/save

Auth Required Free

Request to save the filter definition using a filter name. The response contains the UserFilters element.

Parameters

Name	Location	Type	Required	Description
`filterName`	path	string	Required	Name given to a filte; see Filter Constraints Reference for more details.
`filter`	query	string	Optional	Defines the filter the server will apply to constrain the response; see Filter Constraints Reference for more details.
`networks`	query	string	Optional	List of names of the networks separated by a comma, where * denotes all networks and @ denotes any network.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserFiltersResponse A user filters response object.

GET

/{appname}/user/filters/{filterName}

Auth Required Free

Request to get the saved filter definition by name. The response contains the UserFilters element if there is any saved filters available by the given name.

Parameters

Name	Location	Type	Required	Description
`filterName`	path	string	Required	Name given to a filte; see Filter Constraints Reference for more details.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserFiltersResponse A user filters response object.

GET

/{appname}/user/filters/{filterName}/delete

Auth Required Free

Request to delete a saved filter definition. The response contains the UserFilters element.

Parameters

Name	Location	Type	Required	Description
`filterName`	path	string	Required	Name given to a filte; see Filter Constraints Reference for more details.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserFiltersResponse A user filters response object.

GET

/{appname}/user/username/change

Auth Required Free

Request to change the email of a registered user. The response only contains the UserInfo element if successful.

Parameters

Name	Location	Type	Required	Description
`newemail`	query	string	Optional	The new email address to use.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default Response A response object containing the UserInfo element if successful.

GET

/{appname}/user/password/change

Auth Required Free

Request to change the password for registered user. The response only contains the UserInfo element if successful.

Parameters

Name	Location	Type	Required	Description
`newpassword`	query	string	Optional	The new password to use.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default Response A response object containing the UserInfo element if successful.

GET

/{appname}/user/playerclasses

Auth Required Free

Requests the user-specific player classes a user. These are the combination of the non-overridden default and user-defined player classes.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserPlayerClassesResponse A user player classes response object.

GET

/{appname}/user/playerclasses/defined

Auth Required Free

Requests the user-defined player classes a user has previously saved.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserPlayerClassesResponse A user player classes response object.

GET

/{appname}/user/playerclasses/defined/{playerClass}

Auth Required Free

Creates or modifies a user-defined player class. Also overrides a default player class. Returns the created/modified/overridden player class. The rules parameter is a string of semicolon separated entries of :~ values, one of which can be * for any (see example). The categories parameter is a string of semicolon separated entries and is used for grouping the classes into like groups for the Tournament player class summary field.

Parameters

Name	Location	Type	Required	Description
`playerClass`	path	string	Required	Name of the player class to use.
`categories`	query	string	Optional	A semicolon separated list of entries, used for grouping the classes into like groups for the Tournament player class summary field.
`currency`	query	string	Optional	The ISO 4217 currency code to use.
`priority`	query	integer	Optional	Priority of the player class to use.
`rules`	query	string	Optional	semicolon separated entries of :~ values, one of which can be * for any
`icon`	query	string	Optional	Location of an icon to be displayed such as a gif.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserPlayerClassesResponse A user player classes response object.

DELETE

/{appname}/user/playerclasses/defined/{playerClass}

Auth Required Free

Deletes user-defined player class or default player class override and returns the remaining user-defined classes.

Parameters

Name	Location	Type	Required	Description
`playerClass`	path	string	Required	Name of the player class to use.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserPlayerClassesResponse A user player classes response object.

GET

/{appname}/user/reseller

Auth Required Free

Returns, if present, all the reseller information, such as; Reseller packages bought, credit remaining, the discount level, a list of packages that have been assigned to users and a list of subscriptions that are available to purchase (with roleIDs).

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default ResellerInfoResponse A reseller info response object.

GET

/{appname}/user/reseller/payment

Auth Required Free

Adds a subscription of a given role id to a given user's account, subtracting the cost from the resellers account. If the userEmail address is not found in the system, then an account is automatically created and the subscription assigned to that email.
Returns, if present, all the reseller information, such as; Reseller packages bought, credit remaining, the discount level, a list of packages that have been assigned to users and a list of subscriptions that are available to purchase (with roleIDs).

Parameters

Name	Location	Type	Required	Description
`userEmail`	query	string	Optional	The email address of the user.
`roleID`	query	string	Optional	The role ID defines the type of SharkScope subscription, and hence the value of any payment.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default ResellerInfoResponse A reseller info response object.

PUT

/{appname}/users/{username}/permission

Auth Required Free

Sets the permission for a user to use a specific application - with an expiry date. This is for applications that do not have a specific reseller payment system and just give users time-limited permissions. This request can only be called by the designated application user administrator.
The expiry date must be in Unix format i.e. seconds since standard epoch of 1/1/1970. If it is null, the permission does not expire (i.e. it is perpetual).
You can set the expiry to any date in the future. The GenericReponse returned just contains the expiry date. If the permission is perpetual the text “Perpetual” is returned in the GenericResponse.

Parameters

Name	Location	Type	Required	Description
`username`	path	string	Required	The username of the user.
`appname`	path	string	Required	Name of your application used to access the API
`expiry`	query	integer	Optional	The expiry date in Unix time format i.e. seconds since standard epoch of 1/1/1970. If not specified, there will be expiry.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default Response A generic response object.

GET

/{appname}/users/{username}/permission

Auth Required Free

Gets the expiry for a user's permission to use a specific application. This is for applications that do not have a specific reseller payment system and just give users time-limited permissions. This request can only be called by the designated application user administrator.
The expiry date will be returned in Unix time format i.e. seconds since standard epoch of 1/1/1970. If the permission is perpetual the text “Perpetual” will be returned in the response. If the user does not have permission to use the application the text “No Permission” will be returned.

Parameters

Name	Location	Type	Required	Description
`username`	path	string	Required	The username of the user.
`appname`	path	string	Required	Name of your application used to access the API

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default Response A generic response object.

DELETE

/{appname}/users/{username}/permission

Auth Required Free

Deletes the permission for a user's permission to use a specific application. This is for applications that do not have a specific reseller payment system and just give users time-limited permissions. This request can only be called by the designated application user administrator.
The request returns “No Permission” in a GenericResponse i.e. the same response a GET would return for a user with no permission. If the deletion failed the text is “Unknown”.

Parameters

Name	Location	Type	Required	Description
`username`	path	string	Required	The username of the user.
`appname`	path	string	Required	Name of your application used to access the API

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default Response A generic response object.

GET

/{appname}/user/notes

Auth Required Free

The request allows the user to retrieve all user notes they have attached to players. It also allows setting, updating or deleting notes for players.
In the case of updating the notes post parameter should contain lines of text. The first line should be the network name, the second line should be the player name and the following lines should contain the notes. A line containing only a dot (‘.’) character denotes the end of the notes. If the notes are empty – i.e. the dot line is the only line any notes already assigned to the player will be deleted. Otherwise the notes will replace the notes already assigned to players.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserNotesResponse A user notes response object.

POST

/{appname}/user/notes

Auth Required Free

The request allows the user to retrieve all user notes they have attached to players. It also allows setting, updating or deleting notes for players.
In the case of updating the notes post parameter should contain lines of text. The first line should be the network name, the second line should be the player name and the following lines should contain the notes. A line containing only a dot (‘.’) character denotes the end of the notes. If the notes are empty – i.e. the dot line is the only line any notes already assigned to the player will be deleted. Otherwise the notes will replace the notes already assigned to players.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Request Body

Content Type: */*

Loading request body fields...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserNotesResponse A user notes response object.

GET

/{appname}/user/manager

Auth Required Free

Sets the manager account for the user. Managers are able to see the user's email address, subscription status and view and reset their personal player names.

Parameters

Name	Location	Type	Required	Description
`value`	query	string	Optional	The user ID of the manager to use.
`appname`	path	string	Required	Name of your application used to access the API

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default ManagerResponse A manager response object.

DELETE

/{appname}/user/manager

Auth Required Free

Removes any existing manager the user has assign on their account

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default ManagerResponse A manager response object.

GET

/{appname}/user/secondarymanager

Auth Required Free

Sets the secondary manager account for the user. Managers are able to see the user's email address, subscription status and view and reset their personal player names. This feature is only for subscribers.

Parameters

Name	Location	Type	Required	Description
`value`	query	string	Optional	The user ID of the secondary manager to use.
`appname`	path	string	Required	Name of your application used to access the API

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default ManagerResponse A manager response object.

DELETE

/{appname}/user/secondarymanager

Auth Required Free

Removes any existing secondary manager the user has assign on their account

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default ManagerResponse A manager response object.

GET

/{appname}/user/usageHistory

Auth Required Free

Returns the user's search usage history, broken down by date, network and action. Note this resource only updates every few minutes so please allow time for the latest usage to appear. Each request costs 1 search to prevent this resource from being overloaded.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default UserUsageHistoryResponse A user usage history response object.

GET

/{appname}/user/reseller/payment/preview

Auth Required Free

Reseller self-service operation: previews a prospective sale for the
customer identified by userEmail under the reseller role (roleID)
before it is committed. Restricted to authenticated reseller accounts.

Parameters

Name	Location	Type	Required	Description
`userEmail`	query	string	Optional	The email address of the user.
`roleID`	query	string	Optional	The role ID defines the type of SharkScope subscription, and hence the value of any payment.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default Response default response

GET

/{appname}/user/reseller/payment/edit

Auth Required Free

Reseller self-service operation: edits a line item (itemIndex) on a
reseller payment transaction (txnID) for the given role (roleID).
Restricted to authenticated reseller accounts.

Parameters

Name	Location	Type	Required	Description
`txnID`	query	string	Optional	-
`itemIndex`	query	string	Optional	-
`roleID`	query	string	Optional	The role ID defines the type of SharkScope subscription, and hence the value of any payment.

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default Response default response

GET

/{appname}/user/reseller/payment/remove

Auth Required Free

Reseller self-service operation: removes a line item (itemIndex) from a
reseller payment transaction (txnID). Restricted to authenticated
reseller accounts.

Parameters

Name	Location	Type	Required	Description
`txnID`	query	string	Optional	-
`itemIndex`	query	string	Optional	-

Try This Endpoint

Fill in any parameters below, then click Send Request to call the API.

Request URL:

Parameters

Loading parameters...

Headers

Headers (Accept) and Authentication (Username/Password) are configured globally at the top of the page.

Response Body

Responses

default Response default response

Name	Location	Type	Required	Description
`regions`	path	string	Required	The regions to use, as a comma separated list.
`year`	query	integer	Optional	The year to use.
`month`	query	integer	Optional	The month to return the data, where 1 is January and 12 is December.
`type`	query	string	Optional	The type of the network market share report to use.

Name	Location	Type	Required	Description
`dealName`	path	string	Required	-
`id`	query	string	Optional	-
`activationCode`	query	string	Optional	Activation code for deal activation

Welcome to SharkScope API

Generic Resources

Metadata

Parameters

Try This Endpoint

Parameters

Headers

Response Body

Responses

Natural Language Filter

Parameters

Try This Endpoint

Parameters

Headers

Response Body

Responses

Hand Analysis

Parameters

Try This Endpoint

Parameters

Request Body

Headers

Response Body

Responses

Countries

Try This Endpoint

Parameters

Headers

Response Body

Responses

What's New

Parameters

Try This Endpoint

Parameters

Headers

Response Body

Responses

Sharkscope Client Resources

Client

Parameters

Try This Endpoint

Parameters

Headers

Response Body

Responses

Version

Parameters

Try This Endpoint

Parameters

Headers

Response Body

Responses

Player Resources

Summary

Parameters

Try This Endpoint

Parameters

Headers

Response Body

Responses

Completed Tournaments

Parameters

Try This Endpoint

Parameters

Headers

Response Body

Responses

Active Tournaments

Parameters

Try This Endpoint

Parameters

Headers

Response Body

Responses

Tournaments CSV Export

Parameters

Try This Endpoint

Parameters

Headers

Response Body