Query Parameters

start_time

integer

Specifies the start of the time period for which the usage data is to be retrieved

end_time

integer

Specifies the end of the time period for which the usage data is to be retrieved

Returns

data

object

The data object which contains the following fields:

credits_used

integer

The number of credits used within the specified time period

credits_remaining

integer

The number of credits remaining in the account

limit

integer

The maximum number of credits available

overages

integer

The number of credits used beyond the limit

start_time

integer

The start timestamp for the usage data in second in second

end_time

integer

The end timestamp for the usage data in second in second

error

string

A string containing an error message, if any issues occur during the request

Request

1
curl -X 'GET' \
2
  'https://api.quicknode.com/v0/usage/rpc' \
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' \
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", 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", 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"
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"
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")
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")
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 summary --from 7d -o json

1
qn usage summary --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.getUsage()
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.getUsage()
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()
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()
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
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
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(&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(&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