RADIX WikiRADIX Wiki

Overview

The Gateway SDK is a TypeScript client for the Radix Gateway API. It lets you query account balances, read component state, look up transaction history, and submit transactions – all the read/write operations your dApp frontend needs.

npm install @radixdlt/babylon-gateway-api-sdk

Setup

import { GatewayApiClient, RadixNetwork } from '@radixdlt/babylon-gateway-api-sdk'
 
const gatewayApi = GatewayApiClient.initialize({
  networkId: RadixNetwork.Mainnet,  // or RadixNetwork.Stokenet
  applicationName: 'My dApp',
  applicationVersion: '1.0.0',
  applicationDappDefinitionAddress: 'account_rdx...'
})

The SDK connects to the Radix Foundation's public Gateway by default. For production dApps with high traffic, consider running your own Gateway node or using a third-party provider.

Common Queries

Account Balances

const details = await gatewayApi.state.getEntityDetailsVaultAggregated(
  'account_rdx1c956...'  // account address
)
// details.fungible_resources — token balances
// details.non_fungible_resources — NFT holdings

Component State

const component = await gatewayApi.state.getEntityDetailsVaultAggregated(
  'component_rdx1cp...'  // component address
)
// Read state,

Entity Metadata

const metadata = await gatewayApi.state.getAllEntityMetadata(
  'resource_rdx1t...'  // any entity address
)
// Returns: name, symbol, description, icon_url, etc.

Transaction Status

const status = await gatewayApi.transaction.getStatus(
  'txid_rdx1...'  // intent hash from sendTransaction
)
// status.intent_status: "CommittedSuccess" | "CommittedFailure" | "Pending" | ...

Historical State

Query state at a specific point in time by passing at_ledger_state:

const historicalDetails = await gatewayApi.state.innerClient.stateEntityDetails({
  stateEntityDetailsRequest: {
    addresses: ['account_rdx1...'],
    at_ledger_state: { state_version: 12345678 }
  }
})

Maintenance Status (checked September 2026)

The SDK and the service it talks to are released separately. The client library has been at 1.10.1 since March 2025. It is a generated client over the Gateway API, and that API has not changed since: on 16 September 2026 the public mainnet Gateway reported its API schema as v1.10.6.

The Gateway service shipped v1.10.7 on 7 September 2026, four days before the Eagle Ray protocol update was enacted on mainnet. Its one code change adds V4 and V5 to SystemVersion, the value the Gateway reads from a node to learn which version of the engine's system logic is running. In the engine's source, V4 belongs to Dugong and V5 to Eagle Ray. Mainnet went from V3 straight to V5, because Dugong was skipped. The public mainnet Gateway runs the v1.10.7 build. The release changes nothing the SDK calls, so dApps need no client update for it.

Since 7 August 2026 the Gateway has been maintained on a volunteer basis with bug fixes only, alongside the dApp Toolkit and the Radix Wallet. The practical consequence is about hosting rather than code. The public Gateway this SDK defaults to is Foundation-operated infrastructure in maintenance mode, and it sits at the top of the Accountability Council's inventory of services a community DAO would need to take over. If your dApp cannot tolerate that dependency, run your own Gateway or use a third-party provider – see Radix APIs.

Next Steps

HydrateLast updated Sep 16, 2026v1.4.010 revisionsVerified Sep 16, 2026