Hold position | POST /hopper/{id}/position/hold/{position_id}

POST https://api.cryptohopper.com/v1/hopper/{id}/position/hold/{position_id}

Puts one open position on hold.

OAuth scope: read manage About scopes

Not available for exchange arbitrage, market maker, copy and grid bots.

Example request

curl -X POST "https://api.cryptohopper.com/v1/hopper/HOPPER_ID/position/hold/POSITION_ID" \
  -H "access-token: YOUR_ACCESS_TOKEN"

const response = await fetch('https://api.cryptohopper.com/v1/hopper/HOPPER_ID/position/hold/POSITION_ID', {
  method: 'POST',
  headers: {
      "access-token": "YOUR_ACCESS_TOKEN"
  }
});
const data = await response.json();

import requests

response = requests.post(
    "https://api.cryptohopper.com/v1/hopper/HOPPER_ID/position/hold/POSITION_ID",
    headers={
        "access-token": "YOUR_ACCESS_TOKEN"
    },
)
data = response.json()

$ch = curl_init('https://api.cryptohopper.com/v1/hopper/HOPPER_ID/position/hold/POSITION_ID');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'access-token: YOUR_ACCESS_TOKEN',
    ],
]);
$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
`position_id`	string	Required	Open position ID.
`id`	string	Required	Hopper ID.

Query parameters

Name	Type	Required	Description
`hold`	string	Optional	Not used: this path always sets hold.

Response

Example response (illustrative values)

{
    "data": "Hold has been set for this position."
}

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