(NEW 1.33) Apply Security Distribution

POST {{URL_ORIGIN}}/api/operations/apply-security-distribution

Apply Security Distribution API allows you to adjust active orders and current market data fields(not historical) in case of a Corporate Actions that results security distributions (such as stock dividend).

Request Parameters

FieldTypeDescription
instrumentIdStringfied numberInstrument ID to apply the cash distribution
ratioOldStringfied DecimalratioOld of the stock dividend/forward split
Maximum 10 decimal places

If 1 new share is issued for each 2 shares held, ratioOld=2 and ratioNew=1. (European Convention)
ratioNewStringfied DecimalratioNew of the stock dividend/forward split
Maximum 10 decimal places

See description of ratioOld for more details
quantityRoundingEnumRounding method applicable to fractional quantities
Allowed values:
DOWN
UP
NONE

Response:

Same as Apply Cash Distribution

Error Codes

Same as Apply Cash Distribution with below exceptions

CodeMessage
102Apply Cash Distribution is not allowed when there is no Closing Price

Not applicable to Apply Security Distribution

Request Body

{"instrumentId"=>"77", "ratioOld"=>"2", "ratioNew"=>"1", "quantityRounding"=>"DOWN"}

HEADERS

KeyDatatypeRequiredDescription
``null

RESPONSES

status: OK

{"numberOfOrders":"11","numberOfNewOrders":"11","numberOfCancelledOrders":"11"}