GET https://api.cryptohopper.com/v1/hopper/{id}/config

Returns the config of the hopper with every value as a string and API keys masked as ***.

OAuth scope: read About scopes

fast_api_connected is "1" when the hopper is connected with Fast API.

Example request

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

Parameters

Headers

NameTypeRequiredDescription
access-token string Required The OAuth access token of the user.

Path parameters

NameTypeRequiredDescription
id string Required Hopper ID.

Query parameters

NameTypeRequiredDescription
layout string Optional full returns every documented config field, filling missing ones with an empty string or 0. Any other value, or leaving it out, returns only fields that have a non-empty value.

Response

Example response (illustrative values)

{
    "data": {
        "name": "My BTC bot",
        "exchange": "binance",
        "collect_currency": "usdt",
        "api_key": "***",
        "api_secret": "***",
        "allowed_coins": [
            "BTC",
            "ETH"
        ],
        "max_open_positions": "10",
        "stop_loss": "1",
        "stop_loss_percentage": "5",
        "fast_api_connected": "0"
    }
}

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