Bet Angel
×
Full Guide

Type definitions

 

BetAngelAPIError

Field name
Type
Description
code
The error code
msg
string
The error message
 
 

AddMarketsInstruction

Field name
Type
Required
Description
marketIds
List < string >
ü
The betfair Ids of the markets that you wish to add
 
 

AddMarketsResponse

Field name
Type
Description
status
Indicates if the operation was successful
errors
List of any errors that occurred during processing
 
 

ApplyCouponInstruction

Field name
Type
Required
Description
couponName
string
ü
The name of the coupon (from the list of Coupon filters on the Coupon tab of Guardian) that you wish to use to load markets into Guardian and the Watch List.
clearOption
ü
The choice of what should be cleared before adding the new markets
watchListNumber
int
ü
The watch list that will contain the coupon. Value must be in the range [1 to 5]
 
 

ApplyCouponResponse

Field name
Type
Description
status
Indicates if the operation was successful
errors
List of any errors that occurred during processing
 
 

ApplyRulesInstruction

Field name
Type
Required
Description
rulesFileName
string
ü
The name of an Automation Rules File (from the list of available Rules Files in Guardian) that you wish to apply to the markets.
marketsFilter
ü
The choice of which markets will be assigned with the rules file.
guardianRulesColumn
int
ü
The number of the Automation Rules column that will be assigned the rules file. Value must be in the range [1 to 5]
 
 

ApplyRulesResponse

Field name
Type
Description
status
Indicates if the operation was successful
errors
List of any errors that occurred during processing
 
 

ClearStoredValuesInstruction

Field name
Type
Description
marketsFilter
Allows the stored values search to be limited to specific markets
selectionsFilter
Allows the stored values search to be limited to specific selections
instanceFilter
Allows the stored values search to be limited to specific Automation Instances
storedValueFilterBetAngelLevel
Provides the search with criteria about which Stored Values at the Bet Angel level need to be cleared.  Note: if the field is null, no stored Values at this level will be cleared.
storedValueFilterEventLevel
Provides the search with criteria about which Stored Values at the Event level need to be cleared.  Note: if the field is null, no stored Values at this level will be cleared.
storedValueFilterMarketLevel
Provides the search with criteria about which Stored Values at the Market level need to be cleared.  Note: if the field is null, no stored Values at this level will be cleared.
storedValueFilterSelectionLevel
Provides the search with criteria about which Stored Values at the Selection level need to be cleared.  Note: if the field is null, no stored Values at this level will be cleared.
writeToMarketLog
bool
If true, makes a note in the log of the market containing the Stored Value that the Stored Value has been cleared. Note: if the field is null, a false value is assumed
 
 

ClearStoredValuesResponse

Field name
Type
Description
status
Indicates if the operation was successful
errors
List of any errors that occurred during processing
 
 

ContainerFilter

Field name
Type
Required
Description
filter
ü
The choice of how the container should be filtered
ids
List< string >
 
Provides the filter with the list of Ids required, if applicable.
 
 

GetInstancesInstruction

Field name
Type
Required
Description
includeStoppedInstances
bool
 
When true, the search will include Automation Instances that are in a Stopped state. If this field is null then a false value is used, so Stopped instances are excluded.
fromId
long
 
If specified, the search will start from this Id onwards. If the field is null then the search will start from 1.
toId
long
 
If specified, the search will not go beyond this Id. If the field is null then the search will go to the last Instance created.
restrictToTypes
 
If specified, the search will only include Automation Instances that match one of the types provided. If the field is null, all types will be included.
marketsFilter
 
Allows the Automation Instance search to be limited to only the ones associated with the specified markets. If the field is null, all markets will be searched.
 
 

GetInstancesResponse

Field name
Type
Description
status
Indicates if the operation was successful
result
Contains the requested data
errors
List of any errors that occurred during processing
 
 

GetInstancesResult

Field name
Type
Description
instances
List of Automation Instance information objects. One per instance that satisfies the search criteria.
 

GetMarketsInstruction

Field name
Type
Required
Description
dataRequired
ü
The data items you wish to retrieve
 
 

GetMarketsResponse

Field name
Type
Description
status
Indicates if the operation was successful
result
Contains the requested data
errors
List of any errors that occurred during processing
 
 

GetMarketsResult

Field name
Type
Description
markets
List< MarketInfo >
List of market information objects. One per market loaded into Bet Angel
 
 

GetStoredValuesInstruction

Field name
Type
Description
marketsFilter
Allows the stored values search to be limited to specific markets
selectionsFilter
Allows the stored values search to be limited to specific selections
instanceFilter
Allows the stored values search to be limited to specific Automation Instances
storedValueFilterBetAngelLevel
Provides the search with criteria about which Stored Values at the Bet Angel level are required.  Note: if the field is null, no stored Values at this level will be returned.
storedValueFilterEventLevel
Provides the search with criteria about which Stored Values at the Event level are required.  Note: if the field is null, no stored Values at this level will be returned.
storedValueFilterMarketLevel
Provides the search with criteria about which Stored Values at the Market level are required.  Note: if the field is null, no stored Values at this level will be returned.
storedValueFilterSelectionLevel
Provides the search with criteria about which Stored Values at the Selection level are required.  Note: if the field is null, no stored Values at this level will be returned.
 
 

GetStoredValuesResponse

Field name
Type
Description
status
Indicates if the operation was successful
result
Contains the requested data
errors
List of any errors that occurred during processing
 
 

GetStoredValuesResult

