# Create a new hopper

`POST https://api.cryptohopper.com/v1/hopper`

Part of [Hoppers](https://www.cryptohopper.com/api-documentation/api-reference/hoppers.md) in the Cryptohopper API reference.

Creates a new hopper with the given name, config and API keys, optionally from a template. When enabled is 1 the new hopper starts right away.

OAuth scope: `manage`

bot_type accepts 0 (trading bot), 1 (exchange arbitrage), 2 (market maker), 4 (signal bot, only when enabled for the account), 6 (portfolio bot) and 8 (grid bot, test accounts only); 11 (AI Bot) is refused and any other value creates a trading bot. template_id is a template ID, optionally prefixed with user_, market_ or basic_. Set config.load_api_from to the ID of another of your hoppers on the same exchange to copy its API keys. api_config must be a JSON object.

## Headers

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

## Request body

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | string | yes |  |
| `enabled` | integer | no |  |
| `api_config` | object | no |  |
|   `api_key` | string | no |  |
|   `api_secret` | string | no |  |
|   `api_passphrase` | string | no |  |
|   `extra_api_key` | string | no |  |
|   `extra_api_secret` | string | no |  |
|   `kraken_extra_key` | string | no |  |
|   `kraken_private_extra_key` | string | no |  |
|   `gdax_api_passphrase` | string | no |  |
|   `gdax_post_only` | string | no |  |
| `template_id` | string | no |  |
| `config` | object | no |  |
|   `exchange` | string | no |  |
|   `base_currency` | string | no |  |
|   `selected_coins` | array of string | no |  |
|   `strategy` | string | no | One of: none, multiple_ta, bbands_easy, bbands_advanced, rsi, fixed_rates. |
|   `advanced_settings` | object | no |  |
|     `candle_size` | string | no | One of: 5_min, 15_min, 30_min, 1_hour, 2_hours, 4_hours, 1_day. |
|     `stochastic` | integer | no |  |
|     `stochastic_RSI` | integer | no |  |
|     `RSI` | integer | no |  |
|     `MACD` | integer | no |  |
|     `EMA` | integer | no |  |
|     `KAMA` | integer | no |  |
|     `SMA` | integer | no |  |
|     `bollinger_bands` | integer | no |  |
|     `stoch_fast_K period` | integer | no |  |
|     `stoch_slow_K_period` | integer | no |  |
|     `stoch_slow_KMA_type` | string | no | One of: sma, ema, wma, dema, tema, trima, kama, mama, t3. |
|     `stoch_slow_D_period` | integer | no |  |
|     `stoch_slow_DMA_type` | string | no | One of: sma, ema, wma, dema, tema, trima, kama, mama, t3. |
|     `stoch_oversold_threshold` | integer | no |  |
|     `stoch_overbought_threshold` | integer | no |  |
|     `stoch_req_for_buy_signal` | integer | no |  |
|     `stoch_RSI_period` | integer | no |  |
|     `stoch_RSI_fast_K_period` | integer | no |  |
|     `stoch_RSI_fast_D_period` | integer | no |  |
|     `stoch_RSI_fast_DMA_type` | string | no | One of: sma, ema, wma, dema, tema, trima, kama, mama, t3. |
|     `stoch_RSI_oversold_threshold` | integer | no |  |
|     `stoch_RSI_overbought_threshold` | integer | no |  |
|     `stoch_RSI_req_for_buy_signal` | integer | no |  |
|     `RSI_period` | integer | no |  |
|     `RSI_oversold_threshold` | integer | no |  |
|     `RSI_overbought_threshold` | integer | no |  |
|     `RSI_needed_for_buy_signal` | integer | no |  |
|     `MACD_fast_period` | integer | no |  |
|     `MACD_slow_period` | integer | no |  |
|     `MACD_signal_period` | integer | no |  |
|     `MACD_req_for_buy_signal` | integer | no |  |
|     `EMA_short_period` | integer | no |  |
|     `EMA_long_period` | integer | no |  |
|     `EMA_req_for_buy_signal` | integer | no |  |
|     `SMA_short_period` | integer | no |  |
|     `SMA_long_period` | integer | no |  |
|     `SMA_req_for_buy_signal` | integer | no |  |
|     `KAMA_short_period` | integer | no |  |
|     `KAMA_long_period` | integer | no |  |
|     `KAMA_req_for_buy_signal` | integer | no |  |
|     `bollinger_bands_period` | number | no |  |
|     `bollinger_bands_deviation_upper_band` | number | no |  |
|     `bollinger_bands_deviation_lower_band` | number | no |  |
|     `bollinger_bands_MA_type` | string | no | One of: sma, ema, wma, dema, tema, trima, kama, mama, t3. |
|     `bollinger_bands_req_for_buy_signal` | integer | no |  |
|   `targets_to_buy` | integer | no |  |
|   `sell_with_strategy` | integer | no |  |
|   `pct_profit` | integer | no |  |
|   `ticker_rate` | string | no | One of: highest_bid_lowest_ask, last_tick_if_higher_lower, always_last_tick. |
|   `cool_down` | integer | no |  |
|   `one_open_order_coin` | integer | no |  |
|   `pct_lower_bid` | number | no |  |
|   `pct_higher_ask` | number | no |  |
|   `stop_loss_pct` | number | no |  |
|   `trailing_stop_loss` | integer | no |  |
|   `trailing_stop_loss_pct` | number | no |  |
|   `trailing_stop_arm_pct` | number | no |  |
|   `trailing_stop_buy_pct` | number | no |  |
|   `hold_target_is_same` | integer | no |  |
|   `only_buy_positive_pairs` | integer | no |  |
|   `autoclose_position` | integer | no |  |
|   `DCA` | integer | no |  |
|   `DCA_after_time` | integer | no |  |
|   `DCA_max_retries` | integer | no |  |
|   `DCA_pct_trigger` | integer | no |  |
|   `DCA_buy_immediately` | integer | no |  |
|   `DCA_order_size` | string | no | One of: double_down, triple_down. |
|   `sell_order_max_open_time` | integer | no |  |
|   `buy_order_max_open_time` | integer | no |  |
|   `max_open_positions` | integer | no |  |
|   `coin_max_open_pos` | integer | no |  |
|   `coin_max_open_pos_pct` | number | no |  |
|   `buy_order_amount_pct` | number | no |  |
|   `buy_order_min_amount` | number | no |  |
|   `max_amount_allocated` | number | no |  |

## Example request

```bash
curl -X POST "https://api.cryptohopper.com/v1/hopper" \
  -H "access-token: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"My BTC bot","enabled":0,"bot_type":0,"template_id":"market_12345","config":{"exchange":"binance","base_currency":"usdt","paper_trading":0},"api_config":{"api_key":"your-exchange-api-key","api_secret":"your-exchange-api-secret"}}'
```

## Response

Example response (illustrative values):

```json
{
    "data": {
        "id": 123457
    }
}
```

Status codes: 200. Errors return JSON with `status`, `error` and `message`, plus a numeric `code` when the error comes from the API itself rather than the gateway.