Filter Constraints Reference

Defines the date/time range of the tournaments to include based on the start date of the tournament.

The value can be one of the following:

• A natural number n (integer greater than 0) followed by a character ('Y', 'M', 'W', 'D', 'H', or 'S'). It denotes a time period of the last n years, months, weeks, days, hours or seconds respectively. E.g. "1Y" means "in the past year".
• A negative integer followed by one of the previously mentioned characters. It denotes a time offset in the future e.g. "up to the next 1 hour". This is only relevant for active tournaments in order to find tournaments that start in the near future. See "Active Tournaments" for further information.
• A year after 2006. It denotes that specific year as the time period.
• A range of Unix timestamps. It denotes the specified range of date/times as the time period.
• If the start date or scheduled start date is not available for a particular tournament the end date is used.

Defines the date/time range of the tournaments to include based on the end date of the tournament.

The value can be one of the following:

• A natural number n (integer greater than 0) followed by a character ('Y', 'M', 'W', 'D', 'H', or 'S'). It denotes a time period of the last n years, months, weeks, days, hours or seconds respectively. E.g. "1Y" means "in the past year".
• A negative integer followed by one of the previously mentioned characters. It denotes a time offset in the future e.g. "up to the next 1 hour". This is only relevant for active tournaments in order to find tournaments that start in the near future. See "Active Tournaments" for further information.
• A year after 2006. It denotes that specific year as the time period.
• A range of Unix timestamps. It denotes the specified range of date/times as the time period.

Defines the date/time range of the tournaments to include.

