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
​https://wormhole.com/​
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
Name
Located in
Description
Required
Schema
address
path
address
Yes
string
page
query
Page number. Starts at 0.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-github_com_wormhole-foundation_wormhole-explorer_api_handlers_address_AddressOverview​
400
Bad Request
​
404
Not Found
​
500
Internal Server Error
​
/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
Name
Located in
Description
Required
Schema
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
Code
Description
Schema
200
OK
​routes_wormscan_transactions.Tx​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/governor/config
GET
Description
Returns governor configuration for all guardians.
Parameters
Name
Located in
Description
Required
Schema
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-github_com_wormhole-foundation_wormhole-explorer_api_handlers_governor_GovConfig​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/governor/config/:guardian_address
GET
Description
Returns governor configuration for a given guardian.
Responses
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-github_com_wormhole-foundation_wormhole-explorer_api_handlers_governor_GovConfig​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/governor/enqueued_vaas/
GET
Description
Returns enqueued VAAs for each blockchain.
Parameters
Name
Located in
Description
Required
Schema
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
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-array_github_com_wormhole-foundation_wormhole-explorer_api_handlers_governor_EnqueuedVaas​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/governor/enqueued_vaas/:chain
GET
Description
Returns all enqueued VAAs for a given blockchain.
Parameters
Name
Located in
Description
Required
Schema
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
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-array_github_com_wormhole-foundation_wormhole-explorer_api_handlers_governor_EnqueuedVaaDetail​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/governor/limit
GET
Description
Returns the governor limit for all blockchains.
Parameters
Name
Located in
Description
Required
Schema
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-array_github_com_wormhole-foundation_wormhole-explorer_api_handlers_governor_GovernorLimit​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/governor/notional/available
GET
Description
Returns the amount of notional value available for each blockchain.
Parameters
Name
Located in
Description
Required
Schema
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
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-array_github_com_wormhole-foundation_wormhole-explorer_api_handlers_governor_NotionalAvailable​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/governor/notional/available/:chain
GET
Description
Returns the amount of notional value available for a given blockchain.
Parameters
Name
Located in
Description
Required
Schema
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-array_github_com_wormhole-foundation_wormhole-explorer_api_handlers_governor_NotionalAvailableDetail​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/governor/notional/limit
GET
Description
Returns the detailed notional limit for all blockchains.
Parameters
Name
Located in
Description
Required
Schema
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-array_github_com_wormhole-foundation_wormhole-explorer_api_handlers_governor_NotionalLimitDetail​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/governor/notional/limit/:chain
GET
Description
Returns the detailed notional limit available for a given blockchain.
Parameters
Name
Located in
Description
Required
Schema
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-array_github_com_wormhole-foundation_wormhole-explorer_api_handlers_governor_NotionalLimitDetail​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/governor/notional/max_available/:chain
GET
Description
Returns the maximum amount of notional value available for a given blockchain.
Responses
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-github_com_wormhole-foundation_wormhole-explorer_api_handlers_governor_MaxNotionalAvailableRecord​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/governor/status
GET
Description
Returns the governor status for all guardians.
Parameters
Name
Located in
Description
Required
Schema
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-array_github_com_wormhole-foundation_wormhole-explorer_api_handlers_governor_GovStatus​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/governor/status/:guardian_address
GET
Description
Returns the governor status for a given guardian.
Parameters
Name
Located in
Description
Required
Schema
page
query
Page number.
No
integer
pageSize
query
Number of elements per page.
No
integer
Responses
Code
Description
Schema
200
OK
​github_com_wormhole-foundation_wormhole-explorer_api_response.Response-github_com_wormhole-foundation_wormhole-explorer_api_handlers_governor_GovStatus​
400
Bad Request
​
500
Internal Server Error
​
/api/v1/health
GET
Description
Health check
Responses
Code
Description
Schema
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
Name
Located in
Description
Required
Schema
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
Code
Description
Schema
200
OK
[ github_com_wormhole-foundation_wormhole-explorer_api_handlers_transactions.TransactionCountResult ]
400
Bad Request
​
500
Internal Server Error
​
/api/v1/observations
GET
Description
Returns all observations, sorted in descending timestamp order.
Parameters
Name
Located in
Description
Required
Schema
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
Code
Description
Schema
200
OK
[ github_com_wormhole-foundation_wormhole-explorer_api_handlers_observations.ObservationDoc ]
400
Bad Request
​
500
Internal Server Error
​
/api/v1/observations/:chain
GET
Description
Returns all observations for a given blockchain, sorted in descending timestamp order.
Parameters
Name
Located in
Description
Required
Schema
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
Code
Description
Schema
200
OK
[ github_com_wormhole-foundation_wormhole-explorer_api_handlers_observations.ObservationDoc ]
400
Bad Request
​
500
Internal Server Error
​
/api/v1/observations/:chain/:emitter
GET
Description
Returns all observations for a specific emitter address, sorted in descending timestamp order.
Parameters
Name
Located in
Description
Required
Schema
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
Code
Description
Schema
200
OK
[ github_com_wormhole-foundation_wormhole-explorer_api_handlers_observations.ObservationDoc ]
400
Bad Request
​
500
Internal Server Error
​
/api/v1/observations/:chain/:emitter/:sequence
GET
Description
Find observations identified by emitter chain, emitter address and sequence.
Parameters
Name
Located in
Description
Required
Schema
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
Code
Description
Schema
200
OK
[ github_com_wormhole-foundation_wormhole-explorer_api_handlers_observations.ObservationDoc ]
400
Bad Request
​
500
Internal Server Error
​

Name	Located in	Description	Required	Schema
address	path	address	Yes	string
page	query	Page number. Starts at 0.	No	integer
pageSize	query	Number of elements per page.	No	integer

Code	Description	Schema
200	OK	github_com_wormhole-foundation_wormhole-explorer_api_response.Response-github_com_wormhole-foundation_wormhole-explorer_api_handlers_address_AddressOverview
400	Bad Request
404	Not Found
500	Internal Server Error

Name	Located in	Description	Required	Schema
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

Code	Description	Schema
200	OK	routes_wormscan_transactions.Tx
400	Bad Request
500	Internal Server Error

Name	Located in	Description	Required	Schema
page	query	Page number.	No	integer
pageSize	query	Number of elements per page.	No	integer

Code	Description	Schema
200	OK	{ "status": string }
400	Bad Request
500	Internal Server Error

Name	Located in	Description	Required	Schema
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

Code	Description	Schema
200	OK	[ github_com_wormhole-foundation_wormhole-explorer_api_handlers_transactions.TransactionCountResult ]
400	Bad Request
500	Internal Server Error