अवलोकन

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}

पथ पैरामीटर

Parameter	Type	Required	विवरण
पहचान	डोरी	हाँ	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"

सीएलआई

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))

Python

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())

Ruby

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"
}

Response Fields

Field	Type	विवरण
पहचान	डोरी	Unique stream identifier (UUID)
नाम	डोरी	Stream name
network	डोरी	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
notification_email	डोरी	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

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

Webhook

Field	Type	विवरण
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

Field	Type	विवरण
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

Field	Type	विवरण
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

पोस्टग्रेएसक्यूएल

Field	Type	विवरण
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.