Skip to main content
API docs by Redocly

Kadesh Chain (1.0.0)

Download OpenAPI specification:Download

License: Apache 2.0

Kadesh Chain

Kadesh Chain Documentation

Account routes

Search accounts

Gets an array of accounts.

query Parameters
pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

orderBy
string (AccountOrderByEnum)
Enum: "id" "balance"

Sort responses by the property set. If balance option is selected, the request must define the mosaicId filter.

mosaicId
string <hex> (MosaicId)
Example: mosaicId=0DC67FBE1CAD29E3

Filter by mosaic identifier.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get accounts information

Returns the account information for an array of accounts.

Request Body schema: application/json
optional
publicKeys
Array of strings <hex> (PublicKey) [ items <hex > ]

Array of public keys.

addresses
Array of strings (Address)

Array of addresses.

Responses

Request samples

Content type
application/json
{
  • "publicKeys": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get account information

Returns the account information.

path Parameters
accountId
required
string

Account public key or address encoded using a 32-character set.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "account": {
    }
}

Get account merkle information

Returns the account merkle information.

path Parameters
accountId
required
string

Account public key or address encoded using a 32-character set.

Responses

Response samples

Content type
application/json
{
  • "raw": "00008080DA9B4AF63BE985715EA635AF98E3CF3B0A22F9A2BE1C7DD40B79948AA63E36586E5D2E9D0C089C1C64BC0D42A11ADBD1CD6CDB4B7C294062F55113525A64AE3CFF3F04A7F2A487B42EA89323C4408F82415223ACFEC7DFA7924EFC31A70778AB17A00C3EAFF635F01BB3B474F0AF1BE99FBDA85EEFB209CC7BD158D3540DE3A3F2D1",
  • "tree": [
    ]
}

Block routes

Search blocks

Gets an array of bocks.

query Parameters
signerPublicKey
string <hex> (PublicKey)
Example: signerPublicKey=AC1A6E1D8DE5B17D2C6B1293F1CAD3829EEACF38D09311BB3C8E5A880092DE26

Filter by public key of the account signing the entity.

beneficiaryAddress
string (Address)
Example: beneficiaryAddress=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by beneficiary address.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

orderBy
string (BlockOrderByEnum)
Enum: "id" "height"

Sort responses by the property set.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get block information

Gets a block from the chain that has the given height.

path Parameters
height
required
string (Height)
Example: 1

Block height.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "meta": {
    },
  • "block": {
    }
}

Get the merkle path for a given a transaction and block

Returns the merkle path for a transaction included in a block. The merkle path is the minimum number of nodes needed to calculate the merkle root.

Steps to calculate the merkle root:

  1. proofHash = hash (leaf).
  2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows:
  • a) If item.position == left -> proofHash = sha_256(item.hash + proofHash).
  • b) If item.position == right -> proofHash = sha_256(proofHash+ item.hash).
  1. Repeat 2. for every item in the merklePath list.
  2. Compare if the calculated proofHash equals the one recorded in the block header (block.transactionsHash) to verify if the transaction was included in the block.
path Parameters
height
required
string (Height)
Example: 1

Block height.

hash
required
string <hex> (Hash256)
Example: C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810

Transaction hash.

Responses

Response samples

Content type
application/json
{
  • "merklePath": [
    ]
}

Get the merkle path for a given a receipt statement hash and block

Returns the merkle path for a receipt statement or resolution linked to a block. The merkle path is the minimum number of nodes needed to calculate the merkle root.

Steps to calculate the merkle root:

  1. proofHash = hash (leaf).
  2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows:
  • a) If item.position == left -> proofHash = sha_256(item.hash + proofHash).
  • b) If item.position == right -> proofHash = sha_256(proofHash+ item.hash).
  1. Repeat 2. for every item in the merklePath list.
  2. Compare if the calculated proofHash equals the one recorded in the block header (block.receiptsHash) to verify if the statement was linked with the block.
path Parameters
height
required
string (Height)
Example: 1

Block height.

hash
required
string <hex> (Hash256)
Example: C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810

