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

# Sync dApp API

> An OpenRPC specification for the dapp to interact with a Wallet Provider.

<p class="x2mdx-ref-back"><a href="/reference/wallet-gateway-json-rpc/index">Back to overview</a></p>

<div class="x2mdx-ref-hero">
  <p class="x2mdx-ref-eyebrow">OpenRPC Spec</p>

  <h1 class="x2mdx-ref-title">Sync dApp API</h1>

  <p class="x2mdx-ref-summary">An OpenRPC specification for the dapp to interact with a Wallet Provider.</p>

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">Changed 1.4.0</span>
  </div>

  <dl class="x2mdx-ref-meta-grid">
    <div class="x2mdx-ref-meta-item">
      <dt>Latest source path</dt>
      <dd>api-specs/openrpc-dapp-api.json</dd>
    </div>

    <div class="x2mdx-ref-meta-item">
      <dt>Publish version</dt>
      <dd>1.4.0</dd>
    </div>

    <div class="x2mdx-ref-meta-item">
      <dt>OpenRPC version</dt>
      <dd>1.2.6</dd>
    </div>

    <div class="x2mdx-ref-meta-item">
      <dt>Spec info.version</dt>
      <dd>0.5.0</dd>
    </div>
  </dl>
</div>

## Methods

Method pages are the primary reference surface. This spec page stays focused on grouping and discovery.

<div class="x2mdx-ref-card-grid">
  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/accountschanged">
    <div class="x2mdx-ref-card-head">
      <h3>accountsChanged</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>0</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>array\[object]</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/connect">
    <div class="x2mdx-ref-card-head">
      <h3>connect</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Ensures ledger connectivity and returns the connected network information along with the session information.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>0</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>object</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/disconnect">
    <div class="x2mdx-ref-card-head">
      <h3>disconnect</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Invoke a disconnect of the wallet provider session.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>0</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>null</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/getactivenetwork">
    <div class="x2mdx-ref-card-head">
      <h3>getActiveNetwork</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Returns the active network.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>0</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>object</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/getprimaryaccount">
    <div class="x2mdx-ref-card-head">
      <h3>getPrimaryAccount</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Returns the primary account.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>0</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>object</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/isconnected">
    <div class="x2mdx-ref-card-head">
      <h3>isConnected</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.26.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Returns the connection status and the connected network information.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>0</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>object</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/ledgerapi">
    <div class="x2mdx-ref-card-head">
      <h3>ledgerApi</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Proxy for the JSON-API endpoints. Injects authorization headers automatically.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>1</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>object</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/listaccounts">
    <div class="x2mdx-ref-card-head">
      <h3>listAccounts</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Lists the addresses (wallets) with their properties; including which network they are associated to and with signing provider is used.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>0</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>array\[object]</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/messagesignature">
    <div class="x2mdx-ref-card-head">
      <h3>messageSignature</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 1.4.0</span>
      </div>
    </div>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>0</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>oneOf</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/prepareexecute">
    <div class="x2mdx-ref-card-head">
      <h3>prepareExecute</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">Changed 1.4.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Prepares a transaction for subsequent signing & execution.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>1</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>null</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/prepareexecuteandwait">
    <div class="x2mdx-ref-card-head">
      <h3>prepareExecuteAndWait</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">Changed 1.4.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Like prepareExecute, but waits for the transaction to be executed on the ledger.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>1</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>object</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/signmessage">
    <div class="x2mdx-ref-card-head">
      <h3>signMessage</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Signs a message.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>1</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>object</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/status">
    <div class="x2mdx-ref-card-head">
      <h3>status</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <p class="x2mdx-ref-card-summary">Returns the current status of the wallet provider session.</p>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>0</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>object</dd>
      </div>
    </dl>
  </a>

  <a class="x2mdx-ref-card" href="/reference/wallet-gateway-json-rpc/operations/dapp-api/txchanged">
    <div class="x2mdx-ref-card-head">
      <h3>txChanged</h3>

      <div class="x2mdx-ref-badges">
        <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">JSON-RPC</span>

        <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 0.24.0</span>
      </div>
    </div>

    <dl class="x2mdx-ref-meta-grid">
      <div class="x2mdx-ref-meta-item">
        <dt>Parameters</dt>
        <dd>0</dd>
      </div>

      <div class="x2mdx-ref-meta-item">
        <dt>Result</dt>
        <dd>oneOf</dd>
      </div>
    </dl>
  </a>
</div>