For Agents
Read accounts, blocks, transactions, and chain state from a Symbol blockchain node, and broadcast signed transactions to the network.
Use for: Look up the balance of a Symbol account by address, Submit a signed Symbol transaction to a node, Get the latest block height on the Symbol chain, Retrieve the full transaction list for a given block height
Not supported: Does not handle wallet key management, transaction signing, or fiat conversion — use for Symbol blockchain node reads and signed transaction broadcast only.
The Catapult REST API is the public HTTP interface for nodes running the Symbol blockchain (the protocol born from the NEM ecosystem). It exposes 81 endpoints covering accounts, blocks, transactions, mosaics, namespaces, finalisation, and node and network metadata, so a client can query chain state, broadcast signed transactions, and watch finality progress without running its own node. The API is designed for wallets, explorers, and back-office services that need a read and submit interface to the Symbol chain.
Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Catapult REST Endpoints, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | shStep 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
What an agent can do with Catapult REST Endpoints API.
Look up account state, including balances and supplemental keys, by address or public key
Submit signed transactions to a Symbol node through the transactions endpoint
Query block headers, full blocks, and merkle proofs for any block height
Read mosaic and namespace records to resolve token metadata and human-readable aliases
Track chain progression and finalisation through the chain info and finalization endpoints
Inspect node identity, peers, and network properties for health monitoring
Patterns agents use Catapult REST Endpoints API for, with concrete tasks.
★ Wallet Account Lookup
Wallet front-ends call /accounts/{accountId} to render a Symbol account: balance, mosaics held, and account type. The merkle variant under /accounts/{accountId}/merkle returns a proof, useful for light clients that want to verify state against a block hash rather than trusting the node outright.
Fetch the account state for address TBLOCKCHAINSAMPLEADDRESS and return the list of mosaics and balances.
Transaction Broadcast and Confirmation
Services that build and sign transactions off-node use the Catapult REST API to push them to the network. The transactions endpoints accept the signed payload, expose status lookups for unconfirmed and confirmed states, and the finalization endpoints confirm when a block is irreversible. This pattern keeps signing keys off the node host while still using the node for broadcast.
Submit a signed transfer transaction to the Symbol testnet and poll until it is confirmed in a block.
Block Explorer Backend
Block explorers fan out reads against /blocks, /blocks/{height}, and the merkle endpoints to build a full chain view. Combined with /chain/info for current height and /node for identity, an explorer can render block, transaction, and account pages without running its own indexer for primary data.
Get the current chain height, then fetch the block at that height and list every transaction it contains.
AI Agent Integration via Jentic
An AI agent uses Jentic to call Symbol nodes without needing a hand-coded SDK. Jentic exposes the Catapult REST operations by intent, so an agent asking to read a Symbol account or submit a transaction is routed to the correct endpoint with a typed schema, which is valuable when integrating chain reads into a wider workflow.
Use Jentic to search for read symbol blockchain account, load the schema for /accounts/{accountId}, and return the balance for a given address.
81 endpoints — the catapult rest api is the public http interface for nodes running the symbol blockchain (the protocol born from the nem ecosystem).
METHOD
PATH
DESCRIPTION
/accounts/{accountId}
Get account state by address or public key
/accounts/{accountId}/merkle
Get account state with merkle proof
/blocks/{height}
Get a block by height
/blocks/{height}/transactions/{hash}/merkle
Get a transaction merkle proof for a block
/chain/info
Get current chain height and finalisation state
/accounts/{accountId}
Get account state by address or public key
/accounts/{accountId}/merkle
Get account state with merkle proof
/blocks/{height}
Get a block by height
/blocks/{height}/transactions/{hash}/merkle
Get a transaction merkle proof for a block
/chain/info
Get current chain height and finalisation state
Three things that make agents converge on Jentic-routed access.
Credential isolation
Catapult REST is unauthenticated, but any gateway tokens or proxy credentials are stored encrypted in the Jentic vault and injected at execution time so they never reach the agent.
Intent-based discovery
Agents search Jentic by intent (for example, read symbol account) and Jentic returns the matching Catapult REST operation with its schema, so the agent calls the right endpoint without reading the spec.
Time to first call
Direct integration: 2-4 days to learn the Symbol model, build request and response handling, and add finalisation logic. Through Jentic: under 1 hour to search, load, and execute.
Alternatives and complements available in the Jentic catalogue.
Specific to using Catapult REST Endpoints API through Jentic.
What authentication does the Catapult REST API use?
Catapult REST endpoints are unauthenticated by default — a Symbol node serves public chain data and accepts pre-signed transactions. When fronting a node with a gateway that adds an API key, store that key in the Jentic vault so it never reaches the agent context.
Can I submit signed transactions through the Catapult REST API?
Yes. Sign the transaction off-node, then PUT the signed payload to the transactions endpoint exposed by Catapult REST. The node validates and gossips it. Use the /chain/info and finalization endpoints to confirm inclusion and irreversibility.
What are the rate limits for the Catapult REST API?
Rate limits are not defined in the spec — they depend on which node operator is hosting the endpoint. For the public testnet at reference.symboltest.net, treat reads as moderate and avoid hammering /blocks for full chain scans; use /chain/info to drive incremental fetches.
How do I read a Symbol account balance with the Catapult REST API through Jentic?
Search Jentic for read symbol blockchain account, load the schema for GET /accounts/{accountId}, and execute with the address. The full flow is pip install jentic, search, load, execute.
Does the API include endpoints for finalisation?
Yes. The spec covers finalisation proof endpoints alongside /chain/info, so a client can verify when a block is irreversible rather than relying on confirmation depth heuristics.
GET STARTED