Logo
Admin API API Documentation

(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

Field Type Description
instrumentId Stringfied number Instrument ID to apply the cash distribution
ratioOld Stringfied Decimal ratioOld 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)
ratioNew Stringfied Decimal ratioNew of the stock dividend/forward split
Maximum 10 decimal places

See description of ratioOld for more details
quantityRounding Enum Rounding 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

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

Not applicable to Apply Security Distribution

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
null




RESPONSES

status OK

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



Curl
curl -X POST 'URL_ORIGIN/api/operations/apply-security-distribution' -H ': ' -d '{"instrumentId":"77","ratioOld":"2","ratioNew":"1","quantityRounding":"DOWN"}'

ENDPOINTS