Transactions

HTLC - Hash Time-Locked Contracts transactions enable two parties to exchange tokens safely and securely at the protocol level, removing the need to trust an individual who could potentially be a bad actor and withdraw from a prior agreement once they have received their tokens. Locked funds can be transfer to another party using claim transactions, or refunded to the sender after the HTLC transaction’s expiration.

Endpoints

List Open HTLC Lock transactions

The paginated API is used to query for multiple HTLC Locs 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 orderBy
Description
The column by which the resources will be sorted.
Required No
Example
Name lockId
Description
The lock id 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 isExpired
Description
The expired status of transaction to be retrieved.
Required No
Example
Name expirationType
Description
The expiration type of transaction to be retrieved.
Required No
Example
Name expirationValue
Description
The expiration value of transaction to be retrieved.
Required No
Example
Name expirationValue.from
Description
The minimum expiration value of transaction to be retrieved.
Required No
Example
Name expirationValue.to
Description
The maximum expiration value of transaction to be retrieved.
Required No
Example
Name secretHash
Description
The secret hash 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 timestamp.epoch
Description
The epoch timestamp of the transaction to be retrieved.
Required No
Example
Name timestamp.epoch.from
Description
The minimum epoch timestamp of the transaction to be retrieved.
Required No
Example
Name timestamp.epoch.to
Description
The maximum epoch timestamp of the transaction to be retrieved.
Required No
Example
Name timestamp.unix
Description
The unix timestamp of the transaction to be retrieved.
Required No
Example
Name timestamp.unix.from
Description
The minimum unix timestamp of the transaction to be retrieved.
Required No
Example
Name timestamp.unix.to
Description
The maximum unix timestamp of the transaction to be retrieved.
Required No
Example
Name timestamp.human
Description
The human timestamp of the transaction to be retrieved.
Required No
Example
Name vendorField
Description
The vendorField of transaction to be retrieved.
Required No
Example

Retrieve a HTLC transaction

Specific HTLC transactions can be obtained by its lockId.

Endpoint

GET

Path Parameters

Name id
Description
The lockId of the HTLC to be retrieved.
Required No
Example

List Open HTLC Lock transactions

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

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 offset
Description
The number of resources to be skipped.
Required No
Example
Name orderBy
Description
The column by which the resources will be sorted.
Required No
Example

Body Parameters

Name ids
Description
The ids of locks that will be returned.
Required No
Example
2021 © ARK.io | All rights reserved An ARK.io Product