Versions Compared

Key

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

...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titlePlaceInstructionReport

Response to a PlaceInstruction

Field name

Type

Required

Description

status

InstructionReportStatus

(tick)

whether Whether the command succeeded or failed

errorCode

InstructionReportErrorCode


cause Cause of failure, or null if the command succeeds

orderStatus

OrderStatus


The status of the order, if the instruction succeeded.  
If the instruction was is unsuccessful, no value is provided.  
Please note:  by default, this field is not returned for MARKET_ON_CLOSE and LIMIT_ON_CLOSE orders.

instruction

PlaceInstruction

(tick)

The instruction that was requested

betId

String


The bet ID of the new bet. Will be null on failure or if the order was placed asynchronously.

placedDate

Date


Will be null if the order was placed asynchronously

averagePriceMatched

Price


Will be null if the order was placed asynchronously. This value is not meaningful for activity on LINE markets and is not guaranteed to be returned or maintained for these for these markets. 

sizeMatched

Size


Will be null if the order was placed asynchronously


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleReplaceInstructionReport


Field name

Type

Required

Description

status

InstructionReportStatus

(tick)

whether the command succeeded or failed

errorCode

InstructionReportErrorCode


cause of failure, or null if command succeeds

cancelInstructionReport

CancelInstructionReport


Cancelation Cancellation report for the original order

placeInstructionReport

PlaceInstructionReport


Placement report for the new order


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleExBestOffersOverrides

Options to alter the default representation of best offer prices

Field name

Type

Required

Description

bestPricesDepth

int


The maximum number of prices to return on each side for each runner. If unspecified defaults to 3. Maximum The maximum returned price depth returned is 10.

rollupModel

RollupModel


The model to use when rolling up available sizes. If unspecified defaults to STAKE rollup model with rollupLimit of minimum stake in the specified currency.

rollupLimit

int


The volume limit to use when rolling up returned sizes. The exact definition of the limit depends on the rollupModel. If no limit is provided it will use minimum stake as default the value. Ignored if no rollup model is specified.

rollupLiabilityThreshold

double


Only applicable when rollupModel is MANAGED_LIABILITY. The rollup model switches from being stake-based to liability-based at the smallest lay price which is >= rollupLiabilityThreshold.service level default (TBD). Not supported as yet.

rollupLiabilityFactor

int


Only applicable when rollupModel is MANAGED_LIABILITY. (rollupLiabilityFactor * rollupLimit) is the minimum liabilty liability the user is deemed to be comfortable with. After the rollupLiabilityThreshold price subsequent volumes will be rolled up to minimum value such that the liability >= the minimum liability.service level default (5). Not supported as yet.


...