Enums
Value | Description |
---|---|
COMPETITION | If not selected then the competition will not be returned with marketCatalogue |
EVENT | If not selected then the event will not be returned with marketCatalogue |
EVENT_TYPE | If not selected then the eventType will not be returned with marketCatalogue |
MARKET_START_TIME | If not selected then the start time will not be returned with marketCatalogue |
MARKET_DESCRIPTION | If not selected then the description will not be returned with marketCatalogue |
RUNNER_DESCRIPTION | If not selected then the runners will not be returned with marketCatalogue |
RUNNER_METADATA | If not selected then the runner metadata will not be returned with marketCatalogue. If selected then RUNNER_DESCRIPTION will also be returned regardless of whether it is included as a market projection. |
Value | Description |
---|---|
SP_AVAILABLE | Amount available for the BSP auction. |
SP_TRADED | Amount traded in the BSP auction. |
EX_BEST_OFFERS | Only the best prices available for each runner, to requested price depth. |
EX_ALL_OFFERS | EX_ALL_OFFERS trumps EX_BEST_OFFERS if both settings are present |
EX_TRADED | Amount traded on the exchange. |
Value | Description |
---|---|
NO_ROLLUP | No rollup, return raw fragments |
ROLLED_UP_BY_PRICE | Rollup matched amounts by distinct matched prices per side. |
ROLLED_UP_BY_AVG_PRICE | Rollup matched amounts by average matched price per side |
Value | Description |
---|---|
ALL | EXECUTABLE and EXECUTION_COMPLETE orders |
EXECUTABLE | An order that has a remaining unmatched portion |
EXECUTION_COMPLETE | An order that does not have any remaining unmatched portion |
Value | Description |
---|---|
INACTIVE | The market has been created but isn't yet available. |
OPEN | The market is open for betting. |
SUSPENDED | The market is suspended and not available for betting. |
CLOSED | The market has been settled and is no longer available for betting. |
Value | Description |
---|---|
ACTIVE | ACTIVE |
WINNER | WINNER |
LOSER | LOSER |
REMOVED_VACANT | REMOVED_VACANT applies to Greyhounds. Greyhound markets always return a fixed number of runners (traps). If a dog has been removed, the trap is shown as vacant. |
REMOVED | REMOVED |
HIDDEN | The selection is hidden from the market. This occurs in Horse Racing markets were runners is hidden when it is doesn’t hold an official entry following an entry stage. This could be because the horse was never entered or because they have been scratched from a race at a declaration stage. |
Value | Description |
---|---|
DAYS | |
HOURS | |
MINUTES |
Value | Description |
---|---|
BACK | To back a team, horse or outcome is to bet on the selection to win. |
LAY | To lay a team, horse, or outcome is to bet on the selection to lose. |
Value | Description |
---|---|
EXECUTION_COMPLETE | An order that does not have any remaining unmatched portion. |
EXECUTABLE | An order that has a remaining unmatched portion. |
Value | Description |
---|---|
BY_BET | @Deprecated Use BY_PLACE_TIME instead. Order by placed time, then bet id. |
BY_MARKET | Order by market id, then placed time, then bet id. |
BY_MATCH_TIME | Order by time of last matched fragment (if any), then placed time, then bet id. Filters out orders which have no matched date. The dateRange filter (if specified) is applied to the matched date. |
BY_PLACE_TIME | Order by placed time, then bet id. This is an alias of to be deprecated BY_BET. The dateRange filter (if specified) is applied to the placed date. |
BY_SETTLED_TIME | Order by time of last settled fragment (if any due to partial market settlement), then by last match time, then placed time, then bet id. Filters out orders which have not been settled. The dateRange filter (if specified) is applied to the settled date. |
BY_VOID_TIME | Order by time of last voided fragment (if any), then by last match time, then placed time, then bet id. Filters out orders which have not been voided. The dateRange filter (if specified) is applied to the voided date. |
Value | Description |
---|---|
EARLIEST_TO_LATEST | Order from earliest value to latest e.g. lowest betId is first in the results. |
LATEST_TO_EARLIEST | Order from the latest value to the earliest e.g. highest betId is first in the results. |
Value | Description |
---|---|
LIMIT | A normal exchange limit order for immediate execution |
LIMIT_ON_CLOSE | Limit order for the auction (SP) |
MARKET_ON_CLOSE | Market order for the auction (SP) |
Value | Description |
---|---|
MINIMUM_TRADED | Minimum traded volume |
MAXIMUM_TRADED | Maximum traded volume |
MINIMUM_AVAILABLE | Minimum available to match |
MAXIMUM_AVAILABLE | Maximum available to match |
FIRST_TO_START | The closest markets based on their expected start time |
LAST_TO_START | The most distant markets based on their expected start time |
Value | Description |
---|---|
ODDS | Odds Market |
LINE | Line Market |
RANGE | Range Market |
ASIAN_HANDICAP_DOUBLE_LINE | Asian Handicap Market |
ASIAN_HANDICAP_SINGLE_LINE | Asian Single Line Market |
FIXED_ODDS | Sportsbook Odds Market. This type is deprecated and will be removed in future releases, when Sportsbook markets will be represented as ODDS market but with a different product type. |
Value | Description |
---|---|
SUCCESS | Order processed successfully |
FAILURE | Order failed. |
PROCESSED_WITH_ERRORS | The order itself has been accepted, but at least one (possibly all) actions have generated errors. This error only occurs for replaceOrders, cancelOrders and updateOrders operations. The placeOrders operation will not return PROCESSED_WITH_ERRORS status as it is an atomic operation. |
TIMEOUT | Order timed out. |
Value | Description |
---|---|
ERROR_IN_MATCHER | The matcher is not healthy |
PROCESSED_WITH_ERRORS | The order itself has been accepted, but at least one (possibly all) actions have generated errors |
BET_ACTION_ERROR | There is an error with an action that has caused the entire order to be rejected |
INVALID_ACCOUNT_STATE | Order rejected due to the account's status (suspended, inactive, dup cards) |
INVALID_WALLET_STATUS | Order rejected due to the account's wallet's status |
INSUFFICIENT_FUNDS | Account has exceeded its exposure limit or available to bet limit |
LOSS_LIMIT_EXCEEDED | The account has exceed the self imposed loss limit |
MARKET_SUSPENDED | Market is suspended |
MARKET_NOT_OPEN_FOR_BETTING | Market is not open for betting. It is either not yet active, suspended or closed awaiting settlement. |
DUPLICATE_TRANSACTION | duplicate customer referece data submitted |
INVALID_ORDER | Order cannot be accepted by the matcher due to the combination of actions. For example, bets being edited are not on the same market, or order includes both edits and placement |
INVALID_MARKET_ID | Market doesn't exist |
PERMISSION_DENIED | Business rules do not allow order to be placed |
DUPLICATE_BETIDS | duplicate bet ids found |
NO_ACTION_REQUIRED | Order hasn't been passed to matcher as system detected there will be no state change |
SERVICE_UNAVAILABLE | The requested service is unavailable |
REJECTED_BY_REGULATOR | The regulator rejected the order. On the Italian Exchange this error will occur if more than 50 bets are sent in a single placeOrders request. |
Value | Description |
---|---|
LAPSE | Lapse the order when the market is turned in-play |
PERSIST | Persist the order to in-play. The bet will be place automatically into the in-play market at the start of the event. |
MARKET_ON_CLOSE | Put the order into the auction (SP) at turn-in-play |
Value | Description |
---|---|
SUCCESS | |
FAILURE | |
TIMEOUT |
Value | Description |
---|---|
INVALID_BET_SIZE | bet size is invalid for your currency or your regulator |
INVALID_RUNNER | Runner does not exist, includes vacant traps in greyhound racing |
BET_TAKEN_OR_LAPSED | Bet cannot be cancelled or modified as it has already been taken or has lapsed Includes attempts to cancel/modify market on close BSP bets and cancelling limit on close BSP bets |
BET_IN_PROGRESS | No result was received from the matcher in a timeout configured for the system |
RUNNER_REMOVED | Runner has been removed from the event |
MARKET_NOT_OPEN_FOR_BETTING | Attempt to edit a bet on a market that has closed. |
LOSS_LIMIT_EXCEEDED | The action has caused the account to exceed the self imposed loss limit |
MARKET_NOT_OPEN_FOR_BSP_BETTING | Market now closed to bsp betting. Turned in-play or has been reconciled |
INVALID_PRICE_EDIT | Attempt to edit down the price of a bsp limit on close lay bet, or edit up the price of a limit on close back bet |
INVALID_ODDS | Odds not on price ladder - either edit or placement |
INSUFFICIENT_FUNDS | Insufficient funds available to cover the bet action. Either the exposure limit or available to bet limit would be exceeded |
INVALID_PERSISTENCE_TYPE | Invalid persistence type for this market, e.g. KEEP for a non bsp market |
ERROR_IN_MATCHER | A problem with the matcher prevented this action completing successfully |
INVALID_BACK_LAY_COMBINATION | The order contains a back and a lay for the same runner at overlapping prices. This would guarantee a self match. This also applies to BSP limit on close bets |
ERROR_IN_ORDER | The action failed because the parent order failed |
INVALID_BID_TYPE | Bid type is mandatory |
INVALID_BET_ID | Bet for id supplied has not been found |
CANCELLED_NOT_PLACED | Bet cancelled but replacement bet was not placed |
RELATED_ACTION_FAILED | Action failed due to the failure of a action on which this action is dependent |
NO_ACTION_REQUIRED | the action does not result in any state change. eg changing a persistence to it's current value |
Value | Description |
---|---|
STAKE | The volumes will be rolled up to the minimum value which is >= rollupLimit. |
PAYOUT | The volumes will be rolled up to the minimum value where the payout( price * volume ) is >= rollupLimit. |
MANAGED_LIABILITY | The volumes will be rolled up to the minimum value which is >= rollupLimit, until a lay price threshold. There after, the volumes will be rolled up to the minimum value such that the liability >= a minimum liability. Not supported as yet. |
NONE | No rollup will be applied. However the volumes will be filtered by currency specific minimum stake unless overridden specifically for the channel. |
Value | Description |
---|---|
EVENT_TYPE | A roll up of settled P&L, commission paid and number of bet orders, on a specified event type |
EVENT | A roll up of settled P&L, commission paid and number of bet orders, on a specified event |
MARKET | A roll up of settled P&L, commission paid and number of bet orders, on a specified market |
SIDE | An averaged roll up of settled P&L, and number of bets, on the specified side of a specified selection within a specified market, that are either settled or voided |
BET | The P&L, commission paid, side and regulatory information etc, about each individual bet order |
Value | Description |
---|---|
SETTLED | A matched bet that was settled normally |
VOIDED | A matched bet that was subsequently voided by Betfair, before, during or after settlement |
LAPSED | Unmatched bet that was cancelled by Betfair (for example at turn in play). |
CANCELLED | Unmatched bet that was cancelled by an explicit customer action. |