Wormholescan API
Wormhole Guardian API This is the API for the Wormhole Guardian and Explorer. The API has two namespaces: wormholescan and guardian. wormholescan is the namespace for the explorer and the new endpoints. The prefix is /api/v1. guardian is the legacy namespace backguard compatible with guardian node API. The prefix is /v1. This API is public and does not require authentication although some endpoints are rate limited. Check each endpoint documentation for more information.
Version: 1.0
Terms of service
Contact information: API Support https://discord.com/invite/wormholecrypto [email protected]
License: Apache 2.0
/api/v1/address/:address
GET
Description
Lookup an address
Parameters
address
path
address
Yes
string
page
query
Page number. Starts at 0.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
/api/v1/global-tx/:chain_id/:emitter/:seq
GET
Description
Find a global transaction by VAA ID Global transactions is a logical association of two transactions that are related to each other by a unique VAA ID. The first transaction is created on the origin chain when the VAA is emitted. The second transaction is created on the destination chain when the VAA is redeemed. If the response only contains an origin tx the VAA was not redeemed.
Parameters
chain_id
path
id of the blockchain
Yes
integer
emitter
path
address of the emitter
Yes
string
seq
path
sequence of the VAA
Yes
integer
Responses
/api/v1/governor/config
GET
Description
Returns governor configuration for all guardians.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
/api/v1/governor/config/:guardian_address
GET
Description
Returns governor configuration for a given guardian.
Responses
/api/v1/governor/enqueued_vaas/
GET
Description
Returns enqueued VAAs for each blockchain.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
sortOrder
query
Sort results in ascending or descending order.
No
string
Responses
/api/v1/governor/enqueued_vaas/:chain
GET
Description
Returns all enqueued VAAs for a given blockchain.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
sortOrder
query
Sort results in ascending or descending order.
No
string
Responses
/api/v1/governor/limit
GET
Description
Returns the governor limit for all blockchains.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
/api/v1/governor/notional/available
GET
Description
Returns the amount of notional value available for each blockchain.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
sortOrder
query
Sort results in ascending or descending order.
No
string
Responses
/api/v1/governor/notional/available/:chain
GET
Description
Returns the amount of notional value available for a given blockchain.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
/api/v1/governor/notional/limit
GET
Description
Returns the detailed notional limit for all blockchains.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
/api/v1/governor/notional/limit/:chain
GET
Description
Returns the detailed notional limit available for a given blockchain.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
/api/v1/governor/notional/max_available/:chain
GET
Description
Returns the maximum amount of notional value available for a given blockchain.
Responses
/api/v1/governor/status
GET
Description
Returns the governor status for all guardians.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
/api/v1/governor/status/:guardian_address
GET
Description
Returns the governor status for a given guardian.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
/api/v1/health
GET
Description
Health check
Responses
200
OK
{ "status": string }
400
Bad Request
500
Internal Server Error
/api/v1/last-txs
GET
Description
Returns the number of transactions by a defined time span and sample rate.
Parameters
timeSpan
query
Time Span, default: 1d, supported values: [1d, 1w, 1mo]. 1mo ​​is 30 days.
No
string
sampleRate
query
Sample Rate, default: 1h, supported values: [1h, 1d]. Valid configurations with timeSpan: 1d/1h, 1w/1d, 1mo/1d
No
string
Responses
/api/v1/observations
GET
Description
Returns all observations, sorted in descending timestamp order.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
sortOrder
query
Sort results in ascending or descending order.
No
string
Responses
/api/v1/observations/:chain
GET
Description
Returns all observations for a given blockchain, sorted in descending timestamp order.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
sortOrder
query
Sort results in ascending or descending order.
No
string
Responses
/api/v1/observations/:chain/:emitter
GET
Description
Returns all observations for a specific emitter address, sorted in descending timestamp order.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
sortOrder
query
Sort results in ascending or descending order.
No
string
Responses
/api/v1/observations/:chain/:emitter/:sequence
GET
Description
Find observations identified by emitter chain, emitter address and sequence.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
sortOrder
query
Sort results in ascending or descending order.
No
string
Responses
/api/v1/observations/:chain/:emitter/:sequence/:signer/:hash
GET
Description
Find a specific observation.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
sortOrder
query
Sort results in ascending or descending order.
No
string
Responses
/api/v1/operations
GET
Description
Find all operations.
Parameters
address
query
address of the emitter
No
string
txHash
query
hash of the transaction
No
string
page
query
page number
No
integer
pageSize
query
pageSize
No
integer
sourceChain
query
source chains of the operation, separated by comma
No
string
targetChain
query
target chains of the operation, separated by comma
No
string
appId
query
appID of the operation
No
string
exclusiveAppId
query
single appId of the operation
No
boolean
Responses
/api/v1/operations/{chain_id}/{emitter}/{seq}
GET
Description
Find operations by ID (chainID/emitter/sequence).
Parameters
chain_id
path
id of the blockchain
Yes
integer
emitter
path
address of the emitter
Yes
string
seq
path
sequence of the VAA
Yes
integer
Responses
/api/v1/protocols/stats
GET
Description
Returns the representative stats for the top protocols
Responses
/api/v1/ready
GET
Description
Ready check
Responses
200
OK
{ "ready": string }
400
Bad Request
500
Internal Server Error
/api/v1/relays/:chain/:emitter/:sequence
GET
Description
Get a specific relay information by chainID, emitter address and sequence.
Responses
/api/v1/scorecards
GET
Description
Returns a list of KPIs for Wormhole. TVL is total value locked by token bridge contracts in USD. Volume is the all-time total volume transferred through the token bridge in USD. 24h volume is the volume transferred through the token bridge in the last 24 hours, in USD. Total Tx count is the number of transaction bridging assets since the creation of the network (does not include Pyth or other messages). 24h tx count is the number of transaction bridging assets in the last 24 hours (does not include Pyth or other messages). Total messages is the number of VAAs emitted since the creation of the network (includes Pyth messages).
Responses
500
Internal Server Error
/api/v1/token/:chain_id/:token_address
GET
Description
Returns a token symbol, coingecko id and address by chain and token address.
Parameters
chain_id
path
id of the blockchain
Yes
integer
token_address
path
token address
Yes
string
Responses
/api/v1/top-100-corridors
GET
Description
Returns a list of the top 100 tokens, sorted in descending order by the number of transactions.
Parameters
timeSpan
query
Time span, supported values: 2d and 7d (default is 2d).
No
string
Responses
/api/v1/top-assets-by-volume
GET
Description
Returns a list of emitter_chain and asset pairs with ordered by volume. The volume is calculated using the notional price of the symbol at the day the VAA was emitted.
Parameters
timeSpan
query
Time span, supported values: 7d, 15d, 30d.
Yes
string
Responses
500
Internal Server Error
/api/v1/top-chain-pairs-by-num-transfers
GET
Description
Returns a list of the emitter_chain and destination_chain pair ordered by transfer count.
Parameters
timeSpan
query
Time span, supported values: 7d, 15d, 30d.
Yes
string
Responses
500
Internal Server Error
/api/v1/top-symbols-by-volume
GET
Description
Returns a list of symbols by origin chain and tokens. The volume is calculated using the notional price of the symbol at the day the VAA was emitted.
Parameters
timeSpan
query
Time span, supported values: 7d, 15d and 30d (default is 7d).
No
string
Responses
/api/v1/transactions/
GET
Description
Returns transactions. Output is paginated.
Parameters
page
query
Page number. Starts at 0.
No
integer
pageSize
query
Number of elements per page.
No
integer
sortOrder
query
Sort results in ascending or descending order.
No
string
address
query
Filter transactions by Address.
No
string
Responses
/api/v1/transactions/:chain_id/:emitter/:seq
GET
Description
Find VAA metadata by ID.
Parameters
chain_id
path
id of the blockchain
Yes
integer
emitter
path
address of the emitter
Yes
string
seq
path
sequence of the VAA
Yes
integer
Responses
/api/v1/vaas/
GET
Description
Returns all VAAs. Output is paginated and can also be be sorted.
Parameters
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
sortOrder
query
Sort results in ascending or descending order.
No
string
txHash
query
Transaction hash of the VAA
No
string
parsedPayload
query
include the parsed contents of the VAA, if available
No
boolean
appId
query
filter by application ID
No
string
Responses
/api/v1/vaas/:chain_id
GET
Description
Returns all the VAAs generated in specific blockchain.
Parameters
chain_id
path
id of the blockchain
Yes
integer
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
sortOrder
query
Sort results in ascending or descending order.
No
string
Responses
/api/v1/vaas/:chain_id/:emitter
GET
Description
Returns all all the VAAs generated by a specific emitter address.
Parameters
chain_id
path
id of the blockchain
Yes
integer
emitter
path
address of the emitter
Yes
string
toChain
query
destination chain
No
integer
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
sortOrder
query
Sort results in ascending or descending order.
No
string
Responses
/api/v1/vaas/:chain_id/:emitter/:seq
GET
Description
Find a VAA by ID.
Parameters
chain_id
path
id of the blockchain
Yes
integer
emitter
path
address of the emitter
Yes
string
seq
path
sequence of the VAA
Yes
integer
parsedPayload
query
include the parsed contents of the VAA, if available
No
boolean
Responses
/api/v1/vaas/:chain_id/:emitter/:seq/duplicated
GET
Description
Find duplicated VAA by ID.
Parameters
chain_id
path
id of the blockchain
Yes
integer
emitter
path
address of the emitter
Yes
string
seq
path
sequence of the VAA
Yes
integer
Responses
/api/v1/vaas/parse
POST
Description
Parse a VAA.
Responses
400
Bad Request
404
Not Found
500
Internal Server Error
/api/v1/vaas/vaa-counts
GET
Description
Returns the total number of VAAs emitted for each blockchain.
Responses
/api/v1/version
GET
Description
Get version/release information.
Responses
/api/v1/x-chain-activity
GET
Description
Returns a list of chain pairs by origin chain and destination chain. The list could be rendered by notional or transaction count. The volume is calculated using the notional price of the symbol at the day the VAA was emitted.
Parameters
timeSpan
query
Time span, supported values: 7d, 30d, 90d, 1y and all-time (default is 7d).
No
string
by
query
Renders the results using notional or tx count (default is notional).
No
string
apps
query
List of apps separated by comma (default is all apps).
No
string
Responses
/api/v1/x-chain-activity/tops
GET
Description
Search for a specific period of time the number of transactions and the volume.
Parameters
timespan
query
Time span, supported values: 1d, 1mo and 1y
Yes
string
from
query
From date, supported format 2006-01-02T15:04:05Z07:00
Yes
string
to
query
To date, supported format 2006-01-02T15:04:05Z07:00
Yes
string
appId
query
Search by appId
No
string
sourceChain
query
Search by sourceChain
No
string
targetChain
query
Search by targetChain
No
string
Responses
/swagger.json
GET
Description
Returns the swagger specification for this API.
Responses
200
OK
object
400
Bad Request
500
Internal Server Error
/v1/governor/available_notional_by_chain
GET
Description
Get available notional by chainID Since from the wormhole-explorer point of view it is not a node, but has the information of all nodes, in order to build the endpoints it was assumed: There are N number of remainingAvailableNotional values in the GovernorConfig collection. N = number of guardians for a chainID. The smallest remainingAvailableNotional value for a chainID is used for the endpoint response.
Responses
/v1/governor/enqueued_vaas
GET
Description
Get enqueued VAAs
Responses
/v1/governor/is_vaa_enqueued/:chain_id/:emitter/:seq
GET
Description
Check if vaa is enqueued
Parameters
chain_id
path
id of the blockchain
Yes
integer
emitter
path
address of the emitter
Yes
string
seq
path
sequence of the vaa
Yes
integer
Responses
/v1/governor/token_list
GET
Description
Get token list Since from the wormhole-explorer point of view it is not a node, but has the information of all nodes, in order to build the endpoints it was assumed: For tokens with the same originChainId and originAddress and different price values for each node, the price that has most occurrences in all the nodes for an originChainId and originAddress is returned.
Responses
/v1/guardianset/current
GET
Description
Get current guardian set.
Responses
/v1/heartbeats
GET
Description
Get heartbeats for guardians
Responses
/v1/signed_batch_vaa/:chain_id/:emitter/sequence/:seq
GET
Description
get a batch of VAA []byte from a chainID, emitter address and sequence.
Parameters
chain_id
path
id of the blockchain
Yes
integer
emitter
path
address of the emitter
Yes
string
seq
path
sequence of the VAA
Yes
integer
Responses
200
OK
{ "vaaBytes": [ integer ] }
400
Bad Request
500
Internal Server Error
/v1/signed_vaa/:chain_id/:emitter/:seq
GET
Description
get a VAA []byte from a chainID, emitter address and sequence.
Parameters
chain_id
path
id of the blockchain
Yes
integer
emitter
path
address of the emitter
Yes
string
seq
path
sequence of the VAA
Yes
integer
Responses
200
OK
{ "vaaBytes": [ integer ] }
400
Bad Request
500
Internal Server Error
Models
address.AddressOverview
github_com_wormhole-foundation_wormhole-explorer_api_routes_guardian_guardian.GuardianSet
addresses
[ string ]
No
index
integer
No
governor.AvailableNotionalItemResponse
bigTransactionSize
string
No
notionalLimit
string
No
remainingAvailableNotional
string
No
governor.AvailableNotionalResponse
governor.Emitter
governor.EnqueuedVAA
notionalValue
integer
No
releaseTime
string
No
sequence
string
No
txHash
string
No
governor.EnqueuedVaa
governor.EnqueuedVaaDetail
emitterAddress
string
No
notionalValue
integer
No
releaseTime
integer
No
sequence
string
No
txHash
string
No
governor.EnqueuedVaaItemResponse
emitterAddress
string
No
notionalValue
string
No
releaseTime
integer
No
sequence
integer
No
txHash
string
No
governor.EnqueuedVaaResponse
governor.EnqueuedVaas
governor.GovConfig
counter
integer
No
createdAt
string
No
id
string
No
nodeName
string
No
updatedAt
string
No
governor.GovConfigChains
governor.GovConfigfTokens
originAddress
string
No
originChainId
integer
No
price
number
No
governor.GovStatus
governor.GovStatusChainEmitter
emitterAddress
string
No
enqueuedVaas
No
totalEnqueuedVaas
integer
No
governor.GovStatusChains
governor.GovernorLimit
governor.MaxNotionalAvailableRecord
availableNotional
integer
No
createdAt
string
No
id
string
No
nodeName
string
No
updatedAt
string
No
governor.NotionalAvailable
availableNotional
integer
No
governor.NotionalAvailableDetail
availableNotional
integer
No
createdAt
string
No
id
string
No
nodeName
string
No
updatedAt
string
No
governor.NotionalLimitDetail
createdAt
string
No
id
string
No
maxTransactionSize
integer
No
nodeName
string
No
notionalLimit
integer
No
updatedAt
string
No
governor.TokenList
guardian.GuardianSetResponse
heartbeats.HeartbeatNetworkResponse
contractAddress
string
No
errorCount
string
No
height
string
No
id
integer
No
heartbeats.HeartbeatResponse
heartbeats.HeartbeatsResponse
heartbeats.RawHeartbeat
bootTimestamp
string
No
counter
string
No
features
[ string ]
No
guardianAddr
string
No
nodeName
string
No
timestamp
string
No
version
string
No
infrastructure.VersionResponse
branch
string
No
build
string
No
build_date
string
No
machine
string
No
user
string
No
observations.ObservationDoc
emitterAddr
string
No
guardianAddr
string
No
hash
[ integer ]
No
id
string
No
indexedAt
string
No
sequence
string
No
signature
[ integer ]
No
txHash
[ integer ]
No
updatedAt
string
No
operations.Content
payload
object
No
operations.Data
type
string
No
value
object
No
operations.EmitterAddress
hex
string
No
native
string
No
operations.OperationResponse
data
object
No
id
string
No
sequence
string
No
operations.SourceChain
from
string
No
status
string
No
timestamp
string
No
operations.StandardizedProperties
amount
string
No
appIds
[ string ]
No
fee
string
No
feeAddress
string
No
fromAddress
string
No
toAddress
string
No
tokenAddress
string
No
operations.TargetChain
from
string
No
status
string
No
timestamp
string
No
to
string
No
operations.Transaction
secondTxHash
string
No
txHash
string
No
operations.Vaa
guardianSetIndex
integer
No
isDuplicated
boolean
No
raw
[ integer ]
No
parser.ParseVaaWithStandarizedPropertiesdResponse
parsedPayload
No
parser.StandardizedProperties
amount
string
No
appIds
[ string ]
No
fee
string
No
feeAddress
string
No
fromAddress
string
No
toAddress
string
No
tokenAddress
string
No
protocols.ProtocolTotalValuesDTO
error
string
No
last_day_diff_percentage
string
No
last_day_messages
integer
No
protocol
string
No
total_messages
integer
No
total_value_locked
number
No
total_value_secured
number
No
total_value_transferred
number
No
relays.DeliveryReponse
budget
string
No
maxRefund
string
No
relayGasUsed
integer
No
targetChainDecimals
integer
No
relays.InstructionsResponse
encodedExecutionInfo
string
No
extraReceiverValue
{ "_hex": string, "_isBigNumber": boolean }
No
refundAddress
string
No
refundChainId
integer
No
refundDeliveryProvider
string
No
requestedReceiverValue
{ "_hex": string, "_isBigNumber": boolean }
No
senderAddress
string
No
sourceDeliveryProvider
string
No
targetAddress
string
No
targetChainId
integer
No
vaaKeys
[ ]
No
relays.RelayDataResponse
fromTxHash
string
No
maxAttempts
integer
No
toTxHash
string
No
relays.RelayResponse
completedAt
string
No
failedAt
string
No
id
string
No
receivedAt
string
No
relayer
string
No
status
string
No
relays.ResultExecutionResponse
detail
string
No
gasUsed
string
No
refundStatus
string
No
revertString
string
No
status
string
No
transactionHash
string
No
response.Response-address_AddressOverview
response.Response-array_governor_EnqueuedVaaDetail
response.Response-array_governor_EnqueuedVaas
response.Response-array_governor_GovStatus
response.Response-array_governor_GovernorLimit
response.Response-array_governor_NotionalAvailable
response.Response-array_governor_NotionalAvailableDetail
response.Response-array_governor_NotionalLimitDetail
response.Response-array_vaa_VaaDoc
response.Response-array_vaa_VaaStats
response.Response-governor_GovConfig
response.Response-governor_GovStatus
response.Response-governor_MaxNotionalAvailableRecord
response.ResponsePagination
next
string
No
stats.TokenResult
stats.TopCorridor
token_address
string
No
txs
integer
No
stats.TopCorridorsResult
stats.TopSymbolByVolumeResult
stats.TopSymbolResult
transactions.AssetWithVolume
transactions.AttributeDoc
type
string
No
value
object
No
transactions.ChainActivity
transactions.ChainActivityTopResult
count
integer
No
destination_chain
string
No
emitter_chain
string
No
from
string
No
to
string
No
volume
integer
No
transactions.ChainPair
transactions.Destination
chain
integer
No
percentage
number
No
volume
number
No
transactions.DestinationTx
blockNumber
string
No
from
string
No
method
string
No
status
string
No
timestamp
string
No
to
string
No
txHash
string
No
updatedAt
string
No
transactions.GlobalTransactionDoc
transactions.ListTransactionsResponse
transactions.OriginTx
transactions.ScorecardsResponse
24h_messages
string
Number of VAAs emitted in the last 24 hours (includes Pyth messages).
No
24h_tx_count
string
Number of VAAs emitted in the last 24 hours (does not include Pyth messages).
No
24h_volume
string
Volume transferred through the token bridge in the last 24 hours, in USD.
No
total_messages
string
Number of VAAs emitted since the creation of the network (includes Pyth messages).
No
total_tx_count
string
Number of VAAs emitted since the creation of the network (does not include Pyth messages)
No
total_volume
string
No
tvl
string
Total value locked in USD.
No
transactions.Token
coingeckoId
string
No
decimals
integer
No
symbol
string
No
transactions.TopAssetsResponse
transactions.TopChainPairsResponse
transactions.TransactionCountResult
count
integer
No
time
string
No
transactions.TransactionDetail
emitterAddress
string
EmitterAddress contains the VAA's emitter address, encoded in hex.
No
emitterNativeAddress
string
EmitterNativeAddress contains the VAA's emitter address, encoded in the emitter chain's native format.
No
id
string
No
payload
object
No
standardizedProperties
object
No
symbol
string
No
timestamp
string
No
tokenAmount
string
No
txHash
string
No
usdAmount
string
No
transactions.Tx
vaa.ChainID
vaa.ChainID
integer
vaa.VaaDoc
appId
string
AppId is an extension field - it is not present in the guardian API.
No
digest
string
No
emitterAddr
string
No
emitterNativeAddr
string
No
guardianSetIndex
integer
No
id
string
No
indexedAt
string
No
isDuplicated
boolean
No
payload
object
Payload is an extension field - it is not present in the guardian API.
No
timestamp
string
No
txHash
string
TxHash is an extension field - it is not present in the guardian API.
No
updatedAt
string
No
vaa
[ integer ]
No
version
integer
No
vaa.VaaStats
count
integer
No
Last updated
Was this helpful?