Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

River Markets complex-orders API

Manage complex orders: conditional orders (take-profit and stop-loss), TWAP, and other advanced order types.

River Markets complex-orders API is one of 13 APIs that River Markets publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include complex-orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 5 operations across 3 paths, and defines 17 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.rivermarkets.com.

5 operations 3 paths 17 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.rivermarkets.com
Authentication
API Key, API Key, API Key, HTTP Bearer
License
Proprietary
Resource Areas
1

Authentication & Security 4

River Markets complex-orders API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-River-Key-Id (SignedRequestKeyId). An API key is passed in the header as X-River-Timestamp (SignedRequestTimestamp). An API key is passed in the header as X-River-Signature (SignedRequestSignature). It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • SignedRequestKeyId — UUID of your API key (from Settings → API Keys).
  • SignedRequestTimestamp — Current unix seconds. Must be within 30s of server time.
  • SignedRequestSignature — Base64 Ed25519 signature over the canonical request: METHOD\nPATH\nSORTEDQUERY\nTIMESTAMP\nSHA256(body) hex. See /api-reference/authentication for the full rec…
  • BearerAuth — JWT bearer token for web client authentication.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

complex-orders 5

Manage complex orders: conditional orders (take-profit and stop-loss), TWAP, and other advanced order types.

GET
/v1/complex-orders
List Complex Orders
list_complex_orders_v1_complex_orders_get 10 params → 200422
POST
/v1/complex-orders
Create Complex Order
create_complex_order_v1_complex_orders_post body → 202422
POST
/v1/complex-orders/cancel-all
Cancel All Complex Orders
cancel_all_complex_orders_v1_complex_orders_cancel_all_post body → 202422
GET
/v1/complex-orders/{complex_order_id}
Get Complex Order
get_complex_order_v1_complex_orders__complex_order_id__get 1 param → 200422
DELETE
/v1/complex-orders/{complex_order_id}
Cancel Complex Order
cancel_complex_order_v1_complex_orders__complex_order_id__delete 1 param → 202422

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ComplexOrderResponse (13 properties), IcebergOrderResponse (11 properties), PegOrderResponse (11 properties), ConditionalOrderResponse (11 properties). Each schema is shown below with its type and property counts.

PegOrderParams
object
Parameters for creating a peg complex order. A peg's child limit order rests on the venue at the current best bid (for buys) or best ask (for sells), clamped t…
8 properties 2 required
SmartTakerOrderParams
object
Parameters for creating a smart-taker complex order. A smart-taker rests nothing on the book. It watches the opposite side and fires an IOC sweep (at limitpric…
5 properties 4 required
ComplexOrderResponse
object
Schema for a complex order response (unified across all complex order types).
13 properties 6 required
ConditionalOrderResponse
object
Response for a conditional order. Contains both the condition definition and the trigger order that gets placed when the condition is met. For TP/SL: the paren…
11 properties
IcebergOrderResponse
object
Iceberg-specific runtime detail returned alongside a ComplexOrderResponse. Sourced from viewicebergorders so it includes derived fields (executedqty, remaining…
11 properties
CancelComplexOrderResponse
object
Schema for cancel order response What is returned when user cancels an order/ orders.
2 properties 2 required
SmartTakerOrderResponse
object
Smart-taker-specific runtime detail returned alongside a ComplexOrderResponse. Sourced from viewsmarttakerorders so it includes derived fields (executedqty, re…
8 properties
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
ComplexOrderCreateRequest
object
Request body for creating a complex order. Provide exactly one of conditionalorderparams (TP/SL/STOP) or icebergorderparams (iceberg). The active param block d…
7 properties 1 required
TriggerOrder
object
The order that will be sent to the exchange when the conditional order's condition is met. For TP/SL: the parent order fills → the conditional activates → this…
5 properties 3 required
ComplexOrderCreateResponse
object
Schema for a complex order response (unified across all complex order types).
1 property 1 required
IcebergOrderParams
object
Parameters for creating an iceberg complex order. An iceberg's totalqty is split into sequential displayedqty tranches posted at the same limitprice. When a tr…
8 properties 4 required
ComplexOrderListResponse
object
Schema for list of complex orders (all types).
2 properties 2 required
PegOrderResponse
object
Peg-specific runtime detail returned alongside a ComplexOrderResponse. Sourced from viewpegorders so it includes derived fields (executedqty, remainingqty).
11 properties
ConditionalOrderCreate
object
Schema for a conditional order (take profit or stop loss) attached to a parent order.
5 properties 2 required
CancelAllComplexOrdersRequest
object
Request body for cancelling all complex orders for a subaccount.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

river-markets-complex-orders-api-openapi.yml Raw ↑

Other APIs River Markets publishes across the network.

River Markets balance API
River Markets fair-values API
River Markets fills API
River Markets generic-assets API
River Markets markets API
River Markets orderbooks API
River Markets orders API
River Markets positions API
River Markets prices API
River Markets subaccounts API
River Markets tradeprints API
River Markets watchlists API