> ## Documentation Index
> Fetch the complete documentation index at: https://docs.b3os.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Hyperliquid Place Order

Place a limit order on Hyperliquid perpetual DEX. Supports GTC (good-til-cancelled), IOC (immediate-or-cancel), and ALO (post-only) order types. Ideal for: automated trading strategies, DCA bots, and portfolio rebalancing.

![Hyperliquid Place Order logo](https://cdn.b3.fun/hyperliquid-logo.png)
Catalog action Hyperliquid wallet

Place a limit order on Hyperliquid perpetual DEX. Supports GTC (good-til-cancelled), IOC (immediate-or-cancel), and ALO (post-only) order types. Ideal for: automated trading strategies, DCA bots, and portfolio rebalancing.

**Review wallet and value movement**

This action can require a wallet connector, gas, token movement, or an external side effect. Test with simulation or a controlled amount before using it in a live workflow.

## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `hyperliquid-place-order` |
| Category | Hyperliquid |
| Connector | `wallet` |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `hyperliquid`, `perps`, `order`, `trade`, `defi` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `dex` | `string` | No | HIP-3 DEX name for TradFi markets. Omit for standard crypto perps. xyz = trade.xyz \(stocks, indices, commodities\), flx = flx.finance, vntl = vntl.exchange |
| `coin` | `string` | Yes | Asset symbol \(e.g., BTC, ETH for crypto; TSLA, SP500 for HIP-3 DEX markets\) |
| `side` | `string` | Yes | Order direction |
| `size` | `string \| number` | Yes | Order size in asset units \(e.g., '0.1' for 0.1 BTC\) or USD amount when sizeUnit is 'usd'. Total order value must be at least $10. |
| `sizeUnit` | `string` | No | How to interpret the size field. 'asset' \(default\): size is in asset units \(e.g., 0.1 BTC\). 'usd': size is a USD amount converted to asset units at execution time using ceil rounding. |
| `price` | `string` | Yes | Limit price in USD. Total order value \(size × price\) must be at least $10. |
| `orderType` | `string` | Yes | Order type: limit \(GTC\), ioc \(immediate-or-cancel\), alo \(add-liquidity-only / post-only\) |
| `reduceOnly` | `boolean` | No | If true, order can only reduce an existing position |
| `cloid` | `string` | No | Optional client order ID \(0x-prefixed hex, up to 16 bytes\). Auto-generated if omitted. |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | `string` | Yes | Order outcome: resting \(on book\), filled \(immediately matched\), error |
| `oid` | `number` | No | Hyperliquid order ID \(present for resting and filled orders\) |
| `filledSize` | `string` | No | Total filled size \(for filled orders\) |
| `avgPrice` | `string` | No | Average fill price \(for filled orders\). On rare reconciliation paths \(response lost in transit\) this reflects the order's limit price, not the actual execution price. |
| `coin` | `string` | No | Asset symbol |
| `side` | `string` | No | Order side \(buy/sell\) |
| `requestedSize` | `string` | No | Originally requested size |
| `requestedPrice` | `string` | No | Originally requested price |
| `cloid` | `string` | No | Client order id attached to this order \(0x + 32 hex\). Use to cancel or reconcile. |
| `requestedSizeUsd` | `string` | No | Original USD amount requested \(only present when sizeUnit was 'usd'\) |
| `convertedSize` | `string` | No | Asset size after USD conversion \(only present when sizeUnit was 'usd'\) |

## Examples

**Workflow node**

```json
{
  "type": "hyperliquid-place-order",
  "payload": {
    "coin": "example-coin",
    "side": "buy",
    "size": "example-size",
    "price": "example-price",
    "orderType": "limit"
  },
  "children": [],
  "connector": {
    "type": "wallet",
    "id": "conn_wallet"
  }
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/hyperliquid-place-order/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "coin": "example-coin",
    "side": "buy",
    "size": "example-size",
    "price": "example-price",
    "orderType": "limit"
  }
}'
```

**Use expressions for dynamic values**

Payload fields can use workflow expressions such as `{{$trigger.body.amount}}`, `{{$nodes.fetch.result.price}}`, and `{{$props.asset}}` when the value should come from a trigger, prior node, or reusable workflow prop.