Bots

This sections documents the Bots page.

Bots Overview

Bots are used to connect your Hyperliquid accounts to Katoshi

Bot Creation

  • Click on the bottom-right "+" button to open the bot creation popup

  • Connect your Hyperliquid wallet that will be linked to your bot

  • Enter a unique name for your new bot

  • Generate an API Key in that same Hyperliquid account and add the secret key

If you signed-up to Hyperliquid with an email, you can go into settings to export your Email Wallet private key and load it into a wallet provider (Rabby, Metamsk, etc).

Bot Activation

  • Every bot requires a wallet signature to activate your bot to prove ownership and approve Hyperliquid Builder Codes, which are used to pass a small management fee to open and close positions on your behalf.

  • Click on the "Activate Wallet" button to trigger the signature in your wallet

  • Once the signature is approved, your bot will be activated and ready to trade

Make sure to have funds deposited in your Hyperliquid account for the activation to work. To fund your account on Hyperliquid, proceed to the Portfolio Page and click on Deposit.

Bot Triggers

Triggers allows you to send trading signals when custom rules are met.

  • Toggle: Enable/disable triggers

  • Run Trigger: Run trigger manually and see the calculated signal and response

  • Multi-coins: Run trigger on multiple coins

    • Use the $$ dynamic coin variable in expressions that will be replaced by each coin's name

  • Interval: Timeframe used for calculations. (trigger condition is checked on every new candles)

  • Rule: Your custom condition expression

  • Signal: The signal sent when rule conditions are met (true)

    • Expressions can also be used by using the {{ expression }} syntax

    • Trigger signal uses the same JSON structure as the Signal API

Example Rule:

RSI crosses under 30 level

ta.crossunder(ta.rsi($$, 14), 30)

Example Signal:

Open long position with 2% size, stop-loss at current low, and take-profit at the highest high in the last 20 candles

{
   "action": "open_position",
   "coin": {{ sym.ticker($$) }},
   "is_buy": true,
   "size_pct": 0.02,
   "sl": {{ $$.low }},
   "tp": {{ ta.highest($$.high, 20) }}
}

api_key and bot_id parameters are added automatically, do not add it to trigger signals.

Learn more about Expressions and how to use them:

Expressions

View expressions from our examples library:

Examples

Bot Settings

This section is used to update your bot settings

  • Toggle: Enable/disable your bots by clicking on the toggle button. Disabled bots will stop all signals from executing.

  • Bot ID: Your bot's unique ID which is required when sending trading signals

  • Name: Your bot's unique name

  • Vault Address: Connect an Hyperliquid vault by adding its address. When a vault is connected, all trading signals will be sent to the vault instead of your bot's main account. Sub-accounts are also supported using the vault address field.

Vault Bots (or subaccounts) are subject to our fixed pricing model. Learn more.

  • API Secret Key: Replace your API secret key at any time before it expires on Hyperliquid

  • Min. Order Size: Overwrite the size (USD value) when opening new positions for signal size under that amount. This can be useful to make sure to respect the Hyperliquid's $10 min. order size.

  • Max. Order Size: Overwrite the size (USD value) when opening new positions for signal size over that amount. This can be useful to control the max. size used when your bot is connected to a public strategy.

Example:

  • You have $10,000 in your account balance

  • Your bot receives a signal to open a long on BTC with 100% account size

  • You have set a Max. Order Size value of $1,000

  • Your long position will open with a $1,000 value instead of $10,000

  • Whitelisted Coins: List all coins that are allowed for opening new positions. Leave empty to allow all coins.

  • Whitelisted IP Address: List all IP addresses that are allowed to send signals to your bot. Leave empty to allow all IP addresses.

API Keys

View your Hyperliquid API keys and expiration dates

PreviousWelcomeNextAgents

Last updated

Was this helpful?