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

Send USD to another address.

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

Summary

Functions

Link to this function

request(destination, amount, opts \\ [])

View Source

Send USD to another address.

Parameters

  • destination: Destination address
  • amount: Amount to send (string or number, e.g. 1 = $1)
  • 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

Returns

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

Examples

{:ok, result} = UsdSend.request("0x...", "100.0")
{:ok, result} = UsdSend.request("0x...", "100.0", private_key: "abc...")

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).