Cancel the bet if it is unmatched when the market turns in-play
KEEP
string
Keep the bet if it is unmatched when the market turns in-play
TAKE_SP
string
Match the bet at SP if it is unmatched when the market turns in-play
BetAngelAPIErrorCode
Value
Type
Description
BAD_REQUEST
string
The JSON request did not contain the required information. e.g. A null required field. See the error message for more details.
UNKNOWN_EVENT
string
None of the markets loaded into Bet Angel match the specified Event Id
UNKNOWN_MARKET
string
The specified market is not currently loaded into Bet Angel
MARKET_NOT_IN_GUARDIAN
string
The specified market is not currently loaded into Guardian
MARKET_NOT_IN_A_TRADING_SCREEN
string
The specified market is not currently active on the main trading screen or in a one-click / ladder window
UNKNOWN_SELECTION
string
The specified selection is not a member of the specified market (or perhaps any of the markets loaded into Bet Angel)
UNKNOWN_INSTANCE
string
The specified Automation Instance Id could not be found based on the filter criteria provided
UNKNOWN_COUPON
string
The coupon name provided could not be found in Bet Angel
UNKNOWN_RULES_FILE
string
The Automation Rules File name provided could not be found in Bet Angel
INVALID_RULES_FILE
string
The Automation Rules File could not be used. e.g. Perhaps a Servant rules file is being added to Guardian
UNKNOWN_STORED_VALUE_NAME
string
The specified Stored Value could not be found based on the filter criteria (market / selection etc)
INVALID_STORED_VALUE_NAME
string
Unable to use that Stored Value Name. Perhaps the name is blank.
INVALID_STORED_VALUE
string
Unable to set the Stored Value. Perhaps both the Text and Numeric values were missing
INVALID_RULE_COLUMN
string
Guardian supports rule columns 1 to 5. A different value must have been specified.
INVALID_NOMINATED_SELECTION_COLUMN
string
Guardian supports nominated selection columns 1 to 5. A different value must have been specified.
INVALID_WATCH_LIST
string
Watch Lists are numbered 1 to 5. A different value must have been specified
INVALID_DISPLAY_CHOICE
string
To display a market, the displayChoice field must be set to a valid setting
INVALID_WINDOW_ID
string
Either the window id wasn't provided when it was required, or the value used was out of range
WINDOW_NOT_OPEN
string
A request to close a trading window failed because the window wasn't open
INVALID_SCREEN_TYPE
string
The screenType was either null when required or was set to an unsupported value
INVALID_INSTANCE_ID
string
There was a problem with the Automation Instance Ids provided. Perhaps the range of values in the search criteria was not valid.
INSTANCE_STOPPED
string
The specified Automation Instance has stopped, but the request did not allow Stopped instances
ERROR_FROM_BETFAIR
string
An error occurred when the Betting component used the betfair API
UNKNOWN_PENDING_RESULT_ID
string
The pending result Id specified could not be found in the market for the operation used
UNKNOWN_BET_REF
string
The bet reference used in the request is not known to Bet Angel for the market specified
BET_MATCHED
string
The bet has already been matched and cannot be modified
INCORRECT_BET_TYPE
string
The bet reference of a Lay bet has been used with a Back only operation or the bet reference of a Back bet has been used with a Lay only operation.
INVALID_PRICE
string
The price used is null or zero when a valid price was required
INVALID_STAKE_OR_LIABILITY
string
The stake used is too small or doesn't pass betfair's payout/liability rules
INVALID_GLOBAL_SETTINGS
string
The Global Settings used when placing a bet did not pass the validation checks for the request
INVALID_CLOSE_TRADE_PARAMS
string
The parameters used in the closeTrade operation did not pass the validation checks
OTHER
string
Used to report errors that do not fall into any of the above categories. e.g. An Exception was caught and is being reported.
BetType
Value
Type
Description
BACK
string
Back bet
LAY
string
Lay bet
BSPBetType
Value
Type
Description
PRICE_LIMIT
string
BSP bet has a price limit
NO_LIMIT
string
BSP bet does not have a price limit
CancelBetsFilterOption
Value
Type
Description
ALL
string
All bet references in the market will be included
SPECIFIED_BET_REFS
string
Only the specified bet references will be included
SPECIFIED_SELECTION_IDS
string
Only the bets on the specified selection Ids will be included
CancelBetStatus
Value
Type
Description
OK
string
The bet was cancelled
FOK_KILLED_EARLY
string
A bet with an active Fill or Kill timer has had the timer truncated so that the bet is killed early
FAILED
string
The bet was not cancelled
PENDING
string
The bet is currently being cancelled and Bet Angel is awaiting the result of the call to betfair
CancelBetsType
Value
Type
Description
ALL
string
Both Back & Lay bets will be included
BACK_ONLY
string
Only Back bets will be included
LAY_ONLY
string
Only Lay bets will be included
CloseTradePriceOption
Value
Type
Description
FIXED_PRICE
string
Place the closing trade at the fixed price specified in the instruction.
BEST_PRICE
string
Use the selection's best price when closing a trade.
SECOND_BEST_PRICE
string
Use the selection's second best price when closing a trade.
THIRD_BEST_PRICE
string
Use the selection's third best price when closing a trade.
REVERSE_PRICE
string
Use the selection's best price on the reverse side of the market when closing a trade.
Note: Using any of the reverse price options will add extra profit, but comes with the higher risk that the closing bet will stay unmatched in the market requiring further management.
SECOND_REVERSE_PRICE
string
Use the selection's second best price on the reverse side of the market when closing a trade.
THIRD_REVERSE_PRICE
string
Use the selection's third best price on the reverse side of the market when closing a trade.
TICKS_ABOVE_BEST_PRICE
string
Place the closing trade the specified number of ticks above the selection's best price.
TICKS_BELOW_BEST_PRICE
string
Place the closing trade the specified number of ticks below the selection's best price.
TICKS_ABOVE_REVERSE_PRICE
string
Place the closing trade the specified number of ticks above the selection's best price on the reverse side of the market.
TICKS_BELOW_REVERSE_PRICE
string
Place the closing trade the specified number of ticks below the selection's best price on the reverse side of the market.
PERC_ABOVE_BEST_PRICE
string
Place the closing trade the specified percentage above the selection's best price.
PERC_BELOW_BEST_PRICE
string
Place the closing trade the specified percentage below the selection's best price
PERC_ABOVE_REVERSE_PRICE
string
Place the closing trade the specified percentage above the selection's best price on the reverse side of the market.
PERC_BELOW_REVERSE_PRICE
string
Place the closing trade the specified percentage below the selection's best price on the reverse side of the market.
CouponClearOptions
Value
Type
Description
DONT_CLEAR
string
No markets are removed
CLEAR_GUARDIAN_AND_WATCH_LIST
string
Markets are removed from Guardian and the specified watch list before adding the new markets
CLEAR_WATCH_LIST_ONLY
string
Markets are removed from the specified watch list, but NOT Guardian, before adding the new markets
DisplayMarketChoice
Value
Type
Description
MAIN_ONE_CLICK
string
Display the market on the main trading screen focused on the One-click page
MAIN_LADDER
string
Display the market on the main trading screen focused on the Ladder page
NEW_ONE_CLICK_WINDOW
string
Create a new One-click window and display the market on it
NEW_LADDER_WINDOW
string
Create a new Ladder window and display the market on it
SPECIFIC_ONE_CLICK_WINDOW
string
Display the market in the specified One-click window
SPECIFIC_LADDER_WINDOW
string
Display the market in the specified Ladder window
FilterInstanceOption
Value
Type
Description
ALL
string
All Automation Instances will be included
SPECIFIED_IDS
string
Only the specified Automation Instances Ids will be included.
FilterOption
Value
Type
Description
ALL
string
All Ids at this level of containment will be included
SPECIFIED_IDS
string
Only the specified Ids at this level of containment will be included (e.g. market Ids for a market level container, selection Ids for a selection level container etc)
FilterStoredValueOption
Value
Type
Description
ALL
string
All Stored Values will be included
SPECIFIED_NAMES
string
Only the specified Stored Value names will be included.
GlobalSettingsAction
Value
Type
Description
NONE
string
No offset or stop required
OFFSET
string
Offset the opening bet
OFFSET_AND_STOP
string
Offset the opening bet and attach a stop loss
OFFSET_AND_TRAILING_STOP
string
Offset the opening bet and attach a trailing stop loss
OFFSET_WITH_GREENING
string
Offset the opening bet (adjusting the stake to apply greening)
OFFSET_WITH_GREENING_AND_STOP
string
Offset the opening bet and attach a stop loss (adjusting the stake to apply greening)
OFFSET_WITH_GREENING_AND_TRAILING_STOP
string
Offset the opening bet and attach a trailing stop loss (adjusting the stake to apply greening)
STOP_ON_OPENING_BET
string
Attach a stop loss to the opening bet
GreenAllPriceOption
Value
Type
Description
BEST_MARKET_PRICE
string
Use the Best Market Price when greening all selections
REVERSE_MARKET_PRICE
string
Use the Reverse Market Price when greening all selections.
Note: Using the reverse price will add extra profit, but with the higher risk that the bets will stay unmatched in the market requiring further greening.
InstanceStatus
Value
Type
Description
PENDING
string
No rules have yet triggered in this instance.
ACTIVE
string
At least one rule has triggered and at least one of the rules is still active
STOPPED
string
All the rules in the instance have stopped execution.
InstanceType
Value
Type
Description
GUARDIAN
string
The instance is being processed by Guardian
SERVANT
string
The instance is running as a Servant
SAFETY_SERVANT
string
The instance is the market's Safety Servant
LinkReason
Value
Type
Description
OFFSET
string
Indicates that this bet was created as an Offset bet
STOP
string
Indicates that this bet was created as a Stop bet
MarketBetsFilterOption
Value
Type
Description
ALL
string
All bets will be included
ALL_MATCHED
string
All matched bets will be included
ALL_UNMATCHED
string
All unmatched bets will be included
SPECIFIED_BET_REFS
string
Only the specified bet references will be included
MarketBettingStatus
Value
Type
Description
OPEN
string
The market is open for betting
SUSPENDED
string
The market is currently suspended
CLOSED
string
The market is now closed
MarketDataItem
Value
Type
Description
ID
string
Market Id
NAME
string
Market Name
MARKET_TYPE
string
Market Type (matches betfair types. e.g. WIN, PLACE, MATCH_ODDS etc)
EVENT_ID
string
Event Id (with time suffix for horse racing)
EVENT_TYPE_ID
string
Event Type Id
MARKET_START_TIME
string
Market Start Time
MARKET_INPLAY_STATUS
string
Market In-play indicator
SELECTION_IDS
string
Selection Id
SELECTION_NAMES
string
Selection Name
MarketPriceDataItem
Value
Type
Description
BEST_PRICE_ONLY
string
Requests back1 & lay1 fields for each selection
BEST_THREE_PRICES
string
Requests back1, back2, back3, lay1, lay2, lay3 fields for each selection
BEST_SIX_PRICES
string
Requests back1 to back6, lay1 to lay6 fields for each selection
BEST_TEN_PRICES
string
Requests back1 to back10, lay1 to lay10 fields for each selection
INPLAY_INFO
string
Requests inPlay and inPlayTime fields for the market
LAST_TRADED_PRICE
string
Requests LTP field for each selection
SP
string
Requests projSP and actSP fields for each selection
VOLUME
string
Requests volume field for the market and vol field for each selection
PROFIT
string
Requests profIfWins field and profIfLoses field (when applicable) for each selection
CLOSE_TRADE_PROFIT
string
Requests closeProf field for each selection
GREENING_PROFIT
string
Requests greenAllProfit field for the market and closeProfGreen field for each selection
UNMATCHED_BET_SUMMARY
string
Requests the umbBack and umbLay objects for each selection
MATCHED_BET_SUMMARY
string
Requests the mbBack and mbLay objects for each selection
MarketStatus
Value
Type
Description
ANY
string
Markets will not be filtered by status - default value
SUSPENDED
string
Only markets that are suspended or closed will satisfy this filter.
CLOSED
string
Only markets that are closed will satisfy this filter.
ModifyBetStatus
Value
Type
Description
OK
string
The bet was modified
FAILED
string
The bet was not modified
PENDING
string
The bet is currently being modified and Bet Angel is awaiting the result of the call(s) to betfair
PlaceBetStatus
Value
Type
Description
OK
string
The bet was placed
FAILED
string
The bet was not placed
PENDING
string
The bet is currently being placed and Bet Angel is awaiting the result of the call to betfair
ResponseStatus
Value
Type
Description
OK
string
The operation was successful and completed without error
PENDING
string
The operation was marked as asynchronous and is currently being processed in the background
PROCESSED_WITH_ERRORS
string
The request must have contained a list of data items to process, some were successful, some were not. Error messages will have been returned in the response.
FAILED
string
The operation was not processed or threw an exception during processing
