개요

Retrieves the full configuration and current state of a single stream by its unique ID. Use this endpoint to inspect a specific stream's settings including its network, dataset, filter function, block range, destination attributes, reorg handling configuration, and current processing position.

Key use cases:

• Monitor a stream's progress during backfills
• Debug delivery issues by checking configuration
• Verify configuration changes after an update
• Check the current sequence number and processing status

Endpoint

Send a GET request to retrieve a specific stream by its ID.

GET https://api.quicknode.com/streams/rest/v1/streams/{id}

경로 매개변수

매개변수	유형	Required	설명
id	문자열	네	The unique identifier (UUID) of the stream to retrieve

Example Request

cURL

curl -X GET "https://api.quicknode.com/streams/rest/v1/streams/f6ad6459-b5ad-4183-b370-1c1388e47e83" \
  -H "accept: application/json" \
  -H "x-api-key: YOUR_API_KEY"

CLI

qn stream show f6ad6459-b5ad-4183-b370-1c1388e47e83 -o json

자바스크립트

const headers = new Headers()
headers.append('accept', 'application/json')
headers.append('x-api-key', 'YOUR_API_KEY')

fetch('https://api.quicknode.com/streams/rest/v1/streams/f6ad6459-b5ad-4183-b370-1c1388e47e83', {
  method: 'GET',
  headers: headers
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error))

파이썬

import requests

url = "https://api.quicknode.com/streams/rest/v1/streams/f6ad6459-b5ad-4183-b370-1c1388e47e83"

headers = {
    "accept": "application/json",
    "x-api-key": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())

루비

require "uri"
require "net/http"

url = URI("https://api.quicknode.com/streams/rest/v1/streams/f6ad6459-b5ad-4183-b370-1c1388e47e83")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

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

response = https.request(request)
puts response.body

SDK (JS)

import { QuicknodeSdk } from "@quicknode/sdk"

const qn = new QuicknodeSdk({ apiKey: "YOUR_API_KEY" })
const stream = await qn.streams.getStream("f6ad6459-b5ad-4183-b370-1c1388e47e83")

console.log(stream.id, stream.name, stream.status)

SDK (Python)

import asyncio
from quicknode_sdk import QuicknodeSdk, SdkFullConfig

async def main():
    qn = QuicknodeSdk(SdkFullConfig(api_key="YOUR_API_KEY"))
    stream = await qn.streams.get_stream("f6ad6459-b5ad-4183-b370-1c1388e47e83")
    print(stream.id, stream.name, stream.status)

asyncio.run(main())

SDK (Ruby)

require "quicknode_sdk"

qn = QuicknodeSdk::SDK.from_config(api_key: "YOUR_API_KEY")
stream = qn.streams.get_stream(id: "f6ad6459-b5ad-4183-b370-1c1388e47e83")

puts "#{stream["id"]} #{stream["name"]} #{stream["status"]}"

SDK (Rust)

use quicknode_sdk::{QuicknodeSdk, SdkFullConfig};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let qn = QuicknodeSdk::new(&SdkFullConfig::builder().api_key("YOUR_API_KEY").build())?;
    let stream = qn.streams.get_stream("f6ad6459-b5ad-4183-b370-1c1388e47e83").await?;

    println!("{} {} {}", stream.id, stream.name, stream.status);
    Ok(())
}

답변

On success, the API returns the stream object with all configuration and status information.

{
  "id": "f6ad6459-b5ad-4183-b370-1c1388e47e83",
  "name": "My Stream",
  "network": "ethereum-mainnet",
  "dataset": "block",
  "region": "usa_east",
  "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7Li4ufQ==",
  "start_range": 100,
  "end_range": 200,
  "dataset_batch_size": 1,
  "elastic_batch_enabled": true,
  "fix_block_reorgs": 0,
  "keep_distance_from_tip": 0,
  "destination": "webhook",
  "destination_attributes": {
    "url": "https://webhook.site",
    "compression": "none",
    "headers": { "Authorization": "Bearer token" },
    "max_retry": 3,
    "retry_interval_sec": 1,
    "post_timeout_sec": 10,
    "mtls": true,
    "security_token": "qn_xxxxxxxxxxxxxx"
  },
  "status": "active",
  "sequence": 150,
  "current_hash": "0x1234567890abcdef...",
  "notification_email": null,
  "extra_destinations": [],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T12:45:00Z"
}

응답 필드

분야	유형	설명
id	문자열	Unique stream identifier (UUID)
이름	문자열	Stream name
네트워크	문자열	Blockchain network
dataset	문자열	Dataset type
region	문자열	Deployment region
filter_function	문자열	Base64-encoded filter function (if configured)
start_range	정수	Starting block number
end_range	정수	Ending block number (null for continuous)
dataset_batch_size	정수	Number of blocks per batch
elastic_batch_enabled	부울	Whether elastic batching is enabled
fix_block_reorgs	정수	Reorg detection setting (1 = enabled)
keep_distance_from_tip	정수	Blocks to stay behind chain tip
destination	문자열	Destination type (webhook, s3, azure, postgres)
destination_attributes	객체	Destination configuration (varies by type)
상태	문자열	Stream status (active or paused)
순서	정수	Last delivered block from the data range
current_hash	문자열	Hash of the current block being processed
알림 이메일	문자열	Email for stream termination alerts
extra_destinations	배열	Additional destinations (if configured)
created_at	문자열	Stream creation timestamp (ISO 8601)
업데이트 일시	문자열	Last update timestamp (ISO 8601)

Response Destination Attributes

그 destination_attributes object in the response varies based on the destination type. Select a tab below to view the fields returned for each destination.

웹훅

분야	유형	설명
url	문자열	Webhook endpoint URL
compression	문자열	Compression type (none or gzip)
headers	객체	Custom headers (if configured)
max_retry	정수	Maximum retry attempts
retry_interval_sec	정수	Seconds between retries
post_timeout_sec	정수	Request timeout in seconds
security_token	문자열	Auto-generated token for validating webhook authenticity
mtls	부울	Whether Quicknode authenticates to this endpoint with its client certificate (mutual TLS)
ssl_ca_pem	문자열	CA certificate (PEM) used to verify the endpoint's server certificate (only set for private CAs)

S3

분야	유형	설명
endpoint	문자열	S3 endpoint
bucket	문자열	Bucket name
access_key	문자열	S3 access key
object_prefix	문자열	Prefix for object keys
file_compression_type	문자열	Compression type (none or gzip)
file_type	문자열	File format (.json)
max_retry	정수	Maximum retry attempts
retry_interval_sec	정수	Seconds between retries
use_ssl	부울	SSL enabled status

Azure

분야	유형	설명
storage_account	문자열	Azure storage account name
container	문자열	Container name
blob_prefix	문자열	Prefix for blob names
file_compression_type	문자열	Compression type (none or gzip)
file_type	문자열	File format (.json)
max_retry	정수	Maximum retry attempts
retry_interval_sec	정수	Seconds between retries

PostgreSQL

분야	유형	설명
host	문자열	Database host
port	정수	Database port
username	문자열	Database username
table_name	문자열	Target table name
sslmode	문자열	SSL mode (require or disable)
max_retry	정수	Maximum retry attempts
retry_interval_sec	정수	Seconds between retries

note

Sensitive fields like secret_key (S3), sas_token (Azure), and password (PostgreSQL) are not returned in the response for security reasons.