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

Cancel orders on Hyperliquid by order ID.

Summary

cancel_opts()

cancel_request()

Cancel a single order by order ID.

Cancel multiple orders by order ID.

@type cancel_opts() :: [{:vault_address, String.t()}]

@type cancel_request() :: %{asset: non_neg_integer(), oid: non_neg_integer()}

@type cancel_response() :: %{
  status: String.t(),
  response: %{type: String.t(), data: %{statuses: list()}}
}

@spec cancel(non_neg_integer(), non_neg_integer(), cancel_opts()) ::
  {:ok, cancel_response()} | {:error, term()}

Cancel a single order by order ID.

{:ok, result} = Cancel.cancel(0, 12345)

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

@spec cancel_batch([cancel_request()], cancel_opts()) ::
  {:ok, cancel_response()} | {:error, term()}

Cancel multiple orders by order ID.

cancels = [
  %{asset: 0, oid: 12345},
  %{asset: 0, oid: 12346}
]
{:ok, result} = Cancel.cancel_batch(cancels)

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