List Orders

Returns a list of orders that you’ve previously created. The orders are returned sorted by the time in which they were created, with the most recently created orders appearing first.

Filters and pagination are supported.

GET /v1/orders

List Orders

cURL

curl --request GET \
  --url https://sandbox.api.rime.finance/v1/orders \
  --header 'Authorization: Bearer <token>'

200

orders_list

{ "data": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "side": "BUY", "market": "PRIMARY", "status": "COMPLETED", "amount_of_units": 105000, "value": 100000, "currency": "EUR", "isin": "NL1111111111", "account_id": "123e4567-e89b-12d3-a456-426614174000", "created": "2024-01-15T10:30:00Z", "settlement_transaction_hash": "0x5e6f7890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234", "payment_transaction_reference": "PMT-2024-001", "custom_offering_id": null }, { "id": "660e8400-e29b-41d4-a716-446655440001", "side": "SELL", "market": "SECONDARY", "status": "AWAITING_PAYMENT", "amount_of_units": 50000, "value": 50000, "currency": "EUR", "isin": "NL1111111111", "account_id": "123e4567-e89b-12d3-a456-426614174000", "created": "2024-01-15T11:15:00Z", "settlement_transaction_hash": null, "payment_transaction_reference": null, "custom_offering_id": null } ] }

Authorizations

Authorization · string · header · required

Bearer access token. Provide as a Authorization: Bearer <token> header.

Query Parameters

side · enum<string> | null

Filter to only include orders for a specific side.

Whether the order is a buy or a sell order.

Available options: BUY, SELL

market · enum<string> | null

Filter to only include orders for a specific market.

The market the order is executed on.

On the primary market, buy orders can be executed when the fund's subcribable flag is set to true. Sell orders on the primary market are only excepted when the fund's redeemable flag is set to true.

On the secondary market, both buy and sell orders can be executed when the fund's tradeable flag is set to true.

Available options: PRIMARY, SECONDARY

order_status · enum<string> | null

Filter for orders in a specific lifecycle status.

Status the order is currently in. This status is updated by the system depending on the order's lifecycle state.

Buy order flow: PLACED → AWAITING_PAYMENT → PAYMENT_RECEIVED → EXECUTED → DELIVERY_INITIATED → DELIVERY_COMPLETED → COMPLETED

Sell order flow: PLACED → REDEMPTION_GATED (if locked) → EXECUTED → PAYMENT_SENT → PAYMENT_COMPLETED → COMPLETED

Orders can be CANCELLED from non-terminal states.

Available options: PLACED, AWAITING_PAYMENT, PAYMENT_RECEIVED, DELIVERY_INITIATED, DELIVERY_COMPLETED, PAYMENT_SENT, PAYMENT_COMPLETED, REDEMPTION_GATED, EXECUTED, COMPLETED, CANCELLED

account_type · enum<string> | null

Filter to only include individual and/or business accounts. Accounts can either be for a natural person (individual) for a registered business. The type of account has an influence on the parameters required for account creation.

Available options: individual, business

account_id · string<uuid> | null

Filter for orders of a specific account.

currency · string | null

Filter for orders that were placed in a specific currency.

isin · string | null

Filter to only include orders of a specific ISIN.

skip · integer · default: 0

Required range: x >= 0

limit · integer · default: 100

Required range: 1 <= x <= 1000

Response

200 - application/json

List of orders retrieved successfully

data · OrderListItem · object[] · required

Show child attributes