This method is available only to Enterprise accounts. See the Observability overview for more information.

Query Parameters

from

string

ISO 8601 start time. Required together with to when last is omitted.

to

string

ISO 8601 end time. Required together with from when last is omitted.

last

string

Relative time window instead of from and to; for example, 1h for the last hour.

group_by[]

array

Repeat this query parameter for grouping dimensions: stream. Omit it to return totals without a breakdown.

limit

integer

Positive maximum number of results per page; for example, 2.

cursor

string

Opaque next_cursor from the previous response. Keep the same time range, filters, grouping, and limit when requesting subsequent pages.

Returns

data

object | null

Response data. Null when the request fails.

from

string

Effective start of the returned time range, in ISO 8601 format.

to

string

Effective end of the returned time range, in ISO 8601 format.

totals

object

Aggregate totals for the selected time range.

blocks

integer

Number of Streams blocks processed.

bytes

integer

Number of bytes transferred.

block_credits

integer

Credits consumed by Streams blocks.

breakdown

array

Grouped results. Present when grouping is requested; can be empty.

stream

string

Stream identifier. Present when grouping by stream.

blocks

integer

Number of Streams blocks processed.

bytes

integer

Number of bytes transferred.

block_credits

integer

Credits consumed by Streams blocks.

next_cursor

string

Opaque continuation cursor. Present when another page is available. Pass it unchanged as cursor.

error

string | null

Error message on failure; null on success.

Request

1
curl --get "https://api.quicknode.com/v0/usage/streams/summary" \
2
  --header "accept: application/json" \
3
  --header "x-api-key: ${QN_API_KEY}" \
4
  --data-urlencode 'from=2026-10-19T19:29:00Z' \
5
  --data-urlencode 'to=2026-10-20T19:29:00Z' \
6
  --data-urlencode 'group_by[]=stream' \
7
  --data-urlencode 'limit=2'
8

1
curl --get "https://api.quicknode.com/v0/usage/streams/summary" \
2
  --header "accept: application/json" \
3
  --header "x-api-key: ${QN_API_KEY}" \
4
  --data-urlencode 'from=2026-10-19T19:29:00Z' \
5
  --data-urlencode 'to=2026-10-20T19:29:00Z' \
6
  --data-urlencode 'group_by[]=stream' \
7
  --data-urlencode 'limit=2'
8

1
const url = new URL(`https://api.quicknode.com/v0/usage/streams/summary`);
2
url.searchParams.append("from", "2026-10-19T19:29:00Z");
3
url.searchParams.append("to", "2026-10-20T19:29:00Z");
4
url.searchParams.append("group_by[]", "stream");
5
url.searchParams.append("limit", "2");
6

7
fetch(url, {
8
  headers: { "accept": "application/json", "x-api-key": process.env.QN_API_KEY },
9
})
10
  .then(async (response) => {
11
    const body = await response.text();
12
    if (!response.ok) throw new Error(`HTTP ${response.status}: ${body}`);
13
    console.log(body);
14
  })
15
  .catch((error) => { console.error(error); process.exitCode = 1; });
16

1
const url = new URL(`https://api.quicknode.com/v0/usage/streams/summary`);
2
url.searchParams.append("from", "2026-10-19T19:29:00Z");
3
url.searchParams.append("to", "2026-10-20T19:29:00Z");
4
url.searchParams.append("group_by[]", "stream");
5
url.searchParams.append("limit", "2");
6

7
fetch(url, {
8
  headers: { "accept": "application/json", "x-api-key": process.env.QN_API_KEY },
9
})
10
  .then(async (response) => {
11
    const body = await response.text();
12
    if (!response.ok) throw new Error(`HTTP ${response.status}: ${body}`);
13
    console.log(body);
14
  })
15
  .catch((error) => { console.error(error); process.exitCode = 1; });
16

1
import os
2
from urllib.parse import quote
3
import requests
4

5
url = f"https://api.quicknode.com/v0/usage/streams/summary"
6
params = {'from': '2026-10-19T19:29:00Z', 'to': '2026-10-20T19:29:00Z', 'group_by[]': 'stream', 'limit': 2}
7
response = requests.get(
8
    url, params=params,
9
    headers={"accept": "application/json", "x-api-key": os.environ["QN_API_KEY"]},
10
    timeout=60,
11
)
12
response.raise_for_status()
13
print(response.text)
14

1
import os
2
from urllib.parse import quote
3
import requests
4

5
url = f"https://api.quicknode.com/v0/usage/streams/summary"
6
params = {'from': '2026-10-19T19:29:00Z', 'to': '2026-10-20T19:29:00Z', 'group_by[]': 'stream', 'limit': 2}
7
response = requests.get(
8
    url, params=params,
9
    headers={"accept": "application/json", "x-api-key": os.environ["QN_API_KEY"]},
10
    timeout=60,
11
)
12
response.raise_for_status()
13
print(response.text)
14

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

4
url = URI("https://api.quicknode.com/v0/usage/streams/summary")
5
url.query = URI.encode_www_form({"from" => "2026-10-19T19:29:00Z", "to" => "2026-10-20T19:29:00Z", "group_by[]" => "stream", "limit" => "2"})
6
request = Net::HTTP::Get.new(url)
7
request["accept"] = "application/json"
8
request["x-api-key"] = ENV.fetch("QN_API_KEY")
9
response = Net::HTTP.start(url.hostname, url.port, use_ssl: true) { |http| http.request(request) }
10
raise "HTTP #{response.code}: #{response.body}" unless response.is_a?(Net::HTTPSuccess)
11
puts response.body
12

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

4
url = URI("https://api.quicknode.com/v0/usage/streams/summary")
5
url.query = URI.encode_www_form({"from" => "2026-10-19T19:29:00Z", "to" => "2026-10-20T19:29:00Z", "group_by[]" => "stream", "limit" => "2"})
6
request = Net::HTTP::Get.new(url)
7
request["accept"] = "application/json"
8
request["x-api-key"] = ENV.fetch("QN_API_KEY")
9
response = Net::HTTP.start(url.hostname, url.port, use_ssl: true) { |http| http.request(request) }
10
raise "HTTP #{response.code}: #{response.body}" unless response.is_a?(Net::HTTPSuccess)
11
puts response.body
12

Response

1
{
2
  "data": {
3
    "from": "2026-10-19T19:00:00.000000Z",
4
    "to": "2026-10-20T20:00:00.000000Z",
5
    "totals": {
6
      "blocks": 413141,
7
      "bytes": 8873180,
8
      "block_credits": 2891987
9
    },
10
    "breakdown": [
11
      {
12
        "stream": "00000000-0000-4000-8000-000000000001",
13
        "blocks": 413141,
14
        "bytes": 8873180,
15
        "block_credits": 2891987
16
      }
17
    ]
18
  },
19
  "error": null
20
}

1
{
2
  "data": {
3
    "from": "2026-10-19T19:00:00.000000Z",
4
    "to": "2026-10-20T20:00:00.000000Z",
5
    "totals": {
6
      "blocks": 413141,
7
      "bytes": 8873180,
8
      "block_credits": 2891987
9
    },
10
    "breakdown": [
11
      {
12
        "stream": "00000000-0000-4000-8000-000000000001",
13
        "blocks": 413141,
14
        "bytes": 8873180,
15
        "block_credits": 2891987
16
      }
17
    ]
18
  },
19
  "error": null
20
}

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free