euniversal / umei-api-specification

UMEI API specifications
Apache License 2.0
3 stars 0 forks source link

Order Status are not detailed enough #85

Closed narve closed 2 years ago

narve commented 2 years ago

Some market participants have reported that the current statuses allowed in UMEI are not detailed enough for their use cases.

In the NODES API, we have an additional order status field, called OrderCompletionType, which says why an order is "Completed" (no longer active): It can be Filled, Killed, Expired, or Cancelled.

Another option is to have more allowable values for the status field, e.g. adding (at least) Expired and Cancelled as possible values.

The advantage of having two fields are:

The disadvantage is of course that users need to look at two fields to find out what happened to a previously active order - was it filled, was it cancelled, or did it expire?

The advantage of having one field with several values is that it might be easier to understand for API users. However, the FMO then should document which statuses each data type can possibly be in (e.g., the status of a portfolio is either Active or Inactive, etc.

narve commented 2 years ago

In conclusion, NODES recommend that we add the OrderCompletionType enumeration and a new field CompletionType to the Order model.

It is also acceptable to add the other statuses to the UMEI Status enumeration. But we probably need to do something to address the needs of the market participants.

@cdmNSIDE @GiancarloNSIDE @vladimirvrabely what do you think?

cdmNSIDE commented 2 years ago

Hello @narve, I do not see any objection on my side, but I would prefer to wait for the feedback of @ArnaudDebray (he will be back on Tuesday)

OysteinDE commented 2 years ago

Hi @cdmNSIDE and @ArnaudDebray

Any updates on this issue? Have you had a chance to look at it?

ArnaudDebray commented 2 years ago

No objection on my side in adding a field "CompletionType" to the Orders model. I think it's the best approach

cdmNSIDE commented 2 years ago

Ok for me as well. Note that we won't use those fields for our market platform in the context of the Portuguese demo