RIrivermarkets
complex-orders

List Complex Orders

Changed on

List complex orders (conditional and iceberg) with optional filters.

Returns a dict keyed by complex order type (conditional_orders, iceberg_orders). Use complex_order_type to restrict to one type.

get/v1/complex-orders

Request

  • Base URL
    https://api.rivermarkets.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.rivermarkets.com/v1/complex-orders
  • Auth
    none declared

Query parameters

complex_order_typestring nullable

Filter by complex order type: CONDITIONAL, TWAP, ICEBERG, PEG.

statusstring[] nullable

Filter by status name. Interpreted per complex_order_type (ConditionalOrderStatus for CONDITIONAL, IcebergOrderStatus for ICEBERG, PegOrderStatus for PEG). Unknown names for the active type are ignored.

river_idinteger nullable

Filter by instrument ID

generic_asset_idstring uuid nullable

Filter by generic asset basket ID

subaccount_idstring uuid nullable

Filter to a specific subaccount

complex_order_idsstring[] nullable

Filter by complex order IDs

parent_river_order_idstring uuid nullable

Filter by parent order ID

unparented_onlyboolean

When true, only return conditional orders with no parent_river_order_id (standalone stops). Ignored for non-conditional types.

limitinteger

Results per page (max 1000)

offsetinteger

Pagination offset

Response

Successful Response

complex_ordersobject required

List of complex orders matching the query

countinteger required

Total count of matching complex orders (for pagination)

Changes

  • 7fb1b5dd2caeRevision changes
    • breaking

      the ////// response's property format changed from date-time to no format for status

    • breaking

      the ////// response's property format changed from date-time to no format for status

    • breaking

      the ////// response's property format changed from date-time to no format for status

  • f61eccb4b0ddRevision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status