Receipt hash.

Responses

Response samples

Content type
application/json
{
  • "merklePath": [
    ]
}

Chain routes

Get the current information of the chain

Returns the current information of the blockchain.

The higher the score, the better the chain. During synchronization, nodes try to get the best blockchain in the network.

The score for a block is derived from its difficulty and the time (in seconds) that has elapsed since the last block:

block score = difficulty − time elapsed since last block

Responses

Response samples

Content type
application/json
{
  • "height": 1,
  • "scoreHigh": 1683298087010368300,
  • "scoreLow": 1683298087010368300,
  • "latestFinalizedBlock": {
    }
}

Finalization routes

Get finalization proof

Gets finalization proof for the greatest height associated with the given epoch.

path Parameters
epoch
required
integer <int64> (FinalizationEpoch)
Example: 123456

Finalization epoch.

Responses

Response samples

Content type
application/json
{
  • "version": 0,
  • "finalizationEpoch": 123456,
  • "finalizationPoint": 0,
  • "height": 1,
  • "hash": "C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810",
  • "messageGroups": [
    ]
}

Get finalization proof

Gets finalization proof at the given height.

path Parameters
height
required
string (Height)
Example: 1

Block height.

Responses

Response samples

Content type
application/json
{
  • "version": 0,
  • "finalizationEpoch": 123456,
  • "finalizationPoint": 0,
  • "height": 1,
  • "hash": "C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810",
  • "messageGroups": [
    ]
}

Metadata routes

Search metadata entries

Returns an array of metadata.

query Parameters
sourceAddress
string (Address)
Example: sourceAddress=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by address sending the metadata entry.

targetAddress
string (Address)
Example: targetAddress=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by target address.

scopedMetadataKey
string <hex> (MetadataKey)
Example: scopedMetadataKey=0DC67FBE1CAD29E3

Filter by metadata key.

targetId
string <hex>
Example: targetId=0DC67FBE1CAD29E3

Filter by namespace or mosaic id.

metadataType
integer (MetadataTypeEnum)
Enum: 0 1 2

Filter by metadata type.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get metadata information

Gets the metadata for a given composite hash.

path Parameters
compositeHash
required
string <hex> (Hash256)
Example: C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810

Filter by composite hash.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "metadataEntry": {
    }
}

Get metadata merkle information

Gets the metadata merkle for a given composite hash.

path Parameters
compositeHash
required
string <hex> (Hash256)
Example: C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810

Filter by composite hash.

Responses

Response samples

Content type
application/json
{
  • "raw": "00008080DA9B4AF63BE985715EA635AF98E3CF3B0A22F9A2BE1C7DD40B79948AA63E36586E5D2E9D0C089C1C64BC0D42A11ADBD1CD6CDB4B7C294062F55113525A64AE3CFF3F04A7F2A487B42EA89323C4408F82415223ACFEC7DFA7924EFC31A70778AB17A00C3EAFF635F01BB3B474F0AF1BE99FBDA85EEFB209CC7BD158D3540DE3A3F2D1",
  • "tree": [
    ]
}

Mosaic routes

Get mosaic information

Gets the mosaic definition for a given mosaic identifier.

path Parameters
mosaicId
required
string <hex> (MosaicId)
Example: 0DC67FBE1CAD29E3

Mosaic identifier.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "mosaic": {
    }
}

Get mosaic merkle information

Gets the mosaic definition merkle for a given mosaic identifier.

path Parameters
mosaicId
required
string <hex> (MosaicId)
Example: 0DC67FBE1CAD29E3

Mosaic identifier.

Responses

Response samples

Content type
application/json
{
  • "raw": "00008080DA9B4AF63BE985715EA635AF98E3CF3B0A22F9A2BE1C7DD40B79948AA63E36586E5D2E9D0C089C1C64BC0D42A11ADBD1CD6CDB4B7C294062F55113525A64AE3CFF3F04A7F2A487B42EA89323C4408F82415223ACFEC7DFA7924EFC31A70778AB17A00C3EAFF635F01BB3B474F0AF1BE99FBDA85EEFB209CC7BD158D3540DE3A3F2D1",
  • "tree": [
    ]
}

