Get Order

get https://sandbox.api.lemon.markets/v1/accounts/{account_id}/orders/{order_id}

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

string

required

The unique identifier for this order.

side

string

enum

required

A category to represent the side of a customer's order:

buy: Buy shares of an instrument and pay with cash.
sell: Sell shares of an instrument and receive cash.

buy sell

Allowed:

type

const

enum

required

A category describing an order type:

batch: A batch order. Batch orders are collected for all customers and executed on the market as one composite order.

Allowed:

workflow

string

A reference to the workflow that created this order. If the order has not been created using a workflow, the property will not be set.

instrument

string

required

An ISIN (International Securities Identification Number) according to ISO 6166. This value uniquely identifies the instrument to be bought/sold.

amount

string

The amount of cash for a buy order, null for a sell order.
NOTE: We may evolve the API to allow quantity-based buy orders and amount-based sell orders. We do not recommend to rely on the current behavior.

quantity

string

The quantity of shares for a sell order, null for a buy order.
NOTE: We may evolve the API to allow quantity-based buy orders and amount-based sell orders. We do not recommend to rely on the current behavior.

fee

string

required

≥ 0

The fee that will be charged by lemon.markets on your behalf.

fees

object

required

Order fee configuration. This object specifies how to calculate order fees.

pct

string

Specify a relative amount like "0.20" to charge a relative fee for this order; in this case, 0.2% of the trade's value.

base_amount

string

Specify a fixed amount like "2.00" to charge a fixed fee for this order.

currency

string

required

length between 3 and 3

An ISO 4217 three-letter currency code. Its value represents the currency for the fee, fees.base_amount and amount listed here. The only currently available currency is "EUR".

history

array of objects

History

object

status

string

enum

required

A category representing the state of an order:

accepted
canceled
canceling
confirmed
created
executed
rejected

accepted canceled canceling confirmed created executed rejected

Allowed:

timestamp

date-time

required

The timestamp of the event. It represents the point in time at which the order was updated.

actor

object

An object describing the individual performing an action.

regulatory_disclosures

object

An object describing regulatory information, such as expected prices, quantities and costs as well as links to relevant documents.

kid

uri

If present, a document that needs to be made available to the user. A copy of this document will be added to the user's /documents eventually.

estimated_amount

string

required

An indication of the amount based on the most recent market data.
NOTE: This information is indicative only and does not have to match the final execution price.

estimated_price

string

required

A price indication based on the most recent market data.
NOTE: This information is indicative only and does not have to match the final execution price.

estimated_quantity

string

required

A quantity indication based on the most recent market data.
NOTE: This information is indicative only and does not have to match the final execution quantity.

service_costs_total

string

required

Cost of investment services provided by lemon.markets; specified using the order's currency.

service_costs_total_pct

string

required

Relative value of servic_costs_total in relation to the total value of the order; specified in percentage points ("0.23" means 0.23%).

entry_costs

string

The investment service costs related to the buy order; specified using the order's currency.

entry_costs_pct

string

Relative value of entry_costs in relation to the total value of the order; specified in percentage points ("0.23" means 0.23%).

third_party_grants

string

required

Inducements paid to the broker by third parties; specified using the order's currency.

third_party_grants_pct

string

required

Relative value of third_party_grants in relation to the total value of the order; specified in percentage points ("0.23" means 0.23%).

product_costs

string

The product cost associated with owning the product; specified using the order's currency.

product_costs_pct

string

Relative value of product_costs in relation to the total value of the order; specified in percentage points ("0.23" means 0.23%).

running_costs

string

The investment service cost associated with owning the product; specified using the order's currency.

running_costs_pct

string

Relative value of running_costs in relation to the total value of the order; specified in percentage points ("0.23" means 0.23%).

exit_costs

string

required

The service costs related to a sell order; specified using the order's currency.
Note: In case of a buy order, this reflects an estimate of a corresponding sell order.

exit_costs_pct

string

required

Relative value of exit_costs in relation to the total value of the order; specified in percentage points ("0.23" means 0.23%).

acquisition_costs

string

acquisition_costs_pct

string

custody_costs

string

custody_costs_pct

string

impact_first_year

string

An indication of the costs incurred during the first year of ownership; specified using the order's currency. This includes both product and investment service costs.
Note: If the security is sold during the first year, the cost might be even higher.

impact_first_year_pct

string

Relative value of impact_first_year in relation to the total value of the order; specified in percentage points ("0.23" means 0.23%).

impact_subsequent_year

string

An indication of the costs incurred during a year of ownership without transactions; specified using the order's currency. This include both product and investment service costs.

impact_subsequent_year_pct

string

Relative value of impact_subsequent_year in relation to the total value of the order; specified in percentage points ("0.23" means 0.23%).

impact_final_year

string

An indication of the cost incurred during the last year of ownership; specified using the order's currency. This include both product and investment service cost.
Note: If the security is sold during the first year, the cost might be even higher.

impact_final_year_pct

string

Relative value of impact_final_year in relation to the total value of the order; specified in percentage points ("0.23" means 0.23%).

appropriateness_check

object

An object representing the requirements for explicit confirmation of an appropriateness warning.

required

boolean

required

Requirement indicator for the appropriateness warning.
NOTE: If this value is true, the frontend must present a warning to the user as outlined in your onboarding documentation.

sca

object

An object representing a strong customer authentication challenge.

required

boolean

required

Indication of strong customer authentication requirement. If this value is true, the next request needs to include a solution to the challege (e.g. in the sca property for batch order confirmation).

challenge

string

required

A base64-url encoded blob of data. Sign the decoded data using a registered authenticator and include the signature in the next request (e.g. in the sca property for batch order confirmation).

securities_account

string

A securities account identifier. This property indicates the securities account used for order execution and settlement.

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.api.lemon.markets/v1/accounts/account_id/orders/order_id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

400Bad Request

401Unauthorized

404Not Found

422Unprocessable Entity

5XXServer Error