Skip to content
Open icLens

Call a canister's API

Open a canister’s API section to see its public Candid methods and call them. It reads the interface the canister publishes, so it works for any canister that publishes one.

  1. Pick a method. Filter the list by name, and read its signature.

  2. Choose who calls. You, signed in, or Anonymous. Calls are always made directly, never through an Agent.

  3. Fill in the arguments. Each field matches its Candid type.

  4. Run it. A query runs straight away. An update opens a review: check the target and arguments, and type the method’s name to confirm.

Good to know

Section titled “Good to know”
  • An update can change state or move funds. Read the canister’s own documentation before calling an unfamiliar method.
  • A successful reply can still carry an error from the app, such as #Err(...). Read the result.
  • If an update’s reply is lost, check the canister before calling again: it may have run.
  • Results aren’t saved anywhere. Leaving the page clears them.
  • Types icLens can’t build a form for leave the call disabled. Use a CLI for those.