Transactions

Transactions are signed, serialized payloads; batched together to form a block.

Endpoints

List All Transactions

The paginated API is used to query for multiple transactions. You can apply filters through the query parameter to search for specific transactions.

Endpoint

GET

Query Parameters

Name page
Description
The number of the page that will be returned.
Required No
Example 1
Name limit
Description
The number of resources per page.
Required No
Example 100
Name offset
Description
The number of resources to be skipped.
Required No
Example
Name transform
Description
The structure of response to be retrieved.
Required No
Example
Name orderBy
Description
The column by which the resources will be sorted.
Required No
Example
Name address
Description
The sender or recipient address of transaction to be retrieved.
Required No
Example
Name senderId
Description
The sender address of transaction to be retrieved.
Required No
Example
Name senderPublicKey
Description
The sender public key of transaction to be retrieved.
Required No
Example
Name recipientId
Description
The recipient address of transaction to be retrieved.
Required No
Example
Name id
Description
The id of transaction to be retrieved.
Required No
Example
Name version
Description
The version of transaction to be retrieved.
Required No
Example
Name blockId
Description
The block id of transaction to be retrieved.
Required No
Example
Name sequence
Description
The sequence of transaction to be retrieved.
Required No
Example
Name sequence.from
Description
The minimum sequence of transaction to be retrieved.
Required No
Example
Name sequence.to
Description
The maximum sequence of transaction to be retrieved.
Required No
Example
Name timestamp
Description
The timestamp of transaction to be retrieved.
Required No
Example
Name timestamp.from
Description
The minimum timestamp of transaction to be retrieved.
Required No
Example
Name timestamp.to
Description
The maximum timestamp of transaction to be retrieved.
Required No
Example
Name nonce
Description
The nonce of transaction to be retrieved.
Required No
Example
Name nonce.from
Description
The minimum nonce of transaction to be retrieved.
Required No
Example
Name nonce.to
Description
The maximum nonce of transaction to be retrieved.
Required No
Example
Name type
Description
The type of transaction to be retrieved.
Required No
Example
Name typeGroup
Description
The typeGroup of transaction to be retrieved.
Required No
Example
Name vendorField
Description
The vendorField of transaction to be retrieved.
Required No
Example
Name amount
Description
The amount of transaction to be retrieved.
Required No
Example
Name amount.from
Description
The minimum amount of transaction to be retrieved.
Required No
Example
Name amount.to
Description
The maximum amount of transaction to be retrieved.
Required No
Example
Name fee
Description
The fee of transaction to be retrieved.
Required No
Example
Name fee.from
Description
The minimum fee of transaction to be retrieved.
Required No
Example
Name fee.to
Description
The maximum fee of transaction to be retrieved.
Required No
Example
Name asset
Description
The asset of transaction to be retrieved.
Required No
Example

Retrieve a Transaction

Obtaining a transaction by ID does not require advanced logic; as the API does not return a serialized transaction, but a nicer DTO .

Endpoint

GET

Path Parameters

Name id
Description
The identifier of the transaction to be retrieved.
Required No
Example

List All Unconfirmed Transaction

Unconfirmed transactions have not been incorporated in the blockchain, but reside in the mempool. Although usually the mempool is cleared within minutes, during high network load a transaction with a low fee will live here for a considerable time. If you have set the transaction with a fee of near zero, it might not be picked up by a Delegate and will time out.

Endpoint

GET

Query Parameters

Name page
Description
The number of the page that will be returned.
Required No
Example 1
Name limit
Description
The number of resources per page.
Required No
Example 100
Name offset
Description
The number of resources to be skipped.
Required No
Example
Name transform
Description
The structure of response to be retrieved.
Required No
Example
Name orderBy
Description
The column by which the resources will be sorted.
Required No
Example

Get an Unconfirmed Transaction

As with confirmed transactions, you may query for unconfirmed transactions directly.

Endpoint

GET

Path Parameters

Name id
Description
The identifier of the transaction to be retrieved.
Required No
Example

Broadcast Transactions

Creating the correct payload for a transaction is non-trivial, as it requires cryptographic functions and a specific serialization protocol. Our crypto SDKs provide the functionality needed in most major programming languages. You can read more about it in the send transaction section.

Endpoint

POST

Body Parameters

Name transactions
Description
The list of transactions to broadcast.
Required No
Example

Get Transaction Fees (Non-Dynamic)

The static transaction fees are significantly higher than the dynamic transaction fees. Use the node resource to find dynamic fees, and prefer using these.

Endpoint

GET

Get Transaction Types

The transaction types are network specific. ARK currently supports eight different types, but BridgeChains may define more or less if needed for their business purpose.

Endpoint

GET

Get Transaction Schemas

Get transaction schemas.

Endpoint

GET
2021 © ARK.io | All rights reserved An ARK.io Product