The value can be one or more days of week represented by the first two letters of week days in English. If multiple days are specified they must be separated by comma characters. An optional time-zone string may be specified as the 1st parameter in the list by prefixing with the 'TZ,' code. If specified, all days of week will be established relative to the given time-zone, else the default time-zone will be used (America/Los_Angeles). All time-zone strings are expected in the format defined by the Internet Assigned Numbers Authority (https://www.iana.org/time-zones). However, since SharkScope API references the Java TimeZone resource to discover time-zones, only a subset of time-zones provided by IANA are supported and users are advised to reference the Java TimeZone documentation for details.

Defines the date/time range of the tournaments to include.

The ranges can be post fixed with an "s", "m" or "h" to denote seconds, minutes or hours. If there is no postfix the number is assumed to denote minutes. For example "Duration: 30s-10" sets the duration range to 30 seconds to 10 minutes inclusive.

Defines the number of entrants as a range.

The value is a range. A star ("") character denotes "any", e.g. "5~" means "5 to any" or "more than 4".

Defines the tournament types to be included.

At the time of writing this document these are the available options:

Format options: TR (Tiered), SO (Shootout), OD (OnDemand), HU (Heads Up), FO (Flipout), R (Rebuy), FPP (FPP), SAT (Satellite), NS (N-Stack), ME (Multi Entry), RH (Rush)

PrizeStructure options: M (Matrix), B (Bounty), DN (Double or Nothing), J (Jackpot), K (Killer), TN (Triple or Nothing), W (Winner Takes All), C (Cashout), TI (Timed), F (Fifty50), HIT (Hit&Run)

Speed options: T (Turbo), ST (Super Turbo), D (Deep Stack), NBI (No Blind Increases), L (Lottery), N (Normal)

Structure options: NL (No Limit), PL (Pot Limit), PNL (PNL), FL (Limit), SL (Spread Limit), ML (Mixed Limit)

Game options: FU (Fusion), H (Hold'em), RV (Reverse Holdem), H6 (Six-Plus Holdem), SH (Showtime Holdem), SHO (Showtime Omaha), OMAHA (Any Omaha), O (Omaha Hi), OHL (Omaha H/L), O5 (Omaha 5), OHL5 (Omaha 5 H/L), O6 (Omaha 6), CL (Courchevel), CLHL (Courchevel H/L), CP (Crazy Pineapple), POFC (Pineapple), STUD (Any Stud), TS (Triple Stud), 7CS (7 Card Stud), 7CSHL (7 Card Stud H/L), 5CS (5 Card Stud), RAZZ (Razz), A (Americana), S (Soko), DRAW (Any Draw), 5CD (5 Card Draw), BA (Badugi), TD27L (2-7 Triple draw), SD27L (2-7 Single Draw), 32D (32 Draw), MIXED (Any Mixed), HORSE, HEROS, HOSE, RASH, HA, HAR, SHOE, TE (Telesina), 8G (8-Game), 7G (7-Game), 10G (10-Game), HBJ (Holdem BJ), HO, I (Irish Holdem)

Difficulty options: Easy, Neutral, Hard

TableSize options: 6MX (6 Max), HU (Heads Up)

Flag options: DM (Deal Made)

The list of possible values with grouping and description in English is included in the metadata.

Defines the tournament stake ranges to be included as a comma separated list of ranges (or single values) with currency and rebuy option. The format is min~max[R] (e.g. USD10~20R). The "R" postfix denotes that the average buy-in for the tournament including rebuys will be used for rebuy tournaments. The minimum or maximum can be "*" meaning "any".

Defines the tournament rake ranges to be included as a comma separated list of ranges (or single values) with currency and rebuy option. The format is min~max (e.g. USD10~20). The minimum or maximum can be "*" meaning "any".

Defines the tournament stake plus rake ranges to be included as a comma separated list of ranges (or single values) with currency and rebuy option. The format is min~max[R] (e.g. USD10~20R). The "R" postfix denotes that the average buy-in for the tournament including rebuys will be used for rebuy tournaments. The minimum or maximum can be "*" meaning "any".

This is similar to the Stake constraint with the Rake added.

Defines the tournament guarantee ranges to be included as a comma separated list of ranges (or single values) with currency and rebuy option. The format is min~max (e.g. USD10~20). The minimum or maximum can be "*" meaning "any".

Defines the tournament overlay ranges to be included as a comma separated list of ranges (or single values) with currency and rebuy option. The format is min~max (e.g. USD10~20). The minimum or maximum can be "*" meaning "any".

Defines the player's tournament result prize range. The parameter format is the same as the Stake constraint.

Defines the tournament prize pool range. The parameter format is the same as the Stake constraint.

Defines the tournament types to be included.

Tournament classes are SNG (Sit & Go), SCHEDULED and LIVE.

Defines the running or registering tournaments to be included in the response. The constraint defines the ranges of participants of specific player classes. For example, the request can contain a player class constraint of 2-4 players classified as "fish". Only one player class per constraint can be defined, however multiple player class constraints can be specified.

User specified player classes can be used.

In addition, each player class may have 1 or more categories assigned to it. Categories can be used in place of player class names. For example, there are currently three player classes representing "shark" players: HighStakesShark, MidStakesShark, LowStakesShark. These player classes are all members of the category "Shark" so the total number of any type of shark players can be filtered.

Defines a range of results based on a specified context. The contexts are Best, Worst, First and Last. The range is 1-based. This allows the user to request the specific number of tournaments to be taken into consideration (or returned).

The Limit constraint will narrow the tournaments to the best, worst, oldest or latest based on the specified range. So Limit:Best,1~250 will process the player's best 250 tournaments. Best and worst tournaments are determined by result (profit). First and Last are determined by date. Using this constraint tournaments can be retrieved in parts.

Users may save filters for future use. These filters are saved with a unique name. The filter can easily be reused (optionally in conjunction with other constraints) by utilizing the "Saved" constraint. The unique name must be URL encoded. The filter cannot be reversed with "!", an error will be thrown if reversal is specified.

The "versus player" contains a player list. The response contains a PlayerView for the player and one PlayerView containing tournaments against for each of the players in the list.

Defines the average number of rebuys to include when calculating statistics that contain rebuy tournaments. By default the average number of rebuys used is the average number for players in that tournament. A value of 0 would mean the player made no rebuys in any rebuy tournament.

Defines the rakeback percentage that should be included when calculating statistics.

The constraint is a filter on the tournament name. All tournaments whose name contains the provided string are included (or excluded if inverted).

The constraint is a filter on tournaments where the player made the prescribed number of re-entries.

The constraint is a filter on tournaments based on the hour of the day from 0 to 23 the tournament started.

An optional time-zone string may be specified as a comma separated parameter by prefixing with the 'TZ,' code. If specified, all hours will be established relative to the given time-zone, else the default time-zone will be used (America/Los_Angeles). All time-zone strings are expected in the format defined by the Internet Assigned Numbers Authority (https://www.iana.org/time-zones). However, since SharkScope API references the Java TimeZone resource to discover time-zones, only a subset of time-zones provided by IANA are supported and users are advised to reference the Java TimeZone documentation for details.

The constraint is a filter on tournaments where the player finished in the prescribed finish position. A value of FT can be used to designate Final Table. FT cannot be used in a range.