Logo
Admin API API Documentation

Operations API

Number of APIs: 11


1. Trade Entry

POST {{URL_ORIGIN}}/api/operations/enter-trade

Trade Entry API allows you to capture trade that was done out of the order book

Trade Entry- Fields

Field Type Description
instrumentId Int Instrument id for the trade
type eNum Block/ EFRP/ Other

of the trade
price Decimal Trade price
quantity Decimal Trade quantity
buy Side obj See below
sell Side obj See below
Side obj-
Field Type Description
mpId Int mpId
accountType eNum Client/House
parties []obj list of parties obj
parties obj-
Field Type Description
id string(20) The Id of the party
source Char Id source = D
role int Id role = 38

Trade Entry- Error Codes

Code Message
1 System is unavailable
100 Missing or invalid parameter: [FieldName]
100 Trade [FieldName] must be less than [maxLong/10^ fieldPrecision
100 Trade [FieldName] must be above than [minLong/10^ fieldPrecision]
101 [FieldName] not found
102 Market is closed
102 Currently not allowed
102 Trading is not allowed during auction call
102 Trading is not allowed during crossing
102 Instrument trading is not allowed
102 Price precision is[PricePrecision]
102 Quantity precision is[QuantityPrecision]
102 Minimum trade quantity is [MinQuantity]
NEW 102 MinQuantity = max( minQuantity,
minQuantityTradeEntry.amount)
102 Maximum trade quantity is [MaxQuantity]
102 Quantity increment is [quantityIncrement]
102 Instrument trading is halted
102 Price breaches [FieldName] of [FieldValue]
102 Maximum value is [maxOrderValue]
102 Price tick size is [tickSize]
102 Trading is not allowed
102 Missing position account
10001 Permission denied


2. Trade Cancellation

POST {{URL_ORIGIN}}/api/operations/cancel-trade

Trade Cancellation API allows you to cancel a trade

Trade Cancellation- Fields

Field Type Description
instrumentId int String Instrument ID to cancel the orders
matchId int String Trade Id to cancel

Trade Cancellation- Error Codes

Code Message
1 System is unavailable
100 Missing or invalid parameter: [FieldName]
101 [FieldName] not found
102 Market is closed
102 Currently not allowed
102 Instrument trading is not allowed
105 Cancelation failed, trade is already canceled or from previous days or is leg trade
10001 Permission denied


3. NEW 1.28 Replace Order

POST {{URL_ORIGIN}}/api/operations/replace-order

Replace Order API allows you to replace an order for mp.

For more details about replace order - see here

Replace order- Fields

Field Type Description
instrumentId Int String Original order instrument Id
orderId Int String Exchange order ID to be replaced
quantity Decimal String Similar to the trading API
price optional Decimal String Similar to the trading API
timeInForce optional Enum Simialar to the trading API
expiryDate optional UTC Time Similar to the trading API
expiryDay optional String Similar to the trading API
minQuantity optional Decimal String Similar to the trading API
stopPrice optional Decimal String Similar to the trading API
stpAction optional Enum Similar to the trading API
parties optional [] Object Simialar to the trading API

Relace Order - Error Codes

  1. Validations: same as replaceOrder, with the below changes:

    1. Skip validations 1007 & 1008 &1011 (Authentication related)

  2. Additional validations:

Code Message
10001 Permission denied


4. Cancel Order

POST {{URL_ORIGIN}}/api/operations/cancel-order

Cancel Order API allows you to cancel order

Cancel order - Fields

Field Type Description
instrumentId Int Instrument id for the trade
orderId Int the Id of the order we want to cancel
(NEW 1.32.0)
cancelReason		 Enum Optional
Cancellation reason. (populated in the cancellation events)

Allowed values:
CancelOrderOnBehalf(default if nothing is sent)
CancelRequest
CorporateAction

Cancel Order - Error Codes

Code Message
1 System is unavailable
100 Missing or invalid parameter: [FieldName]
101 [FieldName] not found
102 Trading is not allowed during crossing
102 Instrument trading is not allowed
102 Market is closed
102 Instrument trading is halt
101 Not allowed
10001 Permission denied


5. Mass Cancel

POST {{URL_ORIGIN}}/api/operations/mass-cancel

Mass Cancel API allows you to mass cancel pending activity per request critirias:

Request Parameters

Field Type Description
instrumentId Stringfied number Instrument ID to mass cancel the orders
Removed v1.30.0
comment		 String Free text comment
mpId Stringfied number Optional
MP ID to mass cancel the target entities
Not sending this parameter will mass cancel for all MPs
targetParties []TargetParty objects Optional

targetParties to target the mass cancel orders.
If multiple targetParty objects are in a request, the system cancels orders with all targetParties.
For example:
Order1 has party1
Order2 has party1 and party2
Order3 has party1, party2 and party3
Order4 has no parties
A mass cancel request with targetParties(party1 and party2) will cancel order 2 and 3.

Note: For accounts: id=accountId, source=D, role=1001.
(NEW 1.30.0) targetEntities [] Enum Optional

The system cancels the type of active entities mentioned in the request.

Array of below values:
Order - cancels all orders
RFQ - cancels all RFQs and all active quotes belong to them
Quote - cancels all Quotes
(NEW v1.31.0) AllegedTrade - cancels all Alleged Trades

If not exist, system considers as targetEntities = [‘Order’]
(NEW 1.31.0) targetScope Enum The field specifies the scope the mass cancel request applies to

Allowed values:
Instrument - cancel scope is a single instrument
All - cancel scope is all instruments

If not sent “Instrument” is considered.
(NEW 1.32.0)
cancelReason		 Enum Optional
Cancellation reason. (populated in the cancellation events)

Allowed values:
MassCancelOnBehalf (default if nothing is sent)
MassCancelRequest
CorporateAction
NEW TargetParty specification:
Field Type Description
id string TargetParty id
source char TargetParty source
role int TargetParty role

Mass Cancel- Error Codes

Code Message
2001 Wrong action
2001 Wrong instrumentIds
2401 Wrong instrumentId: [instrumentId]
403 Permission denied


6. Set Settlement Price

POST {{URL_ORIGIN}}/api/operations/settlement-price

Set Settlement Price API allows you to set settlement price for an instrument

Set Settlement Prices - Request Fields

Field Type Description
instrumentId string Instrument ID to set a Settlement Price
price string the price to set

Set Settlement Prices - Error Codes

Code Message
1 Exchange is unavailable
100 Missing or invalid parameter: [FieldName]
101 instrumentId not found
102 Currently not allowed
10001 Permission denied


7. Trading Halt

POST {{URL_ORIGIN}}/api/operations/halt

Trading Halt API allows you to halt the trading for a:

  • List of instrument
  • All instruments
  • NEW v1.30.0 Multiple filtered instruments, see here for more details
Field Type Description
instrumentIds [] Stringfied numbers Optional
List of instruments to halt
Note: not sending this parameter will halt the trading for all instruments

Trading Halt - Error Codes

Code Message
2001 Wrong action
2001 Wrong instrumentIds
2401 Wrong instrumentId: [instrumentId]
403 Permission denied
NEW v1.31.0
201		 You can send up to 750 instruments per request


8. Trading Resume

POST {{URL_ORIGIN}}/api/operations/resume

Trading Resume API allows you to resume the trading for a:

  • List of instrument
  • All instruments
  • NEW v1.30.0 Multiple filtered instruments, see here for more details
Type Description
instrumentIds [] Stringfied numbers Optional
List of instruments to resume
Note: not sending this parameter will resume the trading for all instruments

Trading Resume - Error Codes

Code Message
2001 Wrong action
2001 Wrong instrumentIds
2401 Wrong instrumentId: [instrumentId]
403 Permission denied
NEW v1.31.0201 You can send up to 750 instruments per request


9. (NEW 1.33) Apply Cash Distribution

POST {{URL_ORIGIN}}/api/operations/corporate-actions/apply-cash-distribution

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

Request Parameters:

Field Type Description
instrumentId Stringfied number Instrument ID to apply the cash distribution
amount Stringfied Decimal Cash Amount per share

Maximum 10 decimal places

Response:

Field Description
numberOfOrders The total number of active/suspended orders for the instrument before applying the corporate action
numberOfNewOrders The number of new orders generated for the corporate action
numberOfCancelledOrders The number of cancelled orders for the corporate action

Error Codes

Code Message
1 System is unavailable
10001 Permission denied
100 Missing or invalid parameter: [FieldName]
100 [FieldName] must be ≤ [maxLong/10^ fieldPrecision]
100 [FieldName] must be ≥ [minLong/10^ fieldPrecision]
102 Instrument trading is not allowed
102 Trading is not allowed during auction call
102 Trading is not allowed during crossing
102 Instrument should be halted when market is open
102 Apply Cash Distribution is not allowed when there is no Closing Price


10. (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


11. NEW 1.28 Place Order

POST {{URL_ORIGIN}}/api/operations/place-order

Place Order API allows you to place an order for mp

For more details about place order - see here

Place order- Fields

Field Type Description
instrumentId Int String Instrument id for the order
mpId Int String mpId
mpOrderId Long Simialar to the trading API
orderType Enum Simialar to the trading API
side Enum Simialar to the trading API
quantity Decimal String Simialar to the trading API
price optional Decimal String Simialar to the trading API
timeInForce optional Enum Simialar to the trading API
expiryDate optional UTC Time Simialar to the trading API
expiryDay optional String Simialar to the trading API
minQuantity optional Decimal String Simialar to the trading API
stopPrice optional Decimal String Simialar to the trading API
stpAction optional Enum Simialar to the trading API
accountType optional Enum Simialar to the trading API
parties optional [] Object Simialar to the trading API

Place Order - Error Codes

  1. Validations: same as place order, with the below changes:

    1. Skip validations 1007 & 1008 &1011 (Authentication related)

  2. Additional validation:

Code Message
100 Missing or invalid parameter: [FieldName]
10001 Permission denied


  • FAQs

  • More

    Developer Website

    Claim this page

    Report this page

ENDPOINTS