Search mosaics

Gets an array of mosaics.

query Parameters
ownerAddress
string (Address)
Example: ownerAddress=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by owner address.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get mosaics information for an array of mosaics

Gets an array of mosaic definition.

Request Body schema: application/json
required
mosaicIds
Array of strings <hex> (MosaicId) [ items <hex > ]

Array of mosaic identifiers.

Responses

Request samples

Content type
application/json
{
  • "mosaicIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Multisig routes

Get multisig account information

Returns the multisig account information.

path Parameters
address
required
string (Address)
Example: TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Account address.

Responses

Response samples

Content type
application/json
{
  • "multisig": {
    }
}

Get multisig account merkle information

Returns the multisig account merkle information.

path Parameters
address
required
string (Address)
Example: TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Account address.

Responses

Response samples

Content type
application/json
{
  • "raw": "00008080DA9B4AF63BE985715EA635AF98E3CF3B0A22F9A2BE1C7DD40B79948AA63E36586E5D2E9D0C089C1C64BC0D42A11ADBD1CD6CDB4B7C294062F55113525A64AE3CFF3F04A7F2A487B42EA89323C4408F82415223ACFEC7DFA7924EFC31A70778AB17A00C3EAFF635F01BB3B474F0AF1BE99FBDA85EEFB209CC7BD158D3540DE3A3F2D1",
  • "tree": [
    ]
}

Get multisig account graph information

Returns the multisig account graph.

path Parameters
address
required
string (Address)
Example: TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Account address.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Namespace routes

Search namespaces

Gets an array of namespaces.

query Parameters
ownerAddress
string (Address)
Example: ownerAddress=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by owner address.

registrationType
integer (NamespaceRegistrationTypeEnum)
Enum: 0 1
Example: registrationType=0

Filter by registration type.

level0
string <hex> (NamespaceId)
Example: level0=85BBEA6CC462B244

Filter by root namespace.

aliasType
integer (AliasTypeEnum)
Enum: 0 1 2
Example: aliasType=0

Filter by alias type.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get namespace information

Gets the namespace for a given namespace identifier.

path Parameters
namespaceId
required
string <hex> (NamespaceId)
Example: 85BBEA6CC462B244

Namespace identifier.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "meta": {
    },
  • "namespace": {
    }
}

Get namespace merkle information

Gets the namespace merkle for a given namespace identifier.

path Parameters
namespaceId
required
string <hex> (NamespaceId)
Example: 85BBEA6CC462B244

Namespace identifier.

Responses

Response samples

Content type
application/json
{
  • "raw": "00008080DA9B4AF63BE985715EA635AF98E3CF3B0A22F9A2BE1C7DD40B79948AA63E36586E5D2E9D0C089C1C64BC0D42A11ADBD1CD6CDB4B7C294062F55113525A64AE3CFF3F04A7F2A487B42EA89323C4408F82415223ACFEC7DFA7924EFC31A70778AB17A00C3EAFF635F01BB3B474F0AF1BE99FBDA85EEFB209CC7BD158D3540DE3A3F2D1",
  • "tree": [
    ]
}

Get readable names for a set of namespaces

Returns friendly names for namespaces.

Request Body schema: application/json
required
namespaceIds
Array of strings <hex> (NamespaceId) [ items <hex > ]

Array of namespace identifiers.

Responses

Request samples

