dApp API

The dApp API is the CIP-0103 JSON-RPC 2.0 API that dApps call to connect to a wallet, list accounts, and prepare and execute transactions. The Wallet Gateway exposes it, but you almost never call it directly.

Base path: /api/v0/dapp (configurable via server.dappPath)
Protocol: JSON-RPC 2.0, per CIP-0103
Authentication: JWT bearer token (obtained through a session)

Build dApps with the dApp SDK, which implements the dApp API and adds a high-level interface, session handling, wallet discovery, and multi-transport support. Use the raw API only for lower-level infrastructure. The SDK documentation is the reference for methods, events, and error handling.

Full specification

The complete OpenRPC specification is available at openrpc-dapp-api.json.

Real-time events (SSE)

The dApp API supports Server-Sent Events for real-time notifications. Connect to the /events path relative to the dApp API base URL (for example /api/v0/dapp/events), authenticating with the JWT as the token query parameter (the Authorization: Bearer header is also supported):

const eventsUrl = new URL('events', dappApiUrl + '/')
eventsUrl.searchParams.set('token', jwtToken)
const eventSource = new EventSource(eventsUrl.toString())

eventSource.addEventListener('accountsChanged', (e) => {
    /* ... */
})
eventSource.addEventListener('statusChanged', (e) => {
    /* ... */
})
eventSource.addEventListener('connected', (e) => {
    /* ... */
})
eventSource.addEventListener('txChanged', (e) => {
    /* ... */
})

SSE connections deliver real-time updates about transaction status (txChanged), account changes (accountsChanged), and session state (connected, statusChanged).

Overview

Wallet Gateway

Wallets and Exchanges

Ecosystem

Release Notes

Full specification

Real-time events (SSE)

See also

​Full specification

​Real-time events (SSE)

​See also

Full specification

Real-time events (SSE)

See also