Home | API

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 type
Description
The transaction type to be retrieved.
Required No
Example
Name blockId
Description
The block id to be retrieved.
Required No
Example
Name id
Description
The transaction id 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

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

Search for Transactions

For fine-grained searches, use the search endpoint. Note that unless you use specific body parameters, the response might contain a large number of transactions (hundreds of thousands). It is best to filter as many transactions node side, instead of dissecting the response client side.

Endpoint

POST

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 orderBy
Description
The number of resources per page.
Required No
Example

Body Parameters

Name id
Description
TODO
Required No
Example
Name timestamp.from
Description
TODO
Required No
Example
Name fee.from
Description
TODO
Required No
Example
Name fee
Description
TODO
Required No
Example
Name amount.to
Description
TODO
Required No
Example
Name amount.from
Description
TODO
Required No
Example
Name amount
Description
TODO
Required No
Example
Name timestamp.to
Description
TODO
Required No
Example
Name timestamp
Description
TODO
Required No
Example
Name blockId
Description
TODO
Required No
Example
Name vendorFieldHex
Description
TODO
Required No
Example
Name ownerId
Description
TODO
Required No
Example
Name recipientId
Description
TODO
Required No
Example
Name senderId
Description
TODO
Required No
Example
Name senderPublicKey
Description
TODO
Required No
Example
Name version
Description
TODO
Required No
Example
Name type
Description
TODO
Required No
Example
Name fee.to
Description
TODO
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

2020 © ARK.io | All rights reserved | An ARK.io Product