Exberry Admin API
Number of APIs: 68
Exberry admin API allows to manage the exchange static data (instruments, trading calendars and more) as well as sending operational commands (EOD, halt trading and more). Sandbox environment endpoint ( Guidelines: All numbers are stringified unless explicitly mentioned otherwise Optional fields should be omitted from request if not required System ignores any additional parameter that are sent on request body but was not specified in this document Error response contains the below fields: Error response sample: In case of wrong path, generic error will be returned: By default the Admin API apply the commands based on the user default setup. * GET requests: included in the query string (?exchangeId=XYZ) Added Added Added new APIs to adjust active orders and current market data fields(not historical) in case of Corporate Actions Support filter for Adding new TIF to auction - IOC Adding new validation to Changed the derivativeInstrumentCategory filter to filter only instruments that are active and that has an underling instrument and is in this category, in: Added Suffix & Prefix for Symbol & Description filters Added Instruments API: Adding new filter and new values to filters in get instruments, halt and resume tradingHalt and tradingResume Mass cancelation: Adding new generic validation - 1 - Maximum request size is 60kb Added cancellation of active Quotes and active Alleged Trades to the Cancel on Disconnect. Added cancellation of active RFQs, Quotes and Alleged Trades when MP is blocked. Adding Adding optional fields to Adding more optional fields to Adding possibility for user to override the maker chaekcer flow - by super user with new permission Adding new API to Archive Instrument Adding new validations to instrument update : Removed the comment field in the mass cancel. Adding new Equilibrium Price matching algortihm for auctions Adding the ability to configure Remove Added Added new API- Added new API - Remove from the response Adding to the response Changed the error message returned when configured mandatory parties are not in the Trade Entry Adding new value to the maker checker The Adding more requestTypes to the Maker Checker Added support for removing Added a validation to prevent the creation of strategies with strategy leg instruments. Adding new API to the Operations API Adding new field to thew CBR Changed Update Instrument to allow changing the Adding the Maker Checker section Changed Added Bugfix to correct the error returned when updating quantity/price precision of a parent strategy instrument. Error before the fix: Change the Underlying Instrument of O(Option), F(Futures) and K(Strategies) instruments to Optional. Adding new optional fields to the MP APIs to support Self-Trade Prevention. Adding sorting to Auction objects in calendar objects Adding a new validation to PricePrecision and QuantityPrecision of strategy instruments(to validate that the same precision exists between parent and leg instruments). Adding new list to the instrument API- minQuantityTradeEntries Adding new General
URL_ORIGIN): https://admin-api.uat.exberry-uat.io
NEW Note: There is an option to enable the maker checker flow for some of the Admin actions. More information can be seen in the relevant section.
Error Handling
Name
Description
code
Error code
message
Error message
path
optionalpath for the specific field generate the error
requiredPermission
optionalName of missing permission for that action
instrumentId
optionalInstrumentId cause the error, relevant for action that affect multiple instruments such as Update Calendar
{
"code": 10004,
"message": "Wrong format",
"data": {
"path": [
"id"
]
}
}
{
"message": "Route not found",
"code": 1
}
Generic Error Codes
Code
Message
1
Timeout expired/ Exchange is unavailable/ Invalid JSON/ Route not found
NEW v1.31.0 1Maximum request size is 60kb
10000
Invalid token
10100
Permission denied for exchange [ExchangeID]
Multiple Exchanges
In case that single user needs to use the API for multiple exchange, exchangeId (approved for this user) can be provided as an optional property in a request as follow:
* POST & PUT request: included in request body ({ ..., exchangeId: XYZ})
API Changes
v1.33.0(2024-08-21)
Accounts API
folder under MP API
requestTypeaccountId to Create API Key
/api/operations/corporate-actions/apply-cash-distribution/api/operations/corporate-actions/apply-security-distributiontrading halt and trading resume in the maker checkercreate calendarv1.32.0(2024-08-07)
cancelReason to the
v1.31.0(2024-07-16)
quantityPrecision & pricePrecision when active Alleged Trades exist.
AllegedTrade to the targetEntitiestargetScope to support cancellation across all instruments.v1.30.0(2024-06-19)
targetEntities to Mass cancelget instruments request to allow filteringTrading Halt and Trading Resume requests
quantityPrecision & pricePrecision is not allowed when there are active/suspended orders or active RFQs/Quotesv1.29.0(2024-04-23)
auctions.extensionsv1.28.0(2024-04-16)
marketStatus and tradingStatus from the response of instrument APIlegPriceBands to the instrumentplace orderreplace orderv1.27.0(2024-04-01)
latestTimestamp of makerchecker requestmakerUserType of makerchecker requesttradingModels field will always be included in the response of Create Update and Get InstrumentrequestType - CancelOrdercomment in cancel order is now optionalv1.26.0(2024-02-28)
tradingModels from instruments.Cancel Orderroundingv1.25.0 (2024-02-07)
stopDate after the startDatev1.24.0 (2024-01-17)
compId(String) of MP to compIds(String[])deliveryStartDate and deliveryEndDate to the Instrumentv1.23.0 (2023-12-26)
Legs [price | quantity] precision must be equal to strategy price precision, error after the fix: [FieldName] can't be changed for strategy related instrumentv1.21.0 (2023-11-20)
2023-10-03
2023-09-19
ENDPOINTS