Update short position | POST /hopper/{id}/short/{short_id}/update

POST https://api.cryptohopper.com/v1/hopper/{id}/short/{short_id}/update

Updates the take profit, stop-loss and trailing stop-loss settings of a short position.

OAuth scope: read manage About scopes

take_profit is applied when above 0. The stop-loss fields are applied only when stop_loss_percentage is above 0: stop_loss 1 turns stop-loss on, 0 or missing turns it off. The trailing fields are applied only when trailing_stop_loss_percentage is above 0, with trailing_stop_loss 1 or 0 in the same way. If the body contains short_ids, those shorts are updated instead of the path short. auto_close, auto_close_time, auto_remove and auto_remove_time are read but not applied as auto close or auto remove settings: use Change settings of short positions for those. Not available for exchange arbitrage, market maker, copy, grid and AI bots.

Example request

curl -X POST "https://api.cryptohopper.com/v1/hopper/HOPPER_ID/short/SHORT_ID/update" \
  -H "access-token: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"take_profit":2.5,"stop_loss":1,"stop_loss_percentage":3,"trailing_stop_loss":1,"trailing_stop_loss_percentage":1,"trailing_stop_loss_arm":1.5}'

const response = await fetch('https://api.cryptohopper.com/v1/hopper/HOPPER_ID/short/SHORT_ID/update', {
  method: 'POST',
  headers: {
      "access-token": "YOUR_ACCESS_TOKEN",
      "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "take_profit": 2.5,
      "stop_loss": 1,
      "stop_loss_percentage": 3,
      "trailing_stop_loss": 1,
      "trailing_stop_loss_percentage": 1,
      "trailing_stop_loss_arm": 1.5
  })
});
const data = await response.json();

import requests

response = requests.post(
    "https://api.cryptohopper.com/v1/hopper/HOPPER_ID/short/SHORT_ID/update",
    headers={
        "access-token": "YOUR_ACCESS_TOKEN"
    },
    json={
        "take_profit": 2.5,
        "stop_loss": 1,
        "stop_loss_percentage": 3,
        "trailing_stop_loss": 1,
        "trailing_stop_loss_percentage": 1,
        "trailing_stop_loss_arm": 1.5
    },
)
data = response.json()

$ch = curl_init('https://api.cryptohopper.com/v1/hopper/HOPPER_ID/short/SHORT_ID/update');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'access-token: YOUR_ACCESS_TOKEN',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'take_profit' => 2.5,
        'stop_loss' => 1,
        'stop_loss_percentage' => 3,
        'trailing_stop_loss' => 1,
        'trailing_stop_loss_percentage' => 1,
        'trailing_stop_loss_arm' => 1.5,
    ]),
]);
$data = json_decode(curl_exec($ch), true);

Parameters

Headers

Name	Type	Required	Description
`access-token`	string	Required	The OAuth access token of the user.

Path parameters

Name	Type	Required	Description
`short_id`	string	Required	Short position ID.
`id`	string	Required	Hopper ID.

Request body

JSON, model ShortUpdatePost

Field	Type	Required	Description
`take_profit`	number	Optional	Minimum 0.
`stop_loss`	number	Optional	Minimum 0.
`stop_loss_percentage`	number	Optional	Minimum 0.
`stop_loss_timeout_count`	integer	Optional	Minimum 0.
`stop_loss_timeout_val`	string	Optional	One of: minutes, hours, days.
`trailing_stop_loss`	number	Optional	Minimum 0.
`trailing_stop_loss_percentage`	number	Optional	Minimum 0.
`trailing_stop_loss_arm`	number	Optional	Minimum 0.
`auto_close`	number	Optional	Minimum 0.
`auto_close_time`	number	Optional	Minimum 0.
`auto_remove`	number	Optional	Minimum 0.
`auto_remove_time`	number	Optional	Minimum 0.

Response

Example response (illustrative values)

{
    "data": "Short position(s) config settings updated."
}

Status codes: 200. Errors return JSON with status, error and message. See How the API works for response codes and rate limits.