IBC-GO - gRPC Gateway docs
v1.0.0https://axelar.nownodes.ioA REST interface for state queries
Authentication
api-keyAuthapiKeyAPI Key: api-key in header
API Reference
Core
Channels queries all the IBC channels of a chain.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
pagination.keystring<byte>querykey is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offsetstring<uint64>queryoffset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limitstring<uint64>querylimit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_totalboolean<boolean>querycount_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverseboolean<boolean>queryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response
Channel queries an IBC Channel.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
Response
A successful response.
An unexpected error response
ChannelClientState queries for the client state for the channel associated with the provided channel identifiers.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
Response
A successful response.
An unexpected error response
ChannelConsensusState queries for the consensus state for the channel associated with the provided channel identifiers.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
revision_numberstring<uint64>requiredpathrevision number of the consensus state
revision_heightstring<uint64>requiredpathrevision height of the consensus state
Response
A successful response.
An unexpected error response
NextSequenceReceive returns the next receive sequence for a given channel.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
Response
A successful response.
An unexpected error response
PacketAcknowledgements returns all the packet acknowledgements associated with a channel.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
pagination.keystring<byte>querykey is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offsetstring<uint64>queryoffset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limitstring<uint64>querylimit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_totalboolean<boolean>querycount_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverseboolean<boolean>queryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
packet_commitment_sequencesArray<string>querylist of packet sequences.
Response
A successful response.
An unexpected error response
PacketAcknowledgement queries a stored packet acknowledgement hash.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
sequencestring<uint64>requiredpathpacket sequence
Response
A successful response.
An unexpected error response
PacketCommitments returns all the packet commitments hashes associated with a channel.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
pagination.keystring<byte>querykey is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offsetstring<uint64>queryoffset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limitstring<uint64>querylimit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_totalboolean<boolean>querycount_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverseboolean<boolean>queryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response
UnreceivedAcks returns all the unreceived IBC acknowledgements associated with a channel and sequences.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
packet_ack_sequencesArray<string>requiredpathlist of acknowledgement sequences
Response
A successful response.
An unexpected error response
UnreceivedPackets returns all the unreceived IBC packets associated with a channel and sequences.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
packet_commitment_sequencesArray<string>requiredpathlist of packet sequences
Response
A successful response.
An unexpected error response
PacketCommitment queries a stored packet commitment hash.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
sequencestring<uint64>requiredpathpacket sequence
Response
A successful response.
An unexpected error response
PacketReceipt queries if a given packet sequence has been received on the queried chain
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
sequencestring<uint64>requiredpathpacket sequence
Response
A successful response.
An unexpected error response
ConnectionChannels queries all the channels associated with a connection end.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
connectionstringrequiredpathconnection unique identifier
pagination.keystring<byte>querykey is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offsetstring<uint64>queryoffset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limitstring<uint64>querylimit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_totalboolean<boolean>querycount_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverseboolean<boolean>queryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response
ClientStates queries all the IBC light clients of a chain.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
pagination.keystring<byte>querykey is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offsetstring<uint64>queryoffset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limitstring<uint64>querylimit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_totalboolean<boolean>querycount_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverseboolean<boolean>queryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response
ClientState queries an IBC light client.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
client_idstringrequiredpathclient state unique identifier
Response
A successful response.
An unexpected error response
Status queries the status of an IBC client.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
client_idstringrequiredpathclient unique identifier
Response
A successful response.
An unexpected error response
ConsensusStates queries all the consensus state associated with a given client.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
client_idstringrequiredpathclient identifier
pagination.keystring<byte>querykey is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offsetstring<uint64>queryoffset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limitstring<uint64>querylimit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_totalboolean<boolean>querycount_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverseboolean<boolean>queryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response
ConsensusStateHeights queries the height of every consensus states associated with a given client.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
client_idstringrequiredpathclient identifier
pagination.keystring<byte>querykey is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offsetstring<uint64>queryoffset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limitstring<uint64>querylimit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_totalboolean<boolean>querycount_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverseboolean<boolean>queryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response
ConsensusState queries a consensus state associated with a client state at a given height.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
client_idstringrequiredpathclient identifier
revision_numberstring<uint64>requiredpathconsensus state revision number
revision_heightstring<uint64>requiredpathconsensus state revision height
latest_heightboolean<boolean>querylatest_height overrrides the height field and queries the latest stored ConsensusState.
Response
A successful response.
An unexpected error response
UpgradedClientState queries an Upgraded IBC light client.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Response
A successful response.
An unexpected error response
UpgradedConsensusState queries an Upgraded IBC consensus state.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Response
A successful response.
An unexpected error response
ClientConnections queries the connection paths associated with a client state.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
client_idstringrequiredpathclient identifier associated with a connection
Response
A successful response.
An unexpected error response
Connections queries all the IBC connections of a chain.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
pagination.keystring<byte>querykey is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offsetstring<uint64>queryoffset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limitstring<uint64>querylimit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_totalboolean<boolean>querycount_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverseboolean<boolean>queryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response
Connection queries an IBC connection end.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
connection_idstringrequiredpathconnection unique identifier
Response
A successful response.
An unexpected error response
ConnectionClientState queries the client state associated with the connection.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
connection_idstringrequiredpathconnection identifier
Response
A successful response.
An unexpected error response
ConnectionConsensusState queries the consensus state associated with the connection.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
connection_idstringrequiredpathconnection identifier
revision_numberstring<uint64>requiredpathrevision_heightstring<uint64>requiredpathResponse
A successful response.
An unexpected error response
Client
ClientParams queries all parameters of the ibc client.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Response
A successful response.
An unexpected error response
Apps
EscrowAddress returns the escrow address for a particular port and channel id.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
channel_idstringrequiredpathunique channel identifier
port_idstringrequiredpathunique port identifier
Response
A successful response.
An unexpected error response
DenomHash queries a denomination hash information.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
tracestringrequiredpathThe denomination trace ([port_id]/[channel_id])+/[denom]
Response
A successful response.
An unexpected error response
DenomTraces queries all denomination traces.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
pagination.keystring<byte>querykey is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.
pagination.offsetstring<uint64>queryoffset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.
pagination.limitstring<uint64>querylimit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.
pagination.count_totalboolean<boolean>querycount_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.
pagination.reverseboolean<boolean>queryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response
DenomTrace queries a denomination trace information.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
hashstringrequiredpathhash (in hex format) or denom (full denom with ibc prefix) of the denomination trace information.
Response
A successful response.
An unexpected error response
Params queries all parameters of the ibc-transfer module.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Response
A successful response.
An unexpected error response