Create Order Batch
curl --request POST \
--url https://api.rivermarkets.com/v1/orders/batch \
--header 'Content-Type: application/json' \
--header 'X-River-Key-Id: <api-key>' \
--header 'X-River-Signature: <api-key>' \
--header 'X-River-Timestamp: <api-key>' \
--data '
{
"orders": [
{
"qty": 123,
"buy_flag": true,
"subaccount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 0.5,
"post_only": false,
"cancel_order_on_pause": true,
"river_id": 123,
"generic_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiry_ts_utc": "2023-11-07T05:31:56Z",
"conditional_orders_params": [
{
"trigger_order": {
"qty": 123,
"buy_flag": true,
"price": 0.5,
"stop_order_price": 0.5
},
"stop_order_price": 0.5,
"parent_river_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_complex_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"exchanges": [
"<string>"
]
}
]
}
'import requests
url = "https://api.rivermarkets.com/v1/orders/batch"
payload = { "orders": [
{
"qty": 123,
"buy_flag": True,
"subaccount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 0.5,
"post_only": False,
"cancel_order_on_pause": True,
"river_id": 123,
"generic_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiry_ts_utc": "2023-11-07T05:31:56Z",
"conditional_orders_params": [
{
"trigger_order": {
"qty": 123,
"buy_flag": True,
"price": 0.5,
"stop_order_price": 0.5
},
"stop_order_price": 0.5,
"parent_river_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_complex_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"exchanges": ["<string>"]
}
] }
headers = {
"X-River-Key-Id": "<api-key>",
"X-River-Timestamp": "<api-key>",
"X-River-Signature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-River-Key-Id': '<api-key>',
'X-River-Timestamp': '<api-key>',
'X-River-Signature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
orders: [
{
qty: 123,
buy_flag: true,
subaccount_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
price: 0.5,
post_only: false,
cancel_order_on_pause: true,
river_id: 123,
generic_asset_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
expiry_ts_utc: '2023-11-07T05:31:56Z',
conditional_orders_params: [
{
trigger_order: {qty: 123, buy_flag: true, price: 0.5, stop_order_price: 0.5},
stop_order_price: 0.5,
parent_river_order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
parent_complex_order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
exchanges: ['<string>']
}
]
})
};
fetch('https://api.rivermarkets.com/v1/orders/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rivermarkets.com/v1/orders/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orders' => [
[
'qty' => 123,
'buy_flag' => true,
'subaccount_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'price' => 0.5,
'post_only' => false,
'cancel_order_on_pause' => true,
'river_id' => 123,
'generic_asset_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'expiry_ts_utc' => '2023-11-07T05:31:56Z',
'conditional_orders_params' => [
[
'trigger_order' => [
'qty' => 123,
'buy_flag' => true,
'price' => 0.5,
'stop_order_price' => 0.5
],
'stop_order_price' => 0.5,
'parent_river_order_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'parent_complex_order_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'exchanges' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-River-Key-Id: <api-key>",
"X-River-Signature: <api-key>",
"X-River-Timestamp: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.rivermarkets.com/v1/orders/batch"
payload := strings.NewReader("{\n \"orders\": [\n {\n \"qty\": 123,\n \"buy_flag\": true,\n \"subaccount_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"price\": 0.5,\n \"post_only\": false,\n \"cancel_order_on_pause\": true,\n \"river_id\": 123,\n \"generic_asset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expiry_ts_utc\": \"2023-11-07T05:31:56Z\",\n \"conditional_orders_params\": [\n {\n \"trigger_order\": {\n \"qty\": 123,\n \"buy_flag\": true,\n \"price\": 0.5,\n \"stop_order_price\": 0.5\n },\n \"stop_order_price\": 0.5,\n \"parent_river_order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parent_complex_order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"exchanges\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-River-Key-Id", "<api-key>")
req.Header.Add("X-River-Timestamp", "<api-key>")
req.Header.Add("X-River-Signature", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.rivermarkets.com/v1/orders/batch")
.header("X-River-Key-Id", "<api-key>")
.header("X-River-Timestamp", "<api-key>")
.header("X-River-Signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"orders\": [\n {\n \"qty\": 123,\n \"buy_flag\": true,\n \"subaccount_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"price\": 0.5,\n \"post_only\": false,\n \"cancel_order_on_pause\": true,\n \"river_id\": 123,\n \"generic_asset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expiry_ts_utc\": \"2023-11-07T05:31:56Z\",\n \"conditional_orders_params\": [\n {\n \"trigger_order\": {\n \"qty\": 123,\n \"buy_flag\": true,\n \"price\": 0.5,\n \"stop_order_price\": 0.5\n },\n \"stop_order_price\": 0.5,\n \"parent_river_order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parent_complex_order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"exchanges\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rivermarkets.com/v1/orders/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-River-Key-Id"] = '<api-key>'
request["X-River-Timestamp"] = '<api-key>'
request["X-River-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orders\": [\n {\n \"qty\": 123,\n \"buy_flag\": true,\n \"subaccount_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"price\": 0.5,\n \"post_only\": false,\n \"cancel_order_on_pause\": true,\n \"river_id\": 123,\n \"generic_asset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expiry_ts_utc\": \"2023-11-07T05:31:56Z\",\n \"conditional_orders_params\": [\n {\n \"trigger_order\": {\n \"qty\": 123,\n \"buy_flag\": true,\n \"price\": 0.5,\n \"stop_order_price\": 0.5\n },\n \"stop_order_price\": 0.5,\n \"parent_river_order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parent_complex_order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"exchanges\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"index": 123,
"river_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"complex_orders": {},
"error": {
"code": "<string>",
"message": "<string>"
}
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Orders
Create Order Batch
Place up to 10 orders in one request.
All orders must share one subaccount_id. Items are validated
independently: an invalid item is rejected in its per-index result while
valid items proceed, so the response is 202 Accepted even when some (or
all) items fail validation. Generic asset orders are not supported in
batches. Accepted orders are queued for execution exactly like
POST /v1/orders; track fills and rejections via GET /v1/orders/{order_id}
or the orders websocket.
POST
/
v1
/
orders
/
batch
Create Order Batch
curl --request POST \
--url https://api.rivermarkets.com/v1/orders/batch \
--header 'Content-Type: application/json' \
--header 'X-River-Key-Id: <api-key>' \
--header 'X-River-Signature: <api-key>' \
--header 'X-River-Timestamp: <api-key>' \
--data '
{
"orders": [
{
"qty": 123,
"buy_flag": true,
"subaccount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 0.5,
"post_only": false,
"cancel_order_on_pause": true,
"river_id": 123,
"generic_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiry_ts_utc": "2023-11-07T05:31:56Z",
"conditional_orders_params": [
{
"trigger_order": {
"qty": 123,
"buy_flag": true,
"price": 0.5,
"stop_order_price": 0.5
},
"stop_order_price": 0.5,
"parent_river_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_complex_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"exchanges": [
"<string>"
]
}
]
}
'import requests
url = "https://api.rivermarkets.com/v1/orders/batch"
payload = { "orders": [
{
"qty": 123,
"buy_flag": True,
"subaccount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 0.5,
"post_only": False,
"cancel_order_on_pause": True,
"river_id": 123,
"generic_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiry_ts_utc": "2023-11-07T05:31:56Z",
"conditional_orders_params": [
{
"trigger_order": {
"qty": 123,
"buy_flag": True,
"price": 0.5,
"stop_order_price": 0.5
},
"stop_order_price": 0.5,
"parent_river_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_complex_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"exchanges": ["<string>"]
}
] }
headers = {
"X-River-Key-Id": "<api-key>",
"X-River-Timestamp": "<api-key>",
"X-River-Signature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-River-Key-Id': '<api-key>',
'X-River-Timestamp': '<api-key>',
'X-River-Signature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
orders: [
{
qty: 123,
buy_flag: true,
subaccount_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
price: 0.5,
post_only: false,
cancel_order_on_pause: true,
river_id: 123,
generic_asset_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
expiry_ts_utc: '2023-11-07T05:31:56Z',
conditional_orders_params: [
{
trigger_order: {qty: 123, buy_flag: true, price: 0.5, stop_order_price: 0.5},
stop_order_price: 0.5,
parent_river_order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
parent_complex_order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
exchanges: ['<string>']
}
]
})
};
fetch('https://api.rivermarkets.com/v1/orders/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rivermarkets.com/v1/orders/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orders' => [
[
'qty' => 123,
'buy_flag' => true,
'subaccount_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'price' => 0.5,
'post_only' => false,
'cancel_order_on_pause' => true,
'river_id' => 123,
'generic_asset_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'expiry_ts_utc' => '2023-11-07T05:31:56Z',
'conditional_orders_params' => [
[
'trigger_order' => [
'qty' => 123,
'buy_flag' => true,
'price' => 0.5,
'stop_order_price' => 0.5
],
'stop_order_price' => 0.5,
'parent_river_order_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'parent_complex_order_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'exchanges' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-River-Key-Id: <api-key>",
"X-River-Signature: <api-key>",
"X-River-Timestamp: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.rivermarkets.com/v1/orders/batch"
payload := strings.NewReader("{\n \"orders\": [\n {\n \"qty\": 123,\n \"buy_flag\": true,\n \"subaccount_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"price\": 0.5,\n \"post_only\": false,\n \"cancel_order_on_pause\": true,\n \"river_id\": 123,\n \"generic_asset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expiry_ts_utc\": \"2023-11-07T05:31:56Z\",\n \"conditional_orders_params\": [\n {\n \"trigger_order\": {\n \"qty\": 123,\n \"buy_flag\": true,\n \"price\": 0.5,\n \"stop_order_price\": 0.5\n },\n \"stop_order_price\": 0.5,\n \"parent_river_order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parent_complex_order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"exchanges\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-River-Key-Id", "<api-key>")
req.Header.Add("X-River-Timestamp", "<api-key>")
req.Header.Add("X-River-Signature", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.rivermarkets.com/v1/orders/batch")
.header("X-River-Key-Id", "<api-key>")
.header("X-River-Timestamp", "<api-key>")
.header("X-River-Signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"orders\": [\n {\n \"qty\": 123,\n \"buy_flag\": true,\n \"subaccount_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"price\": 0.5,\n \"post_only\": false,\n \"cancel_order_on_pause\": true,\n \"river_id\": 123,\n \"generic_asset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expiry_ts_utc\": \"2023-11-07T05:31:56Z\",\n \"conditional_orders_params\": [\n {\n \"trigger_order\": {\n \"qty\": 123,\n \"buy_flag\": true,\n \"price\": 0.5,\n \"stop_order_price\": 0.5\n },\n \"stop_order_price\": 0.5,\n \"parent_river_order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parent_complex_order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"exchanges\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rivermarkets.com/v1/orders/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-River-Key-Id"] = '<api-key>'
request["X-River-Timestamp"] = '<api-key>'
request["X-River-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orders\": [\n {\n \"qty\": 123,\n \"buy_flag\": true,\n \"subaccount_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"price\": 0.5,\n \"post_only\": false,\n \"cancel_order_on_pause\": true,\n \"river_id\": 123,\n \"generic_asset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expiry_ts_utc\": \"2023-11-07T05:31:56Z\",\n \"conditional_orders_params\": [\n {\n \"trigger_order\": {\n \"qty\": 123,\n \"buy_flag\": true,\n \"price\": 0.5,\n \"stop_order_price\": 0.5\n },\n \"stop_order_price\": 0.5,\n \"parent_river_order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"parent_complex_order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"exchanges\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"index": 123,
"river_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"complex_orders": {},
"error": {
"code": "<string>",
"message": "<string>"
}
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
SignedRequestKeyId & SignedRequestTimestamp & SignedRequestSignatureBearerAuth
UUID of your API key (from Settings → API Keys).
Current unix seconds. Must be within 30s of server time.
Base64 Ed25519 signature over the canonical request: METHOD\nPATH\nSORTED_QUERY\nTIMESTAMP\nSHA256(body) hex. See /api-reference/authentication for the full recipe.
Body
application/json
Schema for creating a batch of orders in one request.
Orders to place, all for the same subaccount. At most 10 per request.
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Response
Successful Response
Schema for batch order create response.
One result per requested order, in request order
Show child attributes
Show child attributes