Disable hopper | PATCH /hopper/{id}/disable

PATCH https://api.cryptohopper.com/v1/hopper/{id}/disable

Disables the hopper, so it stops running its tasks.

OAuth scope: read manage About scopes

Example request

curl -X PATCH "https://api.cryptohopper.com/v1/hopper/HOPPER_ID/disable" \
  -H "access-token: YOUR_ACCESS_TOKEN"

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

import requests

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

$ch = curl_init('https://api.cryptohopper.com/v1/hopper/HOPPER_ID/disable');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    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
`id`	string	Required	Hopper ID.

Response

Example response (illustrative values)

{
    "data": "Hopper is disabled."
}

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