Query Parameters

start_time

integer

Specifies the start of the time period for which the usage data is to be retrieved. For periods longer than a week, times are rounded down to midnight UTC for performance optimization.

end_time

integer

Specifies the end of the time period for which the usage data is to be retrieved. For periods longer than a week, times are rounded down to midnight UTC for performance optimization.

Returns

data

object

The data object which contains the following fields:

endpoints

array

An array of endpoints which contains the following fields:

name

string

The name of the endpoint

label

string

A custom label for the endpoint

chain

string

The blockchain associated with the endpoint

status

string

The current state of the RPC endpoint. Possible values include: active, archived, paused or terminated

network

string

The specific network on the blockchain

credits_used

integer

The total number of credits used by the endpoint (RPC credits and data credits combined)

rpc_credits

integer

The portion of credits_used consumed by RPC requests

data_credits

integer

The portion of credits_used consumed by data usage, such as Streams and Yellowstone gRPC bytes transferred

requests

integer

The total number of requests made to the endpoint

bytes

integer

The total number of data bytes transferred by the endpoint (for example, Streams and Yellowstone gRPC data). Contributes to data_credits

methods_breakdown

array

An array of methods_breakdown

method_name

string

The name of the method called. Streaming methods such as /geyser.geyser/subscribe also appear here with the data they transfer

credits_used

integer

The number of credits used by the method (RPC credits and data credits combined)

bytes

integer

The number of data bytes transferred by the method (for streaming methods such as /geyser.geyser/subscribe)

archive

boolean

Indicates whether the request is using archived data

start_time

integer

The start timestamp for the data in second in second

end_time

integer

The end timestamp for the data in second in second

error

string

A field containing an error message if any issue occurs

Request

1
curl -X 'GET' \
2
  'https://api.quicknode.com/v0/usage/rpc/by-endpoint' \
3
  -H 'accept: application/json' \
4
  -H 'x-api-key: YOUR_API_KEY'

1
curl -X 'GET' \
2
  'https://api.quicknode.com/v0/usage/rpc/by-endpoint' \
3
  -H 'accept: application/json' \
4
  -H 'x-api-key: YOUR_API_KEY'

1
const myHeaders = new Headers();
2
myHeaders.append("accept", "application/json");
3
myHeaders.append("x-api-key", "YOUR_API_KEY");
4

5
const requestOptions = {
6
  method: "GET",
7
  headers: myHeaders,
8
  redirect: "follow"
9
};
10

11
fetch("https://api.quicknode.com/v0/usage/rpc/by-endpoint", requestOptions)
12
  .then((response) => response.text())
13
  .then((result) => console.log(result))
14
  .catch((error) => console.error(error));

1
const myHeaders = new Headers();
2
myHeaders.append("accept", "application/json");
3
myHeaders.append("x-api-key", "YOUR_API_KEY");
4

5
const requestOptions = {
6
  method: "GET",
7
  headers: myHeaders,
8
  redirect: "follow"
9
};
10

11
fetch("https://api.quicknode.com/v0/usage/rpc/by-endpoint", requestOptions)
12
  .then((response) => response.text())
13
  .then((result) => console.log(result))
14
  .catch((error) => console.error(error));

1
import requests
2

3
url = "https://api.quicknode.com/v0/usage/rpc/by-endpoint"
4

5
payload = {}
6
headers = {
7
  'accept': 'application/json',
8
  'x-api-key': 'YOUR_API_KEY',
9
}
10

11
response = requests.request("GET", url, headers=headers, data=payload)
12

13
print(response.text)
14

1
import requests
2

3
url = "https://api.quicknode.com/v0/usage/rpc/by-endpoint"
4

5
payload = {}
6
headers = {
7
  'accept': 'application/json',
8
  'x-api-key': 'YOUR_API_KEY',
9
}
10

11
response = requests.request("GET", url, headers=headers, data=payload)
12

13
print(response.text)
14

1
require "uri"
2
require "net/http"
3

4
url = URI("https://api.quicknode.com/v0/usage/rpc/by-endpoint")
5

6
https = Net::HTTP.new(url.host, url.port)
7
https.use_ssl = true
8

9
request = Net::HTTP::Get.new(url)
10
request["accept"] = "application/json"
11
request["x-api-key"] = "YOUR_API_KEY"
12

13
response = https.request(request)
14
puts response.read_body
15

1
require "uri"
2
require "net/http"
3

4
url = URI("https://api.quicknode.com/v0/usage/rpc/by-endpoint")
5

6
https = Net::HTTP.new(url.host, url.port)
7
https.use_ssl = true
8

9
request = Net::HTTP::Get.new(url)
10
request["accept"] = "application/json"
11
request["x-api-key"] = "YOUR_API_KEY"
12

13
response = https.request(request)
14
puts response.read_body
15

1
qn usage by-endpoint --from 7d -o json

1
qn usage by-endpoint --from 7d -o json

1
import { QuicknodeSdk } from "@quicknode/sdk"
2

3
const qn = new QuicknodeSdk({ apiKey: "YOUR_API_KEY" })
4

5
const response = await qn.admin.getUsageByEndpoint()
6
console.log(response)
7

1
import { QuicknodeSdk } from "@quicknode/sdk"
2

3
const qn = new QuicknodeSdk({ apiKey: "YOUR_API_KEY" })
4

5
const response = await qn.admin.getUsageByEndpoint()
6
console.log(response)
7

1
import asyncio
2
from quicknode_sdk import QuicknodeSdk, SdkFullConfig
3

4

5
async def main():
6
    qn = QuicknodeSdk(SdkFullConfig(api_key="YOUR_API_KEY"))
7
    response = await qn.admin.get_usage_by_endpoint()
8
    print(response)
9

10

11
asyncio.run(main())
12

1
import asyncio
2
from quicknode_sdk import QuicknodeSdk, SdkFullConfig
3

4

5
async def main():
6
    qn = QuicknodeSdk(SdkFullConfig(api_key="YOUR_API_KEY"))
7
    response = await qn.admin.get_usage_by_endpoint()
8
    print(response)
9

10

11
asyncio.run(main())
12

1
require "quicknode_sdk"
2

3
qn = QuicknodeSdk::SDK.from_config(api_key: "YOUR_API_KEY")
4

5
response = qn.admin.get_usage_by_endpoint
6
puts response
7

1
require "quicknode_sdk"
2

3
qn = QuicknodeSdk::SDK.from_config(api_key: "YOUR_API_KEY")
4

5
response = qn.admin.get_usage_by_endpoint
6
puts response
7

1
use quicknode_sdk::{QuicknodeSdk, SdkFullConfig};
2

3
#[tokio::main]
4
async fn main() -> Result<(), Box<dyn std::error::Error>> {
5
    let qn = QuicknodeSdk::new(&SdkFullConfig::builder().api_key("YOUR_API_KEY").build())?;
6
    let response = qn.admin.get_usage_by_endpoint(&Default::default()).await?;
7

8
    println!("{:?}", response);
9
    Ok(())
10
}
11

1
use quicknode_sdk::{QuicknodeSdk, SdkFullConfig};
2

3
#[tokio::main]
4
async fn main() -> Result<(), Box<dyn std::error::Error>> {
5
    let qn = QuicknodeSdk::new(&SdkFullConfig::builder().api_key("YOUR_API_KEY").build())?;
6
    let response = qn.admin.get_usage_by_endpoint(&Default::default()).await?;
7

8
    println!("{:?}", response);
9
    Ok(())
10
}
11

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free