Get hoppers of users | GET /hopper

GET https://api.cryptohopper.com/v1/hopper

Returns all hoppers of the user with their subscription, status, exchange and base currency. Grid bots also include their markets, quote currency and open order count.

OAuth scope: read About scopes

last_loaded_config is a boolean that tells whether the hopper has a loaded config name, not the name itself.

Example request

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

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

import requests

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

$ch = curl_init('https://api.cryptohopper.com/v1/hopper');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    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.

Query parameters

Name	Type	Required	Description
`exchange`	string	Optional	Only return hoppers on this exchange, e.g. binance.
`enabled`	string	Optional	Only return enabled (1) or disabled (0) hoppers.
`config_error`	string	Optional	1 returns only hoppers with a config error, 0 only hoppers without one. Leave out to return all.
`name`	string	Optional	Only return hoppers whose name contains this text and matches it closely.

Response

Example response (illustrative values)

{
    "data": {
        "hoppers": [
            {
                "id": "123456",
                "open_positions_count": "3",
                "name": "My BTC bot",
                "exchange": "binance",
                "hopper_id": "123456",
                "subscription_id": "456789",
                "plan_id": "2",
                "payment_term": "month",
                "payment_method_id": "1",
                "start_time": "2026-09-01 10:00:00",
                "end_time": "2026-10-01 10:00:00",
                "subscription_status": "Active",
                "auto_renewal": "Yes",
                "subscription": "Adventure",
                "plan_name": "Adventure",
                "plan_description": "Adventure plan",
                "product_id": "None",
                "last_loaded_config": true,
                "image": "https://cdn.cryptohopper.com/images/hoppers/binance-usdt.jpg",
                "base_currency": "USDT",
                "buying_enabled": 1,
                "selling_enabled": 1,
                "enabled": 1,
                "set_default": "1",
                "error_message": null,
                "last_signal": "",
                "last_signal_encoding": "ASCII",
                "config_error": "0",
                "total_cur": "1523.45000000",
                "created": "2025-03-14 09:21:07",
                "bot_type": "0",
                "user_id": "654321",
                "allowed_coins": [
                    "BTC",
                    "ETH"
                ],
                "paper_trading": 0,
                "copy_manager": 0,
                "start_balance": "1000.00000000"
            }
        ]
    }
}

Field	Type	Description
`data`	array of object
`id`	string
`name`	string
`exchange`	string
`base_currency`	string
`buying_enabled`	integer
`selling_enabled`	integer
`enabled`	integer
`error_message`	string
`config_error`	string
`created`	string
`start_balance`	string

Status codes: 200, 401, 403, 404, 429, 500, 501. Errors return JSON with status, error and message. See How the API works for response codes and rate limits.