Skip to content
Logo

Account tools

Read-only tools for the connected Farao account. None of them take a market symbol, and none can change anything.

get_account_status

The linked account, the execution mode and the granted scopes. Agents should call this first.

Scope: account:read · Input: none

Output
connectedWhether an account is linked
modeconfirm-every-trade or pre-authorized. See Execution modes
autonomoustrue when the mode is pre-authorized
scopesThe scopes this connection holds
masterAddressThe account's address on Hyperliquid

get_trading_policy

The limits you signed for autonomous trading and what is left of today's cap.

Scope: account:read · Input: none

Output
autonomousWhether limits are in force
limits.max_pct_per_tradeLargest margin per order as a share of account value. 0.1 is 10%
limits.max_leverageHighest leverage for a new order
limits.max_daily_notionalThe daily cap in USD, counted on margin. Resets at 00:00 UTC
limits.blocked_assetsMarkets the agent may not trade
limits.expires_atWhen the authority ends, in unix seconds
dailyRemainingUsdWhat is left of today's cap. null when no cap is set

A limit that is absent was set to "no limit".

get_portfolio

Balances and total account value.

Scope: portfolio:read · Input: none

Output
cashUsdFree USDC available for new trades right now. "Cash" in the Farao app
wealthUsdTotal account value including unrealized PnL. "Wealth" in the Farao app
perpPosition value, margin used and withdrawable amount
spot.balancesRaw spot balances per coin

Farao accounts are unified: USDC backs perpetual positions directly, so there is nothing to move between spot and perps. Use cashUsd to size a trade.

get_positions

Open positions on every exchange, crypto and HIP-3 alike.

Scope: positions:read · Input: none

Each position has coin, side, size, entryPrice, positionValueUsd, unrealizedPnlUsd, marginUsedUsd, liquidationPrice, leverage, maxLeverage and fundingPaidUsd.

get_open_orders

Resting orders, including take profit and stop loss triggers.

Scope: orders:read · Input: none

Each order has orderId, coin, side, size, originalSize, limitPrice, triggerPrice, orderType, reduceOnly and placedAt. Pass orderId to prepare_cancel_order.

get_recent_fills

The most recent fills, newest first.

Scope: orders:read

InputType
limitinteger, 1 to 200Default 50

Each fill has coin, side, price, size, closedPnlUsd, feeUsd, filledAt and the transaction hash.