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
titleCurrentOrderSummary

Summary of a current order.

Field name

Type

Required

Description

betId

String

(tick)

The bet ID of the original place order.

marketId

String

(tick)

The market id the order is for.

selectionId

long

(tick)

The selection id the order is for.

handicap

double

(tick)

The handicap associated with the runner in case of Asian handicap markets, null otherwise.

priceSize

PriceSize

(tick)

The price and size of the bet.

bspLiability

double

(tick)

Not to be confused with size. This is the liability of a given BSP bet.

side

Side

(tick)

BACK/LAY

status

OrderStatus

(tick)

Either EXECUTABLE (an unmatched amount remains) or EXECUTION_COMPLETE (no unmatched amount remains).

persistenceType

PersistenceType

(tick)

What to do with the order at turn-in-play.

orderType

OrderType

(tick)

BSP Order type.

placedDate

Date

(tick)

The date, to the second, the bet was placed.

matchedDateDate

(tick)

The date, to the second, of the last matched bet fragment (where applicable)

averagePriceMatched

double


The average price matched at. Voided match fragments are removed from this average calculation. The price is automatically adjusted in the event of non runners being declared with applicable reduction factors. Please note: This value is not meaningful for activity on LINE markets and is not guaranteed to be returned or maintained for these markets. 

sizeMatched

double


The current amount of this bet that was matched.

sizeRemaining

double


The current amount of this bet that is unmatched.

sizeLapsed

double


The current amount of this bet that was lapsed.

sizeCancelled

double


The current amount of this bet that was cancelled.

sizeVoided

double


The current amount of this bet that was voided.

regulatorAuthCode

String


The regulator authorisation code.

regulatorCode

String


The regulator Code.

customerOrderRef

String


The order reference defined by the customer for this bet

customerStrategyRef

String


The strategy reference defined by the customer for this bet

includeItemDescriptioncurrentItemDescription

boolean

If true then extra description parameters are included in the CurrentOrderSummaryReport.CurrentItemDescription


A container for all the ancillary data for this Item



Anchor
PlaceInstruction
PlaceInstruction

...