hyperliquid(hl)

A bot for interacting with hyperliquid exchange.

Here is a list of the commands and the flags supported by the bot.

Installation

1. Install rust from here
2. Ensure you have make installed (usually available by default on Linux/macOS, or via Chocolatey/MSYS2 on Windows).
3. Clone this repository.
4. Run make build to build the project.
5. Run make install to install the hl executable.
6. Run hl --help to see the list of commands

Config

The config file is located at ~/.hyperliquid/config

Notes

1. The config file is created when the bot is run for the first time
2. Run hl login <private key> to set the wallet to use for trading
3. Run hl chain <chain> to set the chain to use for trading. The default network is Arbitrum Goerli
4. Run hl set dl <leverage> to set the leverage for all the available assets on hyperliquid

Commands

Set Commands

hl set dl <leverage> - sets the leverage for all the available assets on hyperliquid

leverage:[required] is a number between 1 and 100

examples

1. hl set dl 10

---

TpSl Commands

hl tp <size> <asset> <tp> - sets a take profit order for the specified asset

size:[required] is the percentage of the order size

asset:[required] is the asset to set the take profit order for

tp:[required] is the take profit percentage or gain in asset before tp order is triggered

examples:

1. hl tp 10% btc 5 - sets a take profit order for 10% of the order size for btc with a take profit of 5%

2. hl tp 30% btc +$300 - sets a take profit order for 30% of the order size for btc with a take profit of $300

3. hl tp 100% sol +300pnl - sets a take profit order for 100% of the order size for sol with a take profit of 300pnl

cargo run -- tp 50% sol +10%pnl - sets a take profit order for 50% of the order size for sol with a take profit of 10% of the order size

---

hl sl <size> <asset> <sl> - sets a stop loss order for the specified asset

Same as tp command but for setting a stop loss

---

Buy/Sell Commands

hl buy --size <size> --asset <asset> --price <price> --sl <sl> --tp <tp> - places a buy order for the specified asset

size:[optional] is the order size. If not specified, the default order size in the config will be used

asset:[optional] is the asset to sell. If not specified, the default asset in the config will be used

price:[optional] is the price to buy the asset at. If not specified, the current market price will be used but if provided the a limit order will be placed at the specified price

sl:[optional] is the price to set the stop loss at. If not specified, the stop loss will not be set. Can be a percentage or a pnl amount or the exact price

tp:[optional] is the price to set the take profit at. If not specified, the take profit will not be set. Can be a percentage or a pnl amount or the exact price

examples

1. hl buy --size 100 --asset btc --price 1900 --sl 1800 --tp 2000 - places a buy order for 100 usd worth of btc at the price of $1900. The stop loss will be set at $1800 and the take profit will be set at $2000

2. hl buy --size 100 --asset btc --price 1900 - places a buy order for 100 usd worth of btc at the price of $1900. The stop loss and take profit will not be set

3. hl buy --size 100 --asset btc - places a buy order for 100 usd worth of btc at the current market price. The stop loss and take profit will not be set

---

hl sell --size <size> --asset <asset> --price <price> --sl <sl> --tp <tp> - places a sell order for the specified asset

same as buy command but for selling

---

Twap Commands

hl twap buy <size> <asset> <time between interval in mins, number of intervals> - Divides the total order size by the number of intervals. After the time between intervals, each piece of the divided order will be bought at market

example: hl twap buy 100 eth 5,10 - places a twap buy order for 100 usd. The order will be divided into 10 pieces and each piece will be bought every 5 minutes.

---

hl twap sell <size> <asset> <time between interval in mins, number of intervals> - Divides the total order size by the number of intervals. After the time between intervals, each piece of the divided order will be sold at market

examples

1. hl twap sell 100 eth 5,10 - places a twap sell order for 100 usd. The order will be divided into 10 pieces and each piece will be sold every 5 minutes.

---

Pair Commands

hl pair buy <size> <pair> --price <price> --sl <sl> --tp <tp> - Takes 50% of order size and longs Asset X and takes another 50% of order size and shorts Asset Y in a pair

size:[required] is the order size to be split equally between the long and short

pair:[required] is the pair to long and short i.e Asset X/Asset Y

price:[optional] is the ratio of the market price of Asset X/Asset Y to enter the trade at. If not specified, the current market price will be used but if provided the ratio will be used to calculate when to enter the trade

sl:[optional] is the ratio of the market price of Asset X/Asset Y to set the stop loss at.

tp:[optional] is the ratio of the market price of Asset X/Asset Y to set the take profit at.

examples:

1. hl pair buy 100 btc/eth --price 0.05 --sl 0.04 --tp 0.06 - Takes 50% of order size and longs btc and takes another 50% of order size and shorts eth in a pair. The ratio of btc/eth is 0.05 so the bot will enter the trade when the ratio is 0.05. The stop loss will be set at 0.04 and the take profit will be set at 0.06

2. hl pair buy 100 btc/eth - Takes 50% of order size and longs btc and takes another 50% of order size and shorts eth in a pair. The current market price of btc/eth will be used to enter the trade. The stop loss and take profit will not be set

3. hl pair buy 100 btc/eth --price 0.05 - Takes 50% of order size and longs btc and takes another 50% of order size and shorts eth in a pair. The ratio of btc/eth is 0.05 so the bot will enter the trade when the ratio is 0.05. The stop loss and take profit will not be set

---

hl pair sell <size> <pair> --price <price> --sl <sl> --tp <tp> - Takes 50% of order size and shorts Asset X and takes another 50% of order size and longs Asset Y in a pair

Same as pair buy command but for selling

---

Scale Commands

hl scale buy <size_per_interval> <asset> <lower> <upper> - Scales into a long position by placing limit orders at intervals between the lower and upper price

size_per_interval:[_required*] is a forward slash separated string of the size of each interval and the number of intervals i.e 100/10.

asset:[required] is the asset to scale buy

lower:[required] is the lower price to place the limit orders at

upper:[required] is the upper price to place the limit orders at

examples

1. hl scale buy 100/10 eth 1800 1890 - Scales into a long position by placing limit orders at intervals between 1800 and 1890. 100 eth will be divided over 10 orders (10eth per order). Since there are 10 number of intervals, there will be 10 buy orders placed between 1800 and 1890:

---

hl scale sell <size_per_interval> <asset> <lower> <upper> - Scales into a short position by placing limit orders at intervals between the lower and upper price

Same as scale buy command but for selling

---

View Commands

hl view upnl - View the current unrealized pnl

hl view wallet balance - View the current wallet balance

hl view unfilled orders - View the current unfilled orders

hl view open positions - View the current open positions