POST /streams/rest/v1/streams REST API Endpoint

Body Parameters

name

string

REQUIRED

network

string

REQUIRED

dataset

string

REQUIRED

filter_function

string

region

string

start_range

integer

end_range

integer

dataset_batch_size

integer

REQUIRED

include_stream_metadata

string

REQUIRED

status

string

REQUIRED

elastic_batch_enabled

boolean

REQUIRED

fix_block_reorgs

integer

keep_distance_from_tip

integer

notification_email

string

destination

string

REQUIRED

destination_attributes

object

url

string

REQUIRED

compression

string

REQUIRED

headers

object

key-value

string

max_retry

integer

REQUIRED

retry_interval_sec

integer

REQUIRED

post_timeout_sec

integer

REQUIRED

destination_attributes

object

endpoint

string

REQUIRED

access_key

string

secret_key

string

REQUIRED

bucket

string

REQUIRED

object_prefix

string

file_compression_type

string

REQUIRED

file_type

string

REQUIRED

max_retry

integer

REQUIRED

retry_interval_sec

integer

REQUIRED

use_ssl

boolean

REQUIRED

destination_attributes

object

storage_account

string

REQUIRED

container

string

REQUIRED

sas_token

string

REQUIRED

blob_prefix

string

file_compression_type

string

REQUIRED

file_type

string

REQUIRED

max_retry

integer

REQUIRED

retry_interval_sec

integer

REQUIRED

destination_attributes

object

username

string

REQUIRED

password

string

REQUIRED

host

string

REQUIRED

port

integer

REQUIRED

ssl_mode

string

REQUIRED

table_name

string

REQUIRED

max_retry

integer

REQUIRED

retry_interval_sec

integer

REQUIRED

Returns

string

created_at

string

updated_at

string

name

string

network

string

dataset

string

region

string

filter_function

string

start_range

integer

end_range

integer

dataset_batch_size

integer

include_stream_metadata

string

destination

string

fix_block_reorgs

integer

keep_distance_from_tip

integer

destination_attributes

object

url

string

compression

string

headers

object

key-value

string

max_retry

integer

retry_interval_sec

integer

post_timeout_sec

integer

security_token

string

destination_attributes

object

endpoint

string

access_key

string

secret_key

string

bucket

string

object_prefix

string

file_compression_type

string

file_type

string

max_retry

integer

retry_interval_sec

integer

use_ssl

boolean

destination_attributes

object

storage_account

string

container

string

sas_token

string

blob_prefix

string

file_compression_type

string

file_type

string

max_retry

integer

retry_interval_sec

integer

destination_attributes

object

username

string

password

string

host

string

port

integer

ssl_mode

string

table_name

string

max_retry

integer

retry_interval_sec

integer

status

string

notification_email

string

sequence

integer

current_hash

string

Request

curl -X POST \
    "https://api.quicknode.com/streams/rest/v1/streams" \
    -H "accept: application/json" \
    -H "Content-Type: application/json" \
    -H "x-api-key: YOUR_API_KEY" \
    -d $'{
  "name": "My Stream",
  "network": "ethereum-mainnet",
  "dataset": "block",
  "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
  "region": "usa_east",
  "start_range": 100,
  "end_range": 200,
  "dataset_batch_size": 1,
  "include_stream_metadata": "body",
  "destination": "webhook",
  "fix_block_reorgs": 0,
  "keep_distance_from_tip": 0,
  "elastic_batch_enabled": true,
  "destination_attributes": {
    "url": "https://wehook.site",
    "compression": "none",
    "headers": {
      "Content-Type": "Test",
      "Authorization": "again"
    },
    "max_retry": 3,
    "retry_interval_sec": 1,
    "post_timeout_sec": 10
  },
  "status": "active"
}'

var myHeaders = new Headers();
myHeaders.append('accept', 'application/json');
myHeaders.append('Content-Type', 'application/json');
myHeaders.append('x-api-key', 'YOUR_API_KEY'); // Replace with your actual API key

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  redirect: 'follow',
  body: JSON.stringify({
    name: 'My Stream',
    network: 'ethereum-mainnet',
    dataset: 'block',
    filter_function: 'ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==',
    region: 'usa_east',
    start_range: 100,
    end_range: 200,
    dataset_batch_size: 1,
    include_stream_metadata: 'body',
    destination: 'webhook',
    elastic_batch_enabled: true,
    fix_block_reorgs: 0,
    keep_distance_from_tip: 0,
    destination_attributes: {
      url: 'https://webhook.site',
      compression: 'none',
      headers: {
        'Content-Type': 'Test',
        Authorization: 'again'
      },
      max_retry: 3,
      retry_interval_sec: 1,
      post_timeout_sec: 10
    },
    status: 'active'
  })
};

fetch('https://api.quicknode.com/streams/rest/v1/streams', requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

import requests

url = "https://api.quicknode.com/streams/rest/v1/streams"

payload = {
    "name": "My Stream",
    "network": "ethereum-mainnet",
    "dataset": "block",
    "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
    "region": "usa_east",
    "start_range": 100,
    "end_range": 200,
    "dataset_batch_size": 1,
    "include_stream_metadata": "body",
    "destination": "webhook",
    "fix_block_reorgs": 0,
    "keep_distance_from_tip": 0,
    "elastic_batch_enabled": True,
    "destination_attributes": {
        "url": "https://webhook.site",
        "compression": "none",
        "headers": {
            "Content-Type": "Test",
            "Authorization": "again"
        },
        "max_retry": 3,
        "retry_interval_sec": 1,
        "post_timeout_sec": 10
    },
    "status": "active"
}

headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "x-api-key": "YOUR_API_KEY"  # Replace with your actual API key
}

response = requests.post(url, headers=headers, json=payload)

print(response.text)

require "uri"
require "net/http"
require "json"

# Set up the URL for the request
url = URI("https://api.quicknode.com/streams/rest/v1/streams")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["Content-Type"] = "application/json"
request["x-api-key"] = "YOUR_API_KEY"  # Replace with your actual API key

request.body = {
  "name" => "My Stream",
  "network" => "ethereum-mainnet",
  "dataset" => "block",
  "filter_function" => "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
  "region" => "usa_east",
  "start_range" => 100,
  "end_range" => 200,
  "dataset_batch_size" => 1,
  "include_stream_metadata" => "body",
  "destination" => "webhook",
  "elastic_batch_enabled" => true,
  "fix_block_reorgs" => 0,
  "keep_distance_from_tip" => 0,
  "destination_attributes" => {
    "url" => "https://webhook.site",
    "compression" => "none",
    "headers" => {
      "Content-Type" => "Test",
      "Authorization" => "again"
    },
    "max_retry" => 3,
    "retry_interval_sec" => 1,
    "post_timeout_sec" => 10
  },
  "status" => "active"
}.to_json

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

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free

POST /streams/rest/v1/streams REST API Endpoint

Loading...

Body Parameters

Returns