Logo
Admin API API Documentation

Maker Checker

Number of APIs: 17


1. Update Calendar

PUT {{URL_ORIGIN}}/api/v2/calendars/10


2. NEW Cancel Order

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

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


3. Update CBR

PUT {{URL_ORIGIN}}/api/cbrs/31

This API allows to update existing CBR.

Update CBR - Error Codes

All validations in create CBR

Code Message
101 [FieldName] not found
10001 Permission denied


4. (NEW v1.33.0) Update Account

PUT {{URL_ORIGIN}}/api/accounts/:id

This API allows to create a new MP.

ID will be returned in the response, this ID is the unique identifier of the MP and should be used when sending update commands.

Note: this ID can be retrieved via Get MPs API.

Create MP- Error Codes

Code Message
1 System is unavailable
100 Missing or invalid parameter: [FieldName]
102 [FieldName] already exists
10001 Permission denied


5. Trading Resume

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

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

  • List of instrument
  • All instruments
Field 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


6. Update Instrument

PUT {{URL_ORIGIN}}/api/v2/instruments/24220


7. NEW v1.30.0 Archive Instrument

POST {{URL_ORIGIN}}/api/v2/instruments/:id/archive

This API allows to archive existing instrument which TBD...

Archive Instrument- Error Codes

Code Message
1 Exchange is unavailable
100 Missing or invalid parameter: [FieldName]
101 [FieldName] not found
102 Disable the instrument before attempting to archive it
106 Archiving strategy [parentSymbol] is required
10001 Permission denied


8. (NEW v1.33.0) Create Account

POST {{URL_ORIGIN}}/api/accounts

This API allows to create a new MP.

ID will be returned in the response, this ID is the unique identifier of the MP and should be used when sending update commands.

Note: this ID can be retrieved via Get MPs API.

Create MP- Error Codes

Code Message
1 System is unavailable
100 Missing or invalid parameter: [FieldName]
102 [FieldName] already exists
10001 Permission denied


9. Update MP Group

PUT {{URL_ORIGIN}}/api/mp-groups/1794788082

Update MP Group- Error Codes

All validations in create instrument and the below 

Code Message
101 [FieldName] not found


10. Update TickSize

PUT {{URL_ORIGIN}}/api/tick-sizes/19

This API allows to update existing TickSize.

Update TickSize - Error Codes

All validations in create TickSize and the below

Code Message
101 [FieldName] not found
10001 Permission denied
10004 Wrong format
2605 [FieldName] must be less than maxLong/10^ pricePrecision for [Instrument]
2603 [fieldValue] is not allowed as price precision is [lowestinstrumentPricePrecision] for [Instrument]


11. Mass cancel

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

Mass Cancel API allows you to mass cancel orders for :

  • Specific MP
  • All MPs

  • NEW Specific targetParty or multiple targetParties

    • 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.

Request Parameters

Field Type Description
instrumentId Stringfied number Instrument ID to mass cancel the orders
comment String Free text comment
mpId Stringfied number Optional
MP ID to mass cancel the orders
Note: not sending this parameter will mass cancel the orders for all MPs
NEW targetParties []TargetParty objects Optional

targetParties to target the mass cancel orders.

Note: For accounts: id=accountId, source=D, role=1001.
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


12. 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 Instrument ID to cancel the orders
matchId int 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


13. Trading Halt

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

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

  • List of instrument
  • All instruments
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


14. End Of Day

POST {{URL_ORIGIN}}/api/v2/calendars/:id/end-of-day

This API allows to trigger EOD for a specific calendar

End Of Day- Error Codes

Code Message
1 System is unavailable
101 [FieldName] not found
102 EOD is not allowed
10001 Permission denied


15. Update MP

PUT {{URL_ORIGIN}}/api/mps/15


16. 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


17. 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


  • FAQs

  • More

    Developer Website

    Claim this page

    Report this page

ENDPOINTS