bullpen hyperliquid take-profit¶
Last updated: May 29, 2026
Place a reduce-only take-profit order for an existing position (requires hyperliquid_trading feature)
Usage¶
Live Help¶
Place a reduce-only take-profit order for an existing position (requires hyperliquid_trading feature)
Usage: bullpen hyperliquid take-profit [OPTIONS] --trigger-price <TRIGGER_PRICE> <COIN>
Arguments:
<COIN>
Coin/market (e.g. "ETH", "BTC")
Options:
--no-multi-wallet-warning
Suppress the table-mode warning shown when multiple EVM wallet accounts exist
--output <OUTPUT>
Output format for command results
[possible values: table, json]
--trigger-price <TRIGGER_PRICE>
Trigger price
--env <ENV>
Target environment to connect to (overrides config.toml)
[env: BULLPEN_ENV=]
[possible values: staging, production]
--size <SIZE>
Position size in base units. Omit to cover the full open position
--config <CONFIG>
Path to a custom config.toml file (overrides $BULLPEN_CONFIG and the default location).
Explicit --config and BULLPEN_CONFIG paths fail closed: if the file is missing, the CLI exits validation instead of silently loading defaults. Credentials still resolve via BULLPEN_HOME, so set BULLPEN_HOME too when isolating a session.
--limit <LIMIT>
Submit a trigger-limit order instead of a market-style TP child order
--subaccount <SUBACCOUNT>
Target a Hyperliquid subaccount. Hyperliquid still signs with the authenticated primary account
--vault <VAULT>
Target a Hyperliquid vault. Hyperliquid still signs with the authenticated primary account
--read-only
Enable read-only mode: blocks all mutating commands
-y, --yes
Skip confirmation prompt
--non-interactive
Suppress interactive prompts; does NOT imply --yes for money-moving commands
[env: BULLPEN_NON_INTERACTIVE=]
--preview
Show trigger side, PnL, ROI, and fee estimates without signing or submitting
-h, --help
Print help (see a summary with '-h')
EXAMPLES:
bullpen hyperliquid take-profit --help
Show options for this command without signing, submitting, or changing state.
Example Commands¶
bullpen hyperliquid take-profit [OPTIONS] --trigger-price <TRIGGER_PRICE> <COIN>
bullpen hyperliquid take-profit --help
bullpen hyperliquid take-profit BTC --trigger-price 70000 --size 0.25 --preview --output json
JSON Output¶
Contract: JSON Output Contract.
Preview (--preview --output json)¶
Preview output is a single JSON document emitted only when --preview --output json is passed. Live submit output uses the standard Hyperliquid mutation-report schema instead.
Schema version: 1 when a command emits schema_version; otherwise treat the current command shape as contract version 1.
Top-level Keys¶
| key | type | nullable | notes |
|---|---|---|---|
action |
string | no | take-profit or stop-loss |
coin |
string | no | Hyperliquid market symbol |
side |
string | no | Reduce direction: sell for long positions, buy for short positions |
reduce_only |
boolean | no | Always true for trigger previews |
trigger_kind |
string | no | Trigger kind matching the command |
trigger_px |
string | no | Effective trigger price after Hyperliquid price precision |
limit_px |
string | yes | Optional effective trigger-limit child price after Hyperliquid price precision; omitted for market-style trigger children |
requested_base_size |
string | no | Base-unit size requested by --size, or the full open position when omitted |
effective_base_size |
string | no | Base-unit size used for the preview after Hyperliquid size precision |
base_unit_symbol |
string | no | Base asset symbol, included to make TP/SL base-unit sizing explicit |
position_size |
string | no | Signed open position size; positive is long, negative is short |
position_direction |
string | no | long or short |
mark_px |
string | no | Current mark price used for side-of-mark validation |
entry_px |
string | no | Position entry price used for PnL and ROI |
leverage |
integer | no | Current position leverage used for ROI |
pnl_at_trigger_usd |
string | no | Estimated PnL at trigger as a signed USD decimal string |
price_change_pct |
string | no | Unlevered percent move from entry to trigger |
roi_pct |
string | no | Leveraged ROI percent at trigger |
risk_reward_ratio |
string | yes | Omitted for single-leg previews; reserved for future bracket previews |
estimated_taker_fee_usd |
string | no | Estimated taker fee at trigger notional |
estimated_builder_fee_usd |
string | no | Currently 0 because live TP/SL placement does not attach builder attribution |
estimated_total_fee_usd |
string | no | Sum of estimated taker and builder fees |
warning |
string | yes | Optional warning, such as a trigger very close to mark price |
request |
object | no | Echo of the preview request |
Example¶
{
"action": "take-profit",
"coin": "BTC",
"side": "sell",
"reduce_only": true,
"trigger_kind": "take-profit",
"trigger_px": "70000",
"requested_base_size": "0.25",
"effective_base_size": "0.25",
"base_unit_symbol": "BTC",
"position_size": "0.5",
"position_direction": "long",
"mark_px": "65000",
"entry_px": "60000",
"leverage": 5,
"pnl_at_trigger_usd": "2500",
"price_change_pct": "16.666666666666666666666666667",
"roi_pct": "83.333333333333333333333333335",
"estimated_taker_fee_usd": "6.125",
"estimated_builder_fee_usd": "0",
"estimated_total_fee_usd": "6.125",
"request": {
"action": "take-profit",
"coin": "BTC",
"trigger_kind": "take-profit",
"trigger_px": "70000",
"size_base": "0.25"
}
}
Stability¶
Patch releases may add nullable or optional fields. Minor releases may add required fields or increment schema_version. Major releases may remove or rename fields.