Content type
application/json
{
  • "namespaceIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get readable names for a set of accountIds

Returns friendly names for accounts.

Request Body schema: application/json
required
addresses
Array of strings (Address)

Array of addresses.

Responses

Request samples

Content type
application/json
{
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "accountNames": [
    ]
}

Get readable names for a set of mosaics

Returns friendly names for mosaics.

Request Body schema: application/json
required
mosaicIds
Array of strings <hex> (MosaicId) [ items <hex > ]

Array of mosaic identifiers.

Responses

Request samples

Content type
application/json
{
  • "mosaicIds": [
    ]
}

Response samples

Content type
application/json
{
  • "mosaicNames": [
    ]
}

Network routes

Get the current network type of the chain

Returns the current network type.

Responses

Response samples

Content type
application/json
{
  • "name": "testnet",
  • "description": "catapult public test network"
}

Get rental fees information

Returns the estimated effective rental fees for namespaces and mosaics. This endpoint is only available if the REST instance has access to catapult-server resources/config-network.properties file. To activate this feature, add the setting "network.propertiesFilePath" in the configuration file (rest/resources/rest.json).

Responses

Response samples

Content type
application/json
{
  • "effectiveRootNamespaceRentalFeePerBlock": "123456",
  • "effectiveChildNamespaceRentalFee": "123456",
  • "effectiveMosaicRentalFee": "123456"
}

Get transaction fees information

Returns the average, median, highest and lower fee multiplier over the last "numBlocksTransactionFeeStats". The setting "numBlocksTransactionFeeStats" is adjustable via the configuration file (rest/resources/rest.json) per REST instance.

Responses

Response samples

Content type
application/json
{
  • "averageFeeMultiplier": 0,
  • "medianFeeMultiplier": 0,
  • "highestFeeMultiplier": 0,
  • "lowestFeeMultiplier": 0,
  • "minFeeMultiplier": 0
}

Get the network properties

Returns the content from a catapult-server network configuration file (resources/config-network.properties). To enable this feature, the REST setting "network.propertiesFilePath" must define where the file is located. This is adjustable via the configuration file (rest/resources/rest.json) per REST instance.

Responses

Response samples

Content type
application/json
{
  • "network": {
    },
  • "chain": {
    },
  • "plugins": {
    }
}

Node routes

Get the node health information

Supplies information regarding the connection and services status.

Responses

Response samples

Content type
application/json
{
  • "status": {
    }
}

Get the node information

Supplies additional information about the application running on a node.

Responses

Response samples

Content type
application/json
{
  • "version": 0,
  • "publicKey": "AC1A6E1D8DE5B17D2C6B1293F1CAD3829EEACF38D09311BB3C8E5A880092DE26",
  • "networkGenerationHashSeed": "C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810",
  • "roles": 7,
  • "port": 7900,
  • "networkIdentifier": 144,
  • "friendlyName": "api-node-0",
  • "host": "127.0.0.1",
  • "nodePublicKey": "AC1A6E1D8DE5B17D2C6B1293F1CAD3829EEACF38D09311BB3C8E5A880092DE26"
}

Get peers information

Gets the list of peers visible by the node.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the storage information of the node

Returns storage information about the node.

Responses

Response samples

Content type
application/json
{
  • "numBlocks": 245053,
  • "numTransactions": 58590,
  • "numAccounts": 177
}

Get the node time

Gets the node time at the moment the reply was sent and received.

Responses

Response samples

Content type
application/json
{
  • "communicationTimestamps": {
    }
}

Get the version of the running REST component

Returns the version of the running catapult-rest component.

Responses

Response samples

Content type
application/json
{
  • "serverInfo": {
    }
}

Get the unlocked harvesting account public keys.

Returns array of unlocked account public keys.

Responses

Response samples

Content type
application/json
{
  • "unlockedAccount": [
    ]
}

Restriction Mosaic routes

Search mosaic restrictions

Returns an array of mosaic restrictions.

query Parameters
mosaicId
string <hex> (MosaicId)
Example: mosaicId=0DC67FBE1CAD29E3

Filter by mosaic identifier.

entryType
integer (MosaicRestrictionEntryTypeEnum)
Enum: 0 1

Filter by entry type.

targetAddress
string (Address)
Example: targetAddress=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by target address.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get the mosaic restrictions

Returns the mosaic restrictions for a composite hash.

path Parameters
compositeHash
required
string <hex> (Hash256)
Example: C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810

Filter by composite hash.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "mosaicRestrictionEntry": {
    }
}

Get the mosaic restrictions merkle

Returns the mosaic restrictions merkle for a given composite hash.

