Guides

Step-by-step tutorials on how to use the tools, integrate Symbol with other technologies, and combine the built-in features to architect solutions.

Account

Creating an account

Create a new Symbol account to start sending and receiving transactions.

Read more ...


Getting the account information

Get the public key and balance of an account.

Read more ...


Reading transactions from an account

Get the complete list of transactions involving an account.

Read more ...


Getting the amount of assets sent to an account

Check the number of asset units you have sent to an account.

Read more ...


Account Restriction

Preventing spam attacks with account restrictions

Learn how to add and remove account restrictions.

Read more ...


Getting the account restrictions attached to an address

Get the list of account’s restrictions.

Read more ...


Aggregate Transaction

Sending multiple transactions together

Send transactions to different accounts at the same time, using aggregate transactions.

Read more ...


Creating an escrow contract

Learn about aggregate bonded transactions creating an escrow contract.

Read more ...


Cosigning aggregate bonded transactions automatically

Create a bot to cosign automatically transactions that require your account’s signature.

Read more ...


Cosigning aggregate bonded transactions

Cosign aggregate transactions pending to be signed.

Read more ...


Adding cosignatures to aggregate complete trasactions

This guide will show you how to add cosignatures to an aggregate complete transaction without using the partial cache.

Read more ...


Block

Getting a block by height

Get the block information given a height.

Read more ...


Listening to new blocks

Get notified when a new block is included.

Read more ...


Blockchain

Retrieving the global mosaic supply

Different values regarding the total supply of symbol.xym are available in real-time, through REST endpoints on any Symbol API node. Click on each endpoint below for an example.

Read more ...


Cross-Chain Swaps

Atomic cross-chain swap between public and private chain

Trade tokens between different blockchains without using an intermediary party in the process.

Read more ...


Harvesting

Node properties

There is a large number of node-related settings that can be customized in Symbol.

Read more ...


Activating delegated harvesting using the Desktop Wallet

Share your account’s importance securely with a node and get rewarded.

Read more ...


Activating delegated harvesting manually

Share your account’s importance securely with a node and get rewarded.

Read more ...


Activating remote harvesting

Harvest new blocks through a proxy account for added security.

Read more ...


Metadata

Assigning metadata to an account

Add custom data to an account.

Read more ...


Assigning metadata to a namespace

Add custom data to a namespace.

Read more ...


Assigning metadata to a mosaic

Add custom data to a mosaic.

Read more ...


Getting metadata entries attached to an account

Get the list of metadata entries attached to an account.

Read more ...


Getting metadata entries attached to a namespace

Get the list of metadata entries attached to an namespace.

Read more ...


Getting metadata entries attached to a mosaic

Get the list of metadata entries attached to an mosaic.

Read more ...


Updating metadata entries

Update any existent metadata entry.

Read more ...


Migration

Migrating from NIS1 to Symbol

With Symbol, most of the previously available NIS1 features have evolved. This document will help you upgrade your application’s previous NIS1 features to the newly available Symbol technology.

Read more ...


Monitoring

Turning the asynchronous transaction announcement into synchronous

Handy snippet to announce a transaction and wait until this is confirmed.

Read more ...


Mosaic

Creating a mosaic

Tokenize an asset using mosaics.

Read more ...


Modifying the mosaic supply

If a mosaic was created with the “Supply Mutable” property, you can make more tokens or reduce the total supply.

Read more ...


Getting the mosaic information

Get the ownership, divisibility, duration, and flags for a given mosaic identifier.

Read more ...


Mosaic Restriction

Restricting mosaic transfers

Limit how accounts can transact with Mosaic Restrictions.

Read more ...


Delegating mosaic restrictions to a third party

Allow another account to add restrictions to your mosaics.

Read more ...


Getting mosaic global restrictions attached to a mosaic

Get the list of mosaic global restrictions.

Read more ...


Getting mosaic address restrictions attached to an account

Get the list of mosaic address restrictions.

Read more ...


Multisig Account

Creating a multisig account

This guide will show you how to setup a joint account.

Read more ...


Removing a signer from a multisig account

This guide will show you how to remove a cosignatory from a multisig account.

Read more ...


Modifying a multisig account min approval

This guide will show you how to increase and decrease the minimum number of signatures needed to execute a multisig transaction.

Read more ...


Adding a new signer to a multisig account

This guide will show you how to add a new cosignatory to a multisig account.

Read more ...


Creating a multi-level multisig account

This guide will show you how to connect multiple multisig accounts to achieve advanced on-chain authorization logic.

Read more ...


Sending a multisig transaction

This guide will show you how to issue transactions from a multisig account.

Read more ...


Namespace

Registering a namespace

Create a unique name to identify your assets.

Read more ...


Creating a subnamespace

Once you have a registered root namespace, you can create up to 3 levels of subnamespaces to organize your assets.

Read more ...


Linking a namespace to an address

Alias an address with a namespace so that others can reference the account in a more friendly way when issuing transactions.

Read more ...


Linking a namespace to a mosaic

Alias an mosaic with a namespace so that others can reference it in a more friendly way when issuing transactions.

Read more ...


Getting the namespace information

Get the ownership and duration for a given namespace identifier.

Read more ...


Extending a namespace registration period

This guide shows you how to extend the rental period of a namespace.

Read more ...


Network

Private test networks

This guide will walk you through the process of setting up your own private network using Symbol.

Read more ...


Running a node

This guide walks you through the process of setting up a node to join Symbol’s public network.

Read more ...


Node properties

There is a large number of node-related settings that can be customized in Symbol.

Read more ...


Network properties

There is a large number of network-related settings that can be customized in Symbol.

Read more ...


How to connect to MongoDB

Learn how to access your API node’s MongoDB instance.

Read more ...


Using Symbol Bootstrap

On Linux systems using apt:

Read more ...


Running a node manually

This guide walks you through the process of setting up a node to join Symbol’s network without using Symbol Bootstrap.

Read more ...


Running a secure node

The running-a-symbol-node guide explains how to easily create a node using Symbol Bootstrap. In that guide, the setup process is conducted on the same machine that will host the node, meaning that private keys are generated on a machine connected to the Internet. If you need a hardened level of security you can follow this guide instead, at the cost of a more involved setup process.

Read more ...


Non-custodial node setup

How to relinquish control of a node’s main account to an external account, so that the external account’s private key is never required in the node setup process.

Read more ...


Maintaining a Node

Once you have created a Symbol node, be it manually or using Symbol bootstrap, the node is mostly autonomous. But there is still a little bit of maintenance required, explained in this guide.

Read more ...


Receipt

Getting the asset identifier behind a namespace with receipts

Get the resolution for a given alias and transaction using receipts.

Read more ...


Transfer Transaction

Sending mosaics and messages between two accounts

Define, sign, and announce a transfer transaction.

Read more ...


Sending an encrypted message

Send an encrypted message that only can be read by the recipient account.

Read more ...