REST API
Retrieve info about messages using REST Queries
Last updated
Retrieve info about messages using REST Queries
Last updated
The Hyperlane agents collect useful information about activity on the system, including all messages. That data can be queried via the APIs.
The APIs are currently available free of charge and without any required authentication.
Action: get-message
, Parameter (1 required):
id
: message id (string)
sender
: address of message sender (string)
recipient
: address of message recipient (string)
origin-tx-hash
: hash of origin transaction (string)
origin-tx-sender
: address of origin tx sender (string)
destination-tx-hash
: hash of destination transaction (string)
destination-tx-sender
: address of destination tx sender (string)
Action: get-status
Parameter (1 required):
Same as get-message above
Action: search-messages
, Parameter (1 required):
query
: address or hash to search (string)
Hyperlane can be to any chain, but messages on PI chains cannot be identified by the default Hyperlane agents. To view details about messages from PI chains, query the search-pi-messages
action. The search requires a chain config in the request body. Note, this same functionality is also available in the .
The chain config schema is an extension of the Hyperlane SDK's but with a contracts
object added. See for more details about this config object.