Orders

Link a standalone order into the position's OCO group

Adopts an existing standalone working order into the one-cancels-other (OCO) group of the open position on the same contract. The leg kind is derived from the order type: a limit order is adopted as an additional take-profit, a stop order as a stop-loss.

The order must be working and on the exit side of the position (e.g. a sell limit or sell stop while long). After linking, it participates in OCO: if a sibling exit fills or anything flattens the position, this order is cancelled; if a sibling exit scales the position down, this order is resized. A reduce-only guard rejects the link when the order’s size exceeds the position quantity not already covered by same-kind legs.

This enables multiple take-profits sharing one stop, or adopting a manually placed stop as the position’s protection. Direct mutation (not queued).

POST

trade

order

link-oco

Link a standalone order into the position's OCO group

curl --request POST \
  --url https://api.hyperprop.com/trade/order/link-oco \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "550e8400-e29b-41d4-a716-446655440000",
  "order_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
'

import requests

url = "https://api.hyperprop.com/trade/order/link-oco"

payload = {
    "account_id": "550e8400-e29b-41d4-a716-446655440000",
    "order_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: '550e8400-e29b-41d4-a716-446655440000',
    order_id: '7c9e6679-7425-40de-944b-e07fc1f90ae7'
  })
};

fetch('https://api.hyperprop.com/trade/order/link-oco', 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.hyperprop.com/trade/order/link-oco",
  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([
    'account_id' => '550e8400-e29b-41d4-a716-446655440000',
    'order_id' => '7c9e6679-7425-40de-944b-e07fc1f90ae7'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.hyperprop.com/trade/order/link-oco"

	payload := strings.NewReader("{\n  \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"order_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.hyperprop.com/trade/order/link-oco")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"order_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/trade/order/link-oco")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"order_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": null,
  "data": {
    "order": {
      "bracket_type": "take_profit",
      "contract": "MNQU6",
      "id": "9b5c4d3e-1f6a-4b8c-0d4e-3a7f9c1e5d82",
      "limit_price": 29562.25,
      "oco_group_id": "5c6d7e8f-2a3b-4c5d-6e7f-8a9b0c1d2e3f",
      "order_type": "limit",
      "quantity": 2,
      "side": "sell",
      "status": "working"
    }
  },
  "error": null,
  "success": true
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "RATE_LIMITED",
  "data": null,
  "error": "Rate limit exceeded for order submissions. Max 10 requests per second per account. Retry after 0.1 seconds.",
  "rate_limit": {
    "limit": 10,
    "remaining": 0,
    "reset": 1711800125,
    "retry_after": 0.1
  },
  "success": false
}

Body

application/json

Link an existing standalone order into the OCO group of the open position on the same contract (as an additional take-profit).

account_id

string<uuid>

required

UUID of the trading account

Example:

"550e8400-e29b-41d4-a716-446655440000"

order_id

string<uuid>

required

UUID of the standalone working order to adopt into the position's OCO group

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

Response

Order linked into OCO group

Response containing the order after it was linked into the OCO group.

order

any

required

⌘I

Link a standalone order into the position's OCO group

curl --request POST \
  --url https://api.hyperprop.com/trade/order/link-oco \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "550e8400-e29b-41d4-a716-446655440000",
  "order_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
'

import requests

url = "https://api.hyperprop.com/trade/order/link-oco"

payload = {
    "account_id": "550e8400-e29b-41d4-a716-446655440000",
    "order_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: '550e8400-e29b-41d4-a716-446655440000',
    order_id: '7c9e6679-7425-40de-944b-e07fc1f90ae7'
  })
};

fetch('https://api.hyperprop.com/trade/order/link-oco', 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.hyperprop.com/trade/order/link-oco",
  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([
    'account_id' => '550e8400-e29b-41d4-a716-446655440000',
    'order_id' => '7c9e6679-7425-40de-944b-e07fc1f90ae7'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.hyperprop.com/trade/order/link-oco"

	payload := strings.NewReader("{\n  \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"order_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.hyperprop.com/trade/order/link-oco")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"order_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/trade/order/link-oco")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"order_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": null,
  "data": {
    "order": {
      "bracket_type": "take_profit",
      "contract": "MNQU6",
      "id": "9b5c4d3e-1f6a-4b8c-0d4e-3a7f9c1e5d82",
      "limit_price": 29562.25,
      "oco_group_id": "5c6d7e8f-2a3b-4c5d-6e7f-8a9b0c1d2e3f",
      "order_type": "limit",
      "quantity": 2,
      "side": "sell",
      "status": "working"
    }
  },
  "error": null,
  "success": true
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "RATE_LIMITED",
  "data": null,
  "error": "Rate limit exceeded for order submissions. Max 10 requests per second per account. Retry after 0.1 seconds.",
  "rate_limit": {
    "limit": 10,
    "remaining": 0,
    "reset": 1711800125,
    "retry_after": 0.1
  },
  "success": false
}

Platform API

Trade API

Market Data API

Link a standalone order into the position's OCO group

Body

Response