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. This is either a fully unmatched or partially matched bet (order) |
EXECUTION_COMPLETE | An order that does not have any remaining unmatched portion. This is a fully matched bet (order). |
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 |
PLACED | The runner was placed, applies to EACH_WAY marketTypes only. |
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. All matched customer bet prices are set to 1.0 even if there are later supplementary stages. Should it appear likely that a specific runner may actually be supplemented into the race this runner will be reinstated with all matched customer bets set back to the original prices. |
Value | Description |
---|---|
DAYS | |
HOURS | |
MINUTES |
Value | Description |
---|---|
BACK | To back a team, horse or outcome is to bet on the selection to win. For LINE markets a Back bet refers to a SELL line. A SELL line will win if the outcome is LESS THAN the taken line (price) |
LAY | To lay a team, horse, or outcome is to bet on the selection to lose. For LINE markets a Lay bet refers to a BUY line. A BUY line will win if the outcome is MORE THAN the taken line (price) |
Value | Description |
---|---|
PENDING | An asynchronous order is yet to be processed. Once the bet has been processed by the exchange |
EXECUTION_COMPLETE | An order that does not have any remaining unmatched portion. |
EXECUTABLE | An order that has a remaining unmatched portion. |
EXPIRED | The order is no longer available for execution due to its time in force constraint. |
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 - Any market that doesn't fit any any of the below categories. |
LINE | Line Market - LINE markets operate at even-money odds of 2.0. However, price for these markets refers to the line positions available as defined by the markets min-max range and interval steps. Customers either Buy a line (LAY bet, winning if outcome is greater than the taken line (price)) or Sell a line (BACK bet, winning if outcome is less than the taken line (price)). If settled outcome equals the taken line, stake is returned. |
RANGE | Range Market - Now Deprecated |
ASIAN_HANDICAP_DOUBLE_LINE | Asian Handicap Market - A traditional Asian handicap market. Can be identified by marketType ASIAN_HANDICAP |
ASIAN_HANDICAP_SINGLE_LINE | Asian Single Line Market - A market in which there can be 0 or multiple winners. e,.g marketType TOTAL_GOALS |
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. In normal circumstances the placeOrders operation will not return PROCESSED_WITH_ERRORS status as it is an atomic operation. PLEASE NOTE: if the 'Best Execution' features is switched off, placeOrders can return ‘PROCESSED_WITH_ERRORS’ meaning that some bets can be rejected and other placed when submitted in the same PlaceInstruction |
TIMEOUT | The order timed out & the status of the bet is unknown. If a TIMEOUT error occurs on a placeOrders/replaceOrders request, you should check listCurrentOrders to verify the status of your bets before placing further orders. Please Note: Timeouts will occur after 5 seconds of attempting to process the bet but please allow up to 15 seconds for a timed out order to appear. After this time any unprocessed bets will automatically be Lapsed and no longer be available on the Exchange. |
Value | Description |
---|---|
ERROR_IN_MATCHER | The matcher is not healthy. Please note: The error will also be returned is you attempt concurrent 'cancel all' bets requests using cancelOrders which isn't permitted. |
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. Check the instructionReports errorCode for the reason for the rejection of the order. |
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 reference data submitted - Please note: There is a time window associated with the de-duplication of duplicate submissions which is 60 second |
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. You are either attempting to place the order using a Delayed Application Key or from a restricted jurisdiction (i.e. USA) |
DUPLICATE_BETIDS | Duplicate bet ids found. For example, you've included the same betId more than once in a single cancelOrders request. |
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. |
NO_CHASING | A specific error code that relates to Spanish Exchange markets only which indicates that the bet placed contravenes the Spanish regulatory rules relating to loss chasing. |
REGULATOR_IS_NOT_AVAILABLE | The underlying regulator service is not available. |
TOO_MANY_INSTRUCTIONS | The amount of orders exceeded the maximum amount allowed to be executed |
INVALID_MARKET_VERSION | The supplied market version is invalid. Max length allowed for market version is 12. |
INVALID_PROFIT_RATIO | The order falls outside the permitted price and size combination. |
Value | Description |
---|---|
LAPSE | Lapse (cancel) the order automatically when the market is turned in play if the bet is unmatched |
PERSIST | Persist the unmatched order to in-play. The bet will be placed automatically into the in-play market at the start of the event. Once in play, the bet won't be cancelled by Betfair if a material event takes place and will be available until matched or cancelled by the user |
MARKET_ON_CLOSE | Put the order into the auction (SP) at turn-in-play |
Value | Description |
---|---|
SUCCESS | The instruction was successful. |
FAILURE | The instruction failed. |
TIMEOUT | The order timed out & the status of the bet is unknown. If a TIMEOUT error occurs on a placeOrders/replaceOrders request, you should check listCurrentOrders to verify the status of your bets before placing further orders. Please Note: Timeouts will occur after 5 seconds of attempting to process the bet but please allow up to 15 seconds for a timed out order to appear. After this time any unprocessed bets will automatically be Lapsed and no longer be available on the Exchange. |
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 been cancelled/lapsed Includes attempts to cancel/modify market on close BSP bets and cancelling limit on close BSP bets. The error may be returned on placeOrders request if for example a bet is placed at the point when a market admin event takes place (i.e. market is turned in-play). The error will also be returned if a market version is submitted and a material change has taken place since the bet was submitted causing the bet to be rejected. |
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 in-play 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 |
TIME_IN_FORCE_CONFLICT | You may only specify a time in force on either the place request OR on individual limit order instructions (not both), |
UNEXPECTED_PERSISTENCE_TYPE | You have specified a persistence type for a FILL_OR_KILL order, which is nonsensical because no umatched portion |
INVALID_ORDER_TYPE | You have specified a time in force of FILL_OR_KILL, but have included a non-LIMIT order type. |
UNEXPECTED_MIN_FILL_SIZE | You have specified a minFillSize on a limit order, where the limit order's time in force is not FILL_OR_KILL. |
INVALID_CUSTOMER_ORDER_REF | The supplied customer order reference is too long. |
INVALID_MIN_FILL_SIZE | The minFillSize must be greater than zero and less than or equal to the order's size. The minFillSize cannot be less than the minimum bet size for your currency |
BET_LAPSED_PRICE_IMPROVEMENT_TOO_LARGE | Your bet is lapsed. There is better odds than requested available in the market, but your preferences don't allow the system to match your bet against better odds. Change your betting preferences to accept better odds if you don't want to receive this error. Please see https://support.betfair.com/app/answers/detail/a_id/404/ for more details regarding Best Execution and how to update your settings. |
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. On a LINE market, volumes will be rolled up where payout( 2.0 * 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, 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. |
Value | Description |
---|---|
A | Asian Handicap |
L | Line market |
O | Odds market |
R | Range market. |
NOT_APPLICABLE | The market does not have an applicable marketType. |
Value | Description |
---|---|
FILL_OR_KILL | Execute the transaction immediately and completely (filled to size or between minFillSize and size) or not at all (cancelled). For LINE markets Volume Weighted Average Price (VWAP) functionality is disabled |
Value | Description |
---|---|
BACKERS_PROFIT | The payout requested minus the calculated size at which this LimitOrder is to be placed. BetTargetType bets are invalid for LINE markets |
PAYOUT | The total payout requested on a LimitOrder |
Value | Description |
---|---|
CLASSIC | Price ladder increments traditionally used for Odds Markets. |
FINEST | Price ladder with the finest available increment, traditionally used for |
LINE_RANGE | Price ladder used for LINE markets. Refer to MarketLineRangeInfo for more details. |