Skip to content

docs(trade): spell out --reduce-only side semantics (close = opposite side) #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
psmiratisu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(trade): spell out --reduce-only side semantics (close = opposite side) #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -788,10 +788,16 @@ acp trade --side short --token ETH --size 0.5 --price 4000 --post-only
# Same shape for an equity, FX, or commodity perp — just change the symbol
acp trade --side long --token <HL_MARKET_SYMBOL> --size 1 --leverage 3

# Reduce-only (close part of a position)
acp trade --side short --token BTC --size 0.01 --reduce-only
# Close (part of) a position: --reduce-only with --side OPPOSITE to the position.
# Closing a LONG is a SHORT order; closing a SHORT is a LONG order.
acp trade --side short --token BTC --size 0.01 --reduce-only # closes a BTC long
acp trade --side long --token BTC --size 0.01 --reduce-only # closes a BTC short
```

> `--reduce-only` only shrinks an existing position — never set it when opening or
> adding. If the side matches the position (or there's no position), Hyperliquid
> rejects the order with "Reduce only order would increase position".

**Hyperliquid — account & withdraw:**

```bash
Expand Down
8 changes: 7 additions & 1 deletion src/commands/trade.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,13 @@ export function registerTradeCommands(program: Command): void {
.option("--size <size>", "Perp order size in token units")
.option("--leverage <n>", "Set leverage for this token before a perp order")
.option("--isolated", "Use isolated margin when setting leverage", false)
.option("--reduce-only", "Only reduce an existing perp position", false)
.option(
"--reduce-only",
"Close/shrink an existing perp position. --side must be the OPPOSITE of the position " +
"(close a long with --side short, close a short with --side long). " +
"Never set this when opening or adding to a position — HL rejects it.",
false
)
.option("--dry-run", "Preview the trade (route, size, margin, fees) without signing or submitting anything", false)
.action(async (opts, cmd) => {
const json = isJson(cmd);
Expand Down