path Parameters
compositeHash
required
string <hex> (Hash256)
Example: C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810

Filter by composite hash.

Responses

Response samples

Content type
application/json
{
  • "raw": "00008080DA9B4AF63BE985715EA635AF98E3CF3B0A22F9A2BE1C7DD40B79948AA63E36586E5D2E9D0C089C1C64BC0D42A11ADBD1CD6CDB4B7C294062F55113525A64AE3CFF3F04A7F2A487B42EA89323C4408F82415223ACFEC7DFA7924EFC31A70778AB17A00C3EAFF635F01BB3B474F0AF1BE99FBDA85EEFB209CC7BD158D3540DE3A3F2D1",
  • "tree": [
    ]
}

Restriction Account routes

Search account restrictions

Returns an array of account restrictions.

query Parameters
address
string (Address)
Example: address=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with recipientAddress and signerPublicKey query params.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get the account restrictions

Returns the account restrictions for a given address.

path Parameters
address
required
string (Address)
Example: TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Account address.

Responses

Response samples

Content type
application/json
{
  • "accountRestrictions": {
    }
}

Get the account restrictions merkle

Returns the account restrictions merkle for a given address.

path Parameters
address
required
string (Address)
Example: TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Account address.

Responses

Response samples

Content type
application/json
{
  • "raw": "00008080DA9B4AF63BE985715EA635AF98E3CF3B0A22F9A2BE1C7DD40B79948AA63E36586E5D2E9D0C089C1C64BC0D42A11ADBD1CD6CDB4B7C294062F55113525A64AE3CFF3F04A7F2A487B42EA89323C4408F82415223ACFEC7DFA7924EFC31A70778AB17A00C3EAFF635F01BB3B474F0AF1BE99FBDA85EEFB209CC7BD158D3540DE3A3F2D1",
  • "tree": [
    ]
}

Receipt routes

Search transaction statements

Gets an array of transaction statements.

query Parameters
height
string (Height)
Example: height=1

Filter by block height.

fromHeight
string (Height)
Example: fromHeight=1

Only blocks with height greater or equal than this one are returned.

toHeight
string (Height)
Example: toHeight=1

Only blocks with height smaller or equal than this one are returned.

receiptType
Array of integers (ReceiptTypeEnum)
Items Enum: 4685 4942 8515 8776 9032 8786 9042 12616 12626 16717 16718 16974 20803 57667 61763 62019

Filter by receipt type. To filter by multiple receipt types, add more filter query params like: receiptType=8515&receiptType=20803.

recipientAddress
string (Address)
Example: recipientAddress=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by address of the account receiving the transaction.

senderAddress
string (Address)
Example: senderAddress=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by address sending mosaics.

targetAddress
string (Address)
Example: targetAddress=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by target address.

artifactId
string

Mosaic or namespace identifier

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get receipts address resolution statements

Gets an array of address resolution statements.

query Parameters
height
string (Height)
Example: height=1

Filter by block height.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get receipts mosaic resolution statements

Gets an array of mosaic resolution statements.

query Parameters
height
string (Height)
Example: height=1

Filter by block height.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Transaction routes

Announce a new transaction

Announces a transaction to the network. The catbuffer library defines the protocol to serialize and deserialize Symbol entities. Catbuffers are integrated into Symbol SDKs. It's recommended to use SDKs instead of calling the API endpoint directly to announce transactions.

Request Body schema: application/json
required
payload
string

Transaction payload in hexadecimal format.

Responses

Request samples

