API status

Placing a unit sell order

To place a unit sell order send

POST orders

Example request

{
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "currency": "EUR",
  "side": "SELL",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "order_type": "MARKET",
  "quantity": "10",
  "user_instrument_fit_acknowledgement": true,
  "limit_price": "",
  "stop_price": ""
}

Unlike the nominal buy order explained above, you must now specify the share quantity (and omitting the cash amount) as well as the SELL side.

After a successful order request, the sample response for the above will look as follows:

Example response

{
  "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "cash_amount": "0",
  "currency": "EUR",
  "side": "SELL",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "order_type": "MARKET",
  "quantity": "10",
  "user_instrument_fit_acknowledgement": true,
  "limit_price": "",
  "stop_price": "",
  "status": "NEW",
  "fee": "0.0",
  "executions": [],
  "client_reference": "",
  "initiation_flow": "API"
}

Analogous to the nominal buy order, you will receive an order PROCESSING webhook, followed by an order execution FILLED webhook for each execution, and an order FILLED webhook once the order is completely filled, including the amount of fees charged (if applicable), and the taxes incurred:

{
  "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "cash_amount": "0",
  "currency": "EUR",
  "side": "SELL",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "order_type": "MARKET",
  "quantity": "10",
  "user_instrument_fit_acknowledgement": true,
  "limit_price": "",
  "stop_price": "",
  "status": "FILLED",
  "fee": "0.0",
  "executions": [
    {
      "id": "b9dc0676-8a7d-412d-802a-3b325eefd15e",
      "side": "SELL",
      "currency": "EUR",
      "status": "FILLED",
      "order_id":  "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
      "cash_amount":"852.20",
      "share_quantity":"10",
      "price":"85.22",
      "transaction_time":"2021-07-21T14:10:00.020Z",
      "taxes": [
        {
          "type": "TOTAL", 
          "amount": "23.45"
        }
      ],
      "venue_id": "20d6024b-2df4-41ae-8d42-62e4744e455b"
    }
  ],
  "client_reference": "",
  "initiation_flow": "API"
}

The cash amount is the total amount the user realised from the sell order, including all taxes incurred.

Similar to the nominal buy order, you will also receive a positions and cash balance updates respectively, which you can also find in the API References for cash balance events and positions events.


Next steps

Previous