Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Type Definitions

...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleStartingPrices

Information about the Betfair Starting Price. Only available in BSP markets

Field name

Type

Required

Description

nearPrice

double


What the starting price would be if the market was reconciled now taking into account the SP bets as well as unmatched exchange bets on the same selection in the exchange. This data is cached and update every 60 seconds. Please note: Type Double may contain numbers, INF, -INF, and NaN.

farPrice

double


What the starting price would be if the market was reconciled now taking into account only the currently place SP bets. The Far Price is not as complicated but not as accurate and only accounts for money on the exchange at SP. This data is cached and updated every 60 seconds. Please note: Type Double may contain numbers, INF, -INF, and NaN.

backStakeTaken

List<#PriceSize >


The total amount of back bets matched at the actual Betfair Starting Price. Pre-reconciliation, this field is zero for all prices except 1.01 (for Market on Close bets) and at the limit price for any Limit on Close bets.

layLiabilityTaken

List< PriceSize >


The lay amount matched at the actual Betfair Starting Price. Pre-reconciliation, this field is zero for all prices except 1000 (for Market on Close bets) and at the limit price for any Limit on Close bets.

actualSP

double


The final BSP price for this runner. Only available for a BSP market that has been reconciled. Please note: for REMOVED runners the actualSP will be returned as 'NaN. Value may be returned as 'Infinity' if no BSP can be calculated.


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleClearedOrderSummary

 Summary of a cleared order.

Field name

Type

Required

Description

eventTypeId

EventTypeId


The id of the event type bet on. Available at EVENT_TYPE groupBy level or lower.

eventId

EventId


The id of the event bet on. Available at EVENT groupBy level or lower.

marketId

MarketId


The id of the market bet on. Available at MARKET groupBy level or lower.

selectionId

SelectionId


The id of the selection bet on. Available at RUNNER groupBy level or lower.

handicap

Handicap


The handicap.  Enter the specific handicap value (returned by RUNNER in listMaketBook) if the market is an Asian handicap market. Available at MARKET groupBy level or lower.

betId

BetId


The id of the bet. Available at BET groupBy level.

placedDate

Date


The date the bet order was placed by the customer. Only available at BET groupBy level.

persistenceType

PersistenceType


The turn in play persistence state of the order at bet placement time. This field will be empty or omitted on true SP bets. Only available at BET groupBy level.

orderType

OrderType


The type of bet (e.g standard limited-liability Exchange bet (LIMIT), a standard BSP bet (MARKET_ON_CLOSE), or a minimum-accepted-price BSP bet (LIMIT_ON_CLOSE)). If the bet has a OrderType of MARKET_ON_CLOSE and a persistenceType of MARKET_ON_CLOSE then it is a bet which has transitioned from LIMIT to MARKET_ON_CLOSE. Only available at BET groupBy level.

side

Side


Whether the bet was a back or lay bet. Available at SIDE groupBy level or lower.

itemDescription

ItemDescription


A container for all the ancillary data and localised text valid for this Item

betOutcome

String


The settlement outcome of the bet. Tri-state (WIN/LOSE/PLACE) to account for Each Way bets where the place portion of the bet won but the win portion lost. The profit/loss amount in this case could be positive or negative depending on the price matched at. Only available at BET groupBy level.

priceRequested

Price


The average requested price across all settled bet orders under this Item. Available at SIDE groupBy level or lower. For LINE markets this is the line position requested. For LINE markets this is the line position requested. 

settledDate

Date


The date and time the bet order was settled by Betfair. Available at SIDE groupBy level or lower.

lastMatchedDate

Date


The date and time the last bet order was matched by Betfair. Available on Settled orders only.

betCount

int


The number of actual bets within this grouping (will be 1 for BET groupBy)

commission

Size


The cumulative amount of commission paid by the customer across all bets under this Item, in the account currency. Available at EXCHANGE, EVENT_TYPE, EVENT and MARKET level groupings only.

priceMatched

Price


The average matched price across all settled bets or bet fragments under this Item. Available at SIDE groupBy level or lower. For LINE markets this is the line position matched at. 

priceReduced

boolean


If true, then the matched price was affected by a reduction factor due to of a runner removal from this Horse Racing market.

sizeSettled

Size


The cumulative bet size that was settled as matched or voided under this Item, in the account currency. Available at SIDE groupBy level or lower.

profit

Size


The profit or loss (negative profit) gained on this line, in the account currency

sizeCancelled

Size


The amount of the bet that was available to be matched, before cancellation or lapsing, in the account currency

customerOrderRef

String


The order reference defined by the customer for the bet order

customerStrategyRef

String


The strategy reference defined by the customer for the bet order

sourceIdKey

String

App Key used to place order

sourceIdDescription

String

Description associated with sourceIdKey e.g. Desktop, Mobile, API



Anchor
ClearedOrderSummaryReport
ClearedOrderSummaryReport

...