Content type
application/json
{
  • "payload": "00112233445566778899AABBCCDDEEFF"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Search confirmed transactions

Returns an array of confirmed transactions. If a transaction was announced with an alias rather than an address, the address that will be considered when querying is the one that was resolved from the alias at confirmation time.

query Parameters
address
string (Address)
Example: address=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with recipientAddress and signerPublicKey query params.

recipientAddress
string (Address)
Example: recipientAddress=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by address of the account receiving the transaction.

signerPublicKey
string <hex> (PublicKey)
Example: signerPublicKey=AC1A6E1D8DE5B17D2C6B1293F1CAD3829EEACF38D09311BB3C8E5A880092DE26

Filter by public key of the account signing the entity.

height
string (Height)
Example: height=1

Filter by block height.

fromHeight
string (Height)
Example: fromHeight=1

Only blocks with height greater or equal than this one are returned.

toHeight
string (Height)
Example: toHeight=1

Only blocks with height smaller or equal than this one are returned.

fromTransferAmount
string (Amount)
Example: fromTransferAmount=123456

Requires providing the transferMosaicId filter. Only transfer transactions with a transfer amount of the provided mosaic id, greater or equal than this amount are returned.

toTransferAmount
string (Amount)
Example: toTransferAmount=123456

Requires providing the transferMosaicId filter. Only transfer transactions with a transfer amount of the provided mosaic id, lesser or equal than this amount are returned.

type
Array of integers (TransactionTypeEnum)
Items Enum: 16716 16963 16707 16972 16705 16961 16717 16973 17229 16718 16974 17230 16708 16964 17220 16725 16712 16722 16978 16720 16976 17232 16721 16977 16724

Filter by transaction type. To filter by multiple transaction types, add more filter query params like: type=16974&type=16718.

embedded
boolean
Default: false

When true, the endpoint also returns all the embedded aggregate transactions. Otherwise, only top-level transactions used to calculate the block transactionsHash are returned. Note: This field does not work when combined with the address parameter. This is, embedded transactions containing the address specified through the address parameter will not be returned even when used with embedded=true. There is no problem when using other parameters like recipientAddress instead.

transferMosaicId
string <hex> (MosaicId)
Example: transferMosaicId=0DC67FBE1CAD29E3

Filters transactions involving a specific mosaicId.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get confirmed trasactions information

Returns confirmed transactions information for a given array of transactionIds.

Request Body schema: application/json
required
transactionIds
Array of strings

Array of transaction identifiers.

Responses

Request samples

Content type
application/json
{
  • "transactionIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get confirmed transaction information

Returns confirmed transaction information given a transactionId or hash.

path Parameters
transactionId
required
string

Transaction id or hash.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "meta": {
    },
  • "transaction": {
    }
}

Search unconfirmed transactions

Returns an array of unconfirmed transactions.

query Parameters
address
string (Address)
Example: address=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with recipientAddress and signerPublicKey query params.

recipientAddress
string (Address)
Example: recipientAddress=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by address of the account receiving the transaction.

signerPublicKey
string <hex> (PublicKey)
Example: signerPublicKey=AC1A6E1D8DE5B17D2C6B1293F1CAD3829EEACF38D09311BB3C8E5A880092DE26

Filter by public key of the account signing the entity.

height
string (Height)
Example: height=1

Filter by block height.

fromHeight
string (Height)
Example: fromHeight=1

Only blocks with height greater or equal than this one are returned.

toHeight
string (Height)
Example: toHeight=1

Only blocks with height smaller or equal than this one are returned.

fromTransferAmount
string (Amount)
Example: fromTransferAmount=123456

Requires providing the transferMosaicId filter. Only transfer transactions with a transfer amount of the provided mosaic id, greater or equal than this amount are returned.

toTransferAmount
string (Amount)
Example: toTransferAmount=123456

Requires providing the transferMosaicId filter. Only transfer transactions with a transfer amount of the provided mosaic id, lesser or equal than this amount are returned.

type
Array of integers (TransactionTypeEnum)
Items Enum: 16716 16963 16707 16972 16705 16961 16717 16973 17229 16718 16974 17230 16708 16964 17220 16725 16712 16722 16978 16720 16976 17232 16721 16977 16724

Filter by transaction type. To filter by multiple transaction types, add more filter query params like: type=16974&type=16718.

embedded
boolean
Default: false

When true, the endpoint also returns all the embedded aggregate transactions. Otherwise, only top-level transactions used to calculate the block transactionsHash are returned. Note: This field does not work when combined with the address parameter. This is, embedded transactions containing the address specified through the address parameter will not be returned even when used with embedded=true. There is no problem when using other parameters like recipientAddress instead.

transferMosaicId
string <hex> (MosaicId)
Example: transferMosaicId=0DC67FBE1CAD29E3

Filters transactions involving a specific mosaicId.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get unconfirmed trasactions information

Returns unconfirmed transactions information for a given array of transactionIds.

Request Body schema: application/json
required
transactionIds
Array of strings

Array of transaction identifiers.

Responses

Request samples

Content type
application/json
{
  • "transactionIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get unconfirmed transaction information

Returns unconfirmed transaction information given a transactionId or hash.

path Parameters
transactionId
required
string

Transaction id or hash.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "meta": {
    },
  • "transaction": {
    }
}

Search partial transactions

Returns an array of partial transactions.

query Parameters
address
string (Address)
Example: address=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with recipientAddress and signerPublicKey query params.

recipientAddress
string (Address)
Example: recipientAddress=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by address of the account receiving the transaction.

signerPublicKey
string <hex> (PublicKey)
Example: signerPublicKey=AC1A6E1D8DE5B17D2C6B1293F1CAD3829EEACF38D09311BB3C8E5A880092DE26

Filter by public key of the account signing the entity.

height
string (Height)
Example: height=1

Filter by block height.

fromHeight
string (Height)
Example: fromHeight=1

Only blocks with height greater or equal than this one are returned.

toHeight
string (Height)
Example: toHeight=1

Only blocks with height smaller or equal than this one are returned.

fromTransferAmount
string (Amount)
Example: fromTransferAmount=123456

Requires providing the transferMosaicId filter. Only transfer transactions with a transfer amount of the provided mosaic id, greater or equal than this amount are returned.

toTransferAmount
string (Amount)
Example: toTransferAmount=123456

Requires providing the transferMosaicId filter. Only transfer transactions with a transfer amount of the provided mosaic id, lesser or equal than this amount are returned.

type
Array of integers (TransactionTypeEnum)
Items Enum: 16716 16963 16707 16972 16705 16961 16717 16973 17229 16718 16974 17230 16708 16964 17220 16725 16712 16722 16978 16720 16976 17232 16721 16977 16724

Filter by transaction type. To filter by multiple transaction types, add more filter query params like: type=16974&type=16718.

embedded
boolean
Default: false

When true, the endpoint also returns all the embedded aggregate transactions. Otherwise, only top-level transactions used to calculate the block transactionsHash are returned. Note: This field does not work when combined with the address parameter. This is, embedded transactions containing the address specified through the address parameter will not be returned even when used with embedded=true. There is no problem when using other parameters like recipientAddress instead.

transferMosaicId
string <hex> (MosaicId)
Example: transferMosaicId=0DC67FBE1CAD29E3

Filters transactions involving a specific mosaicId.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Announce an aggregate bonded transaction

Announces an aggregate bonded transaction to the network.

Request Body schema: application/json
required
payload
string

Transaction payload in hexadecimal format.

Responses

Request samples

Content type
application/json
{
  • "payload": "00112233445566778899AABBCCDDEEFF"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Get partial trasactions information

Returns partial transactions information for a given array of transactionIds.

Request Body schema: application/json
required
transactionIds
Array of strings

Array of transaction identifiers.

Responses

Request samples

Content type
application/json
{
  • "transactionIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get partial transaction information

Returns partial transaction information given a transactionId or hash.

path Parameters
transactionId
required
string

Transaction id or hash.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "meta": {
    },
  • "transaction": {
    }
}

Announce a cosignature transaction

Announces a cosignature transaction to the network.

Request Body schema: application/json
required
parentHash
string <hex> (Hash256)
signature
string (Signature)

Entity's signature generated by the signer.

signerPublicKey
string <hex> (PublicKey)

Public key.

version
string (CosignatureVersion)

Cosignature version.

Responses

Request samples

Content type
application/json
{
  • "parentHash": "C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810",
  • "signature": "4B408BBEDF25F2AC8E0E44A6E51E3CCBA03885902055F75EB9FF50433532CA44BF9175FDA7502EEE2FC1617126E453A2BD692BAFDAAF06BC8EDEBA7961B3730D",
  • "signerPublicKey": "AC1A6E1D8DE5B17D2C6B1293F1CAD3829EEACF38D09311BB3C8E5A880092DE26",
  • "version": "0"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Hash Lock routes

Search hash lock entries

Returns an array of hash locks.

query Parameters
address
string (Address)
Example: address=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with recipientAddress and signerPublicKey query params.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get hash lock information

Gets the hash lock for a given hash.

path Parameters
hash
required
string <hex> (Hash256)
Example: C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810

Filter by hash.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "lock": {
    }
}

Get hash lock merkle information

Gets the hash lock merkle for a given hash.

path Parameters
hash
required
string <hex> (Hash256)
Example: C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810

Filter by hash.

Responses

Response samples

Content type
application/json
{
  • "raw": "00008080DA9B4AF63BE985715EA635AF98E3CF3B0A22F9A2BE1C7DD40B79948AA63E36586E5D2E9D0C089C1C64BC0D42A11ADBD1CD6CDB4B7C294062F55113525A64AE3CFF3F04A7F2A487B42EA89323C4408F82415223ACFEC7DFA7924EFC31A70778AB17A00C3EAFF635F01BB3B474F0AF1BE99FBDA85EEFB209CC7BD158D3540DE3A3F2D1",
  • "tree": [
    ]
}

Secret Lock routes

Search secret lock entries

Returns an array of secret locks.

query Parameters
address
string (Address)
Example: address=TADP6C2GVEG654OP5LZI32P2GYJSCMEGQBYB7QY

Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with recipientAddress and signerPublicKey query params.

secret
string <hex> (Secret)
Example: secret=FB8558E82C1968A3536CD77ACD7F9BC65E8B8F346714C9F91B42D6C2177BEDC1

Filter by secret.

pageSize
integer [ 10 .. 100 ]
Default: 10

Select the number of entries to return.

pageNumber
integer >= 1
Default: 1

Filter by page number.

offset
string

Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned.

order
string (Order)
Default: "desc"
Enum: "asc" "desc"

Sort responses in ascending or descending order based on the collection property set on the param orderBy. If the request does not specify orderBy, REST returns the collection ordered by id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get secret lock information

Gets the hash lock for a given composite hash.

path Parameters
compositeHash
required
string <hex> (Hash256)
Example: C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810

Filter by composite hash.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "lock": {
    }
}

Get secret lock merkle information

Gets the hash lock merkle for a given composite hash.

path Parameters
compositeHash
required
string <hex> (Hash256)
Example: C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810

Filter by composite hash.

Responses

Response samples

Content type
application/json
{
  • "raw": "00008080DA9B4AF63BE985715EA635AF98E3CF3B0A22F9A2BE1C7DD40B79948AA63E36586E5D2E9D0C089C1C64BC0D42A11ADBD1CD6CDB4B7C294062F55113525A64AE3CFF3F04A7F2A487B42EA89323C4408F82415223ACFEC7DFA7924EFC31A70778AB17A00C3EAFF635F01BB3B474F0AF1BE99FBDA85EEFB209CC7BD158D3540DE3A3F2D1",
  • "tree": [
    ]
}

Transaction status routes

Get transaction statuses

Returns an array of transaction statuses for a given array of transaction hashes.

Request Body schema: application/json
required
hashes
Array of strings <hex> (Hash256) [ items <hex > ]

Array of transaction hashes.

Responses

Request samples

Content type
application/json
{
  • "hashes": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get transaction status

Returns the transaction status for a given hash.

path Parameters
hash
required
string <hex> (Hash256)
Example: C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810

Transaction hash.

Responses

Response samples

Content type
application/json
{
  • "group": "unconfirmed",
  • "code": "Success",
  • "hash": "C8FC3FB54FDDFBCE0E8C71224990124E4EEC5AD5D30E592EDFA9524669A23810",
  • "deadline": 200,
  • "height": 1
}