Field name
Type
Description
betAngel
Contains the stored values at the Bet Angel level that met the search criteria.
events
List of containers of stored values at the event level that met the search criteria. One container per event that has information to return.
markets
List of containers of stored values (at the market and/or selection level) that met the search criteria. One container per market that has information to return.
 
 

InstanceContainer

Field name
Type
Description
id
long
The id of the Automation Instance. Note: Each new instance (i.e. Guardian Automation Rules assigned to a market, or Servant started) is given a new id. Ids start at 1 and increment with each new instance.
status
Indicates whether the instance is awaiting the first trigger, has started, or has stopped.
rulesFileName
string
The name of the rules being processed by this instance.
timeCreated
DateTime
The date and time this Automation Instance was created.
timeFirstTriggered
DateTime
The date and time this Automation Instance first triggered a rule. The field will be null if no rules have triggered.
marketId
string
The Id of the Market that is using the Automation Rules
marketName
string
The name of the Market that is using the Automation Rules
instanceType
Indicates whether the instance is being processed by Guardian or is running as a Servant or as the market's Safety Servant.
guardianRulesColumn
int
The Automation Rules column in Guardian that is associated with the Instance or null if running as a Servant.
 
 

InstanceFilter

Field name
Type
Required
Description
includeStoppedInstances
bool
 
When searching for Automation Instances, set this to true if instances that have already stopped should be included in the search.
filter
ü
The choice of how the Automation Instances should be filtered
instanceIds
List< long >
 
Provides the filter with the list of Automation Instance Ids required, if applicable.
 
 

MarketIdNamePair

Field name
Type
Description
id
string
Market Id
name
string
Market Name
 
 

MarketInfo

Field name
Type
Description
id
string
Market Id
name
string
Market Name
marketType
string
Market Type (matches betfair types)
eventId
string
Event Id (with time suffix for horse racing)
eventTypeId
string
Event Type Id
startTime
DateTime
Market Start Time
selections
List of selection information objects (if either Selection Id or Selection Name was requested). One per selection in the market.
 
 

RemoveMarketsInstruction

Field name
Type
Required
Description
marketsFilter
ü
The markets that you wish to remove
marketStatus
 
The market status must match this to be removed
 
 

RemoveMarketsResponse

Field name
Type
Description
status
Indicates if the operation was successful
result
Contains the markets that were removed
errors
List of any errors that occurred during processing
 
 

RemoveMarketsResult

Field name
Type
Description
marketsRemoved
List of the markets that were removed
 
 

RemoveRulesInstruction

Field name
Type
Required
Description
marketsFilter
ü
The choice of which markets will have their rules removed.
guardianRulesColumn
int
ü
The number of the Automation Rules column that will have its rules file removed. Value must be in the range [1 to 5]
 
 

RemoveRulesResponse

Field name
Type
Description
status
Indicates if the operation was successful
errors
List of any errors that occurred during processing
 
 

SelectionInfo

Field name
Type
Description
id
string
Selection Id
name
string
Selection Name
 
 

SetStoredValuesInstruction

Field name
Type
Description
betAngel
Holds the Stored Values that you wish to set at the Bet Angel level (all values at this level are Shared).  Note: if the field is null, no stored Values at this level will be set
events
Holds the Stored Values that you wish to set at the Event level (all values at this level are Shared).  The list should contain one StoredValuesContainer per Event that you wish to update. Note: if the field is null, no stored Values at this level will be set
markets
Holds the Stored Values that you wish to set at the Market and/or Selection level (either Shared or local to specific Automation Instances).  The list should contain one StoredValuesMarketContainer per Market that you wish to update. Note: if the field is null, no stored Values at this level will be set
writeToMarketLog
bool
If true, makes a note in the log of the market containing the Stored Value that the Stored Value has been set. Note: if the field is null, a false value is assumed
 
 

SetStoredValuesResponse

Field name
Type
Description
status
Indicates if the operation was successful
errors
List of any errors that occurred during processing
 
 

StoredValue

Field name
Type
Required
Description
n
string
ü
The name of the Stored Value
v
double
 
Populated with the value of the Stored Value if it is a Numeric type
t
string
 
Populated with the value of the Stored Value if it is a Text type
 
 

StoredValuesContainer

Field name
Type
Required
Description
id
string
ü
The Event Id or 'BetAngel' if used at Bet Angel level of containment
name
string
 
The Event Name or 'Bet Angel' if used at Bet Angel level of containment
sharedValues
ü
List of stored values that are shared at this level of containment
 
 

StoredValuesFilter

Field name
Type
Required
Description
excludeSharedValues
bool
 
When searching for Stored Values, set this to true you wish to exclude Shared values
excludeInstanceValues
bool
 
When searching for Stored Values, set this to true you wish to exclude values that are not marked as Shared and are therefore local to a specific Automation Instance
storedValueFilter
ü
The choice of how the stored values should be filtered
names
List< string >
 
Provides the filter with the list of Stored Value Names required, if applicable.
 
 

StoredValuesInstanceContainer

Field name
Type
Required
Description
instanceId
long
ü
The Id of the Automation Instance holding the Stored Values
values
 
List of stored values that are local to this instance
 
 

StoredValuesMarketContainer

Field name
Type
Required
Description
id
string
ü
The Market Id
name
string
 
The Market Name
sharedValues
 
List of stored values that are shared in this market
instances
 
List of stored values that are local to specific Automation Instances, grouped by Instance
selections
 
List of selections in the market that contain stored values
 
 

StoredValuesSelectionContainer

Field name
Type
Required
Description
id
string
ü
The Selection Id
name
string
 
The Selection Name
sharedValues
 
List of stored values that are shared in this selection
instances
 
List of stored values that are local to specific Automation Instances, grouped by Instance