AvaCloud Metrics API
Data-lake-powered aggregated metrics for Avalanche chains — EVM chain performance, throughput, staking information, L1 validator metrics and Looking Glass analytics. Public/unauthenticated.
OpenAPI Specification
openapi: 3.1.0
paths:
/v2/health-check:
get:
operationId: metrics-health-check
x-speakeasy-name-override: healthCheck
x-execution-weight: free
x-speakeasy-group: metrics
summary: Get the health of the service
x-codeSamples:
- lang: javascript
label: JavaScript
source: |-
import { Avalanche } from "@avalanche-sdk/chainkit";
const avalanche = new Avalanche();
async function run() {
const result = await avalanche.metrics.healthCheck();
console.log(result);
}
run();
description: Check the health of the service.
responses:
'200':
description: The health of the service
content:
application/json:
schema:
$ref: '#/components/schemas/HealthCheckResultDto'
'400':
description: |-
Bad requests generally mean the client has passed invalid
or malformed parameters. Error messages in the response could help in
evaluating the error.
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: |-
When a client attempts to access resources that require
authorization credentials but the client lacks proper authentication
in the request, the server responds with 401.
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: |-
When a client attempts to access resources with valid
credentials but doesn't have the privilege to perform that action,
the server responds with 403.
content:
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: |-
The error is mostly returned when the client requests
with either mistyped URL, or the passed resource is moved or deleted,
or the resource doesn't exist.
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: |-
This error is returned when the client has sent too many,
and has hit the rate limit.
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
'500':
description: |-
The error is a generic server side error that is
returned for any uncaught and unexpected issues on the server side.
This should be very rare, and you may reach out to us if the problem
persists for a longer duration.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
'502':
description: |-
This is an internal error indicating invalid response
received by the client-facing proxy or gateway from the upstream server.
content:
application/json:
schema:
$ref: '#/components/schemas/BadGateway'
'503':
description: |-
The error is returned for certain routes on a particular
Subnet. This indicates an internal problem with our Subnet node, and may
not necessarily mean the Subnet is down or affected.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailable'
tags:
- Health Check
/v2/chains:
get:
operationId: listChains
x-speakeasy-name-override: list
x-speakeasy-pagination:
type: cursor
inputs:
- name: pageToken
in: parameters
type: cursor
outputs:
nextCursor: $.nextPageToken
x-execution-weight: free
x-speakeasy-group: metrics.chains
x-codeSamples:
- lang: javascript
label: JavaScript
source: |-
import { Avalanche } from "@avalanche-sdk/chainkit";
const avalanche = new Avalanche();
async function run() {
const result = await avalanche.metrics.chains.list({
network: "mainnet",
});
for await (const page of result) {
console.log(page);
}
}
run();
summary: Get a list of supported blockchains
description: >-
Get a list of Metrics API supported blockchains. This endpoint is
paginated and supports a maximum page size of 10000.
parameters:
- name: pageToken
required: false
in: query
description: >-
A page token, received from a previous list call. Provide this to
retrieve the subsequent page.
schema:
type: string
- name: network
required: false
in: query
description: Either mainnet or testnet/fuji.
example: mainnet
schema:
$ref: '#/components/schemas/Network'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListChainsResponse'
'400':
description: |-
Bad requests generally mean the client has passed invalid
or malformed parameters. Error messages in the response could help in
evaluating the error.
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: |-
When a client attempts to access resources that require
authorization credentials but the client lacks proper authentication
in the request, the server responds with 401.
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: |-
When a client attempts to access resources with valid
credentials but doesn't have the privilege to perform that action,
the server responds with 403.
content:
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: |-
The error is mostly returned when the client requests
with either mistyped URL, or the passed resource is moved or deleted,
or the resource doesn't exist.
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: |-
This error is returned when the client has sent too many,
and has hit the rate limit.
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
'500':
description: |-
The error is a generic server side error that is
returned for any uncaught and unexpected issues on the server side.
This should be very rare, and you may reach out to us if the problem
persists for a longer duration.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
'502':
description: |-
This is an internal error indicating invalid response
received by the client-facing proxy or gateway from the upstream server.
content:
application/json:
schema:
$ref: '#/components/schemas/BadGateway'
'503':
description: |-
The error is returned for certain routes on a particular
Subnet. This indicates an internal problem with our Subnet node, and may
not necessarily mean the Subnet is down or affected.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailable'
tags:
- EVM Chains
/v2/chains/{chainId}:
get:
operationId: getChain
x-speakeasy-name-override: get
x-execution-weight: free
x-speakeasy-group: metrics.chains
summary: Get chain information for supported blockchain
x-codeSamples:
- lang: javascript
label: JavaScript
source: |-
import { Avalanche } from "@avalanche-sdk/chainkit";
const avalanche = new Avalanche({
chainId: "43114",
});
async function run() {
const result = await avalanche.metrics.chains.get({});
console.log(result);
}
run();
description: Get chain information for Metrics API supported blockchain.
parameters:
- name: chainId
required: true
in: path
description: >-
A supported evm chain id. Use the `/chains` endpoint to get a list
of supported chain ids.
example: '43114'
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Chain'
'400':
description: |-
Bad requests generally mean the client has passed invalid
or malformed parameters. Error messages in the response could help in
evaluating the error.
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: |-
When a client attempts to access resources that require
authorization credentials but the client lacks proper authentication
in the request, the server responds with 401.
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: |-
When a client attempts to access resources with valid
credentials but doesn't have the privilege to perform that action,
the server responds with 403.
content:
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: |-
The error is mostly returned when the client requests
with either mistyped URL, or the passed resource is moved or deleted,
or the resource doesn't exist.
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: |-
This error is returned when the client has sent too many,
and has hit the rate limit.
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
'500':
description: |-
The error is a generic server side error that is
returned for any uncaught and unexpected issues on the server side.
This should be very rare, and you may reach out to us if the problem
persists for a longer duration.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
'502':
description: |-
This is an internal error indicating invalid response
received by the client-facing proxy or gateway from the upstream server.
content:
application/json:
schema:
$ref: '#/components/schemas/BadGateway'
'503':
description: |-
The error is returned for certain routes on a particular
Subnet. This indicates an internal problem with our Subnet node, and may
not necessarily mean the Subnet is down or affected.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailable'
tags:
- EVM Chains
/v2/chains/{chainId}/metrics/{metric}:
get:
operationId: getEvmChainMetrics
x-execution-weight: small
x-speakeasy-group: metrics.chains
x-speakeasy-name-override: getMetrics
x-speakeasy-pagination:
type: cursor
inputs:
- name: pageToken
in: parameters
type: cursor
outputs:
nextCursor: $.nextPageToken
x-codeSamples:
- lang: javascript
label: JavaScript
source: |-
import { Avalanche } from "@avalanche-sdk/chainkit";
const avalanche = new Avalanche({
chainId: "43114",
});
async function run() {
const result = await avalanche.metrics.chains.getMetrics({
metric: "activeAddresses",
startTimestamp: 1689541049,
endTimestamp: 1689800249,
timeInterval: "day",
pageSize: 10,
});
for await (const page of result) {
console.log(page);
}
}
run();
summary: Get metrics for EVM chains
description: >-
EVM chain metrics are available for all Avalanche L1s on _Mainnet_ and
_Fuji_ (testnet). You can request metrics by EVM chain ID. See the
`/chains` endpoint for all supported chains.
All metrics are updated several times every hour. Each metric data point
has a `value` and `timestamp` (Unix timestamp in seconds). All metric
values include data within the duration of the associated timestamp plus
the requested `timeInterval`. All timestamps are fixed to the hour. When
requesting a timeInterval of **day**, **week**, or **month**, the
timestamp will be 0:00 UTC of the day, Monday of the week, or first day
of the month, respectively. The latest data point in any response may
change on each update.
### Metrics
<ins>activeAddresses</ins>: The number of distinct addresses seen within
the selected `timeInterval` starting at the timestamp. Addresses counted
are those that appear in the “from” and “to” fields of a transaction or
ERC20/ERC721/ERC1155 transfer log event.
<ins>activeSenders</ins>: This metric follows the same structure as
activeAddresses, but instead only counts addresses that appear in the
“from” field of the respective transaction or transfer log event.
<ins>cumulativeTxCount</ins>: The cumulative transaction count from
genesis up until 24 hours after the timestamp. This aggregation can be
considered a “rolling sum” of the transaction count metric (txCount).
Only `timeInterval=day` supported.
<ins>cumulativeAddresses</ins>: The cumulative count of unique addresses
from genesis up until 24 hours after the timestamp. Addresses counted
are those that appear in the “from” and “to” fields of a transaction or
ERC20/ERC721/ERC1155 transfer log event. Only `timeInterval=day`
supported.
<ins>cumulativeContracts</ins>: The cumulative count of contracts
created from genesis up until the timestamp. Contracts are counted by
looking for the CREATE, CREATE2, and CREATE3 call types in all
transaction traces (aka internal transactions). Only `timeInterval=day`
supported.
<ins>cumulativeDeployers</ins>: The cumulative count of unique contract
deployers from genesis up until 24 hours after the timestamp. Deployers
counted are those that appear in the “from” field of transaction traces
with the CREATE, CREATE2, and CREATE3 call types. Only
`timeInterval=day` supported.
<ins>contracts</ins>: The count of contracts created within the
requested timeInterval starting at the timestamp. Contracts are counted
by looking for the CREATE, CREATE2, and CREATE3 call types in all
transaction traces (aka internal transactions). Only `timeInterval=day`
supported.
<ins>deployers</ins>: The count of unique deployers within the requested
timeInterval starting at the timestamp. Deployers counted are those that
appear in the “from” field of transaction traces with the CREATE,
CREATE2, and CREATE3 call types. Only `timeInterval=day` supported.
<ins>gasUsed</ins>: The amount of gas used by transactions within the
requested timeInterval starting at the timestamp.
<ins>txCount</ins>: The amount of transactions within the requested
timeInterval starting at the timestamp.
<ins>avgGps</ins>: The average Gas used Per Second (GPS) within the day
beginning at the timestamp. The average is calculated by taking the sum
of gas used by all blocks within the day and dividing it by the time
interval between the last block of the previous day and the last block
of the day that begins at the timestamp. Only `timeInterval=day`
supported.
<ins>maxGps</ins>: The max Gas used Per Second (GPS) measured within
the day beginning at the timestamp. Each GPS data point is calculated
using the gas used in a single block divided by the time since the last
block. Only `timeInterval=day` supported.
<ins>avgTps</ins>: The average Transactions Per Second (TPS) within the
day beginning at the timestamp. The average is calculated by taking the
sum of transactions within the day and dividing it by the time interval
between the last block of the previous day and the last block of the day
that begins at the timestamp. Only `timeInterval=day` supported.
<ins>maxTps</ins>: The max Transactions Per Second (TPS) measured within
the day beginning at the timestamp. Each TPS data point is calculated by
taking the number of transactions in a single block and dividing it by
the time since the last block. Only `timeInterval=day` supported.
<ins>avgGasPrice</ins>: The average gas price within the day beginning
at the timestamp. The gas price used is the price reported in
transaction receipts. Only `timeInterval=day` supported.
<ins>maxGasPrice</ins>: The max gas price seen within the day beginning
at the timestamp. The gas price used is the price reported in
transaction receipts. Only `timeInterval=day` supported.
<ins>feesPaid</ins>: The sum of transaction fees paid within the day
beginning at the timestamp. The fee is calculated as the gas used
multiplied by the gas price as reported in all transaction receipts.
Only `timeInterval=day` supported.
parameters:
- name: metric
required: true
in: path
description: Which chain level metric to fetch.
example: activeAddresses
schema:
$ref: '#/components/schemas/ChainMetric'
- name: startTimestamp
required: false
in: query
description: Query param for retrieving items after a specific timestamp.
example: 1689541049
schema:
minimum: 0
type: integer
- name: endTimestamp
required: false
in: query
description: Query param for retrieving items before a specific timestamp.
example: 1689800249
schema:
minimum: 0
type: integer
- name: timeInterval
required: false
in: query
description: |-
Time interval granularity for data aggregation. Metrics
prefixed with "cumulative", "max", or "avg" only support timeInterval equal
to "day".
example: day
schema:
$ref: '#/components/schemas/TimeIntervalGranularity'
- name: pageToken
required: false
in: query
description: >-
A page token, received from a previous list call. Provide this to
retrieve the subsequent page.
schema:
type: string
- name: pageSize
required: false
in: query
description: >-
The maximum number of items to return. The minimum page size is 1.
The maximum pageSize is 2160.
schema:
type: integer
default: 100
minimum: 1
maximum: 2160
example: '10'
- name: chainId
required: true
in: path
description: >-
A supported EVM chain ID or one of "total", "mainnet", or "testnet".
Use the `/chains` endpoint to get a list of supported chain IDs.
example: '43114'
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsApiResponse'
'400':
description: |-
Bad requests generally mean the client has passed invalid
or malformed parameters. Error messages in the response could help in
evaluating the error.
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: |-
When a client attempts to access resources that require
authorization credentials but the client lacks proper authentication
in the request, the server responds with 401.
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: |-
When a client attempts to access resources with valid
credentials but doesn't have the privilege to perform that action,
the server responds with 403.
content:
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: |-
The error is mostly returned when the client requests
with either mistyped URL, or the passed resource is moved or deleted,
or the resource doesn't exist.
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: |-
This error is returned when the client has sent too many,
and has hit the rate limit.
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
'500':
description: |-
The error is a generic server side error that is
returned for any uncaught and unexpected issues on the server side.
This should be very rare, and you may reach out to us if the problem
persists for a longer duration.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
'502':
description: |-
This is an internal error indicating invalid response
received by the client-facing proxy or gateway from the upstream server.
content:
application/json:
schema:
$ref: '#/components/schemas/BadGateway'
'503':
description: |-
The error is returned for certain routes on a particular
Subnet. This indicates an internal problem with our Subnet node, and may
not necessarily mean the Subnet is down or affected.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailable'
tags:
- Chain Metrics
/v2/chains/{chainId}/rollingWindowMetrics/{metric}:
get:
operationId: getEvmChainRollingWindowMetrics
x-execution-weight: small
x-speakeasy-group: metrics.chains
x-speakeasy-name-override: getRollingWindowMetrics
summary: Get rolling window metrics for EVM chains
x-codeSamples:
- lang: javascript
label: JavaScript
source: |-
import { Avalanche } from "@avalanche-sdk/chainkit";
const avalanche = new Avalanche({
chainId: "43114",
});
async function run() {
const result = await avalanche.metrics.chains.getRollingWindowMetrics({
metric: "txCount",
});
console.log(result);
}
run();
description: >-
Gets the rolling window metrics for an EVM chain for the last hour, day,
week, month, 90 days, year, and all time. Active addresses/active
senders only support last hour, day, and week.
parameters:
- name: metric
required: true
in: path
description: Which chain level metric to fetch for the rolling window.
example: txCount
schema:
$ref: '#/components/schemas/ChainRollingWindowMetric'
- name: chainId
required: true
in: path
description: >-
A supported EVM chain ID or one of "total", "mainnet", or "testnet".
Use the `/chains` endpoint to get a list of supported chain IDs.
example: '43114'
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/RollingWindowMetricsApiResponse'
'400':
description: |-
Bad requests generally mean the client has passed invalid
or malformed parameters. Error messages in the response could help in
evaluating the error.
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: |-
When a client attempts to access resources that require
authorization credentials but the client lacks proper authentication
in the request, the server responds with 401.
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: |-
When a client attempts to access resources with valid
credentials but doesn't have the privilege to perform that action,
the server responds with 403.
content:
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: |-
The error is mostly returned when the client requests
with either mistyped URL, or the passed resource is moved or deleted,
or the resource doesn't exist.
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: |-
This error is returned when the client has sent too many,
and has hit the rate limit.
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
'500':
description: |-
The error is a generic server side error that is
returned for any uncaught and unexpected issues on the server side.
This should be very rare, and you may reach out to us if the problem
persists for a longer duration.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
'502':
description: |-
This is an internal error indicating invalid response
received by the client-facing proxy or gateway from the upstream server.
content:
application/json:
schema:
$ref: '#/components/schemas/BadGateway'
'503':
description: |-
The error is returned for certain routes on a particular
Subnet. This indicates an internal problem with our Subnet node, and may
not necessarily mean the Subnet is down or affected.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailable'
tags:
- Chain Metrics
/v2/chains/{chainId}/teleporterMetrics/{metric}:
get:
operationId: getTeleporterMetricsByChain
x-execution-weight: small
x-speakeasy-group: metrics.chains
x-speakeasy-name-override: getTeleporterMetrics
description: Gets teleporter metrics for an EVM chain.
deprecated: true
parameters:
- name: metric
required: true
in: path
description: Which chain level teleporter metric to fetch.
example: teleporterSourceTxnCount
schema:
$ref: '#/components/schemas/TeleporterMetric'
- name: chainId
required: true
in: path
description: >-
A supported EVM chain ID or one of "total", "mainnet", or "testnet".
Use the `/chains` endpoint to get a list of supported chain IDs.
example: '43114'
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/TeleporterChainMetricsApiResponse'
'400':
description: |-
Bad requests generally mean the client has passed invalid
or malformed parameters. Error messages in the response could help in
evaluating the error.
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: |-
When a client attempts to access resources that require
authorization credentials but the client lacks proper authentication
in the request, the server responds with 401.
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: |-
When a client attempts to access resources with valid
credentials but doesn't have the privilege to perform that action,
the server responds with 403.
content:
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
'404':
description: |-
The error is mostly returned when the client requests
with either mistyped URL, or the passed resource is moved or deleted,
or the resource doesn't exist.
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'429':
description: |-
This error is returned when the client has sent too many,
and has hit the rate limit.
content:
application/json:
schema:
$ref: '#/component
# --- truncated at 32 KB (302 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ava-labs/refs/heads/main/openapi/ava-labs-metrics-api-openapi.yml