View Source Hyperliquid.Api.Exchange.SendAsset (hyperliquid v0.2.2)

Transfer tokens between different perp DEXs, spot balance, users, and/or sub-accounts.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#send-asset

Summary

Functions

Transfer tokens between different perp DEXs, spot balance, users, and/or sub-accounts.

Functions

Link to this function

request(destination, source_dex, destination_dex, token, amount, opts \\ [])

View Source

Transfer tokens between different perp DEXs, spot balance, users, and/or sub-accounts.

Parameters

  • destination: Destination address
  • source_dex: Source DEX ("" for default USDC perp DEX, "spot" for spot)
  • destination_dex: Destination DEX ("" for default USDC perp DEX, "spot" for spot)
  • token: Token identifier (e.g., "USDC:0xeb62eee3685fc4c43992febcd9e75443")
  • amount: Amount to send as string (not in wei)
  • opts: Optional parameters

Options

  • :private_key - Private key for signing (falls back to config)
  • :expected_address - When provided, validates the private key derives to this address
  • :from_sub_account - Source sub-account address ("" for main account, default: "")

Returns

  • {:ok, response} - Transfer result
  • {:error, term()} - Error details

Examples

# Transfer from perp to spot
{:ok, result} = SendAsset.request(
  "0x...",
  "",
  "spot",
  "USDC:0xeb62eee3685fc4c43992febcd9e75443",
  "100.0"
)

Breaking Change (v0.2.0)

private_key was previously the first positional argument. It is now an option in the opts keyword list (:private_key).