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

Body Parameters

name

string

REQUIRED

network

string

REQUIRED

dataset

string

REQUIRED

filter_function

string

region

string

REQUIRED

usa_east

start_range

integer

end_range

integer

dataset_batch_size

integer

REQUIRED

status

string

REQUIRED

activepaused

elastic_batch_enabled

boolean

REQUIRED

fix_block_reorgs

integer

keep_distance_from_tip

integer

notification_email

string

destination

string

REQUIRED

webhooks3azurepostgres

destination_attributes

object

REQUIRED

url

string

REQUIRED

compression

string

REQUIRED

nonegzip

headers

object

key-value

string

max_retry

integer

REQUIRED

retry_interval_sec

integer

REQUIRED

post_timeout_sec

integer

REQUIRED

extra_destinations

array

destination

string

REQUIRED

webhooks3azurepostgres

destination_attributes

object

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

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

status

string

notification_email

string

sequence

integer

current_hash

string

elastic_batch_enabled

boolean

extra_destinations

array

destination

string

destination_attributes

object

Request

1
curl -X POST \
2
    "https://api.quicknode.com/streams/rest/v1/streams" \
3
    -H "accept: application/json" \
4
    -H "Content-Type: application/json" \
5
    -H "x-api-key: YOUR_API_KEY" \
6
    -d $'{
7
  "name": "My Stream",
8
  "network": "ethereum-mainnet",
9
  "dataset": "block",
10
  "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
11
  "region": "usa_east",
12
  "start_range": 100,
13
  "end_range": 200,
14
  "dataset_batch_size": 1,
15
  "destination": "webhook",
16
  "fix_block_reorgs": 0,
17
  "keep_distance_from_tip": 0,
18
  "elastic_batch_enabled": true,
19
  "destination_attributes": {
20
    "url": "https://wehook.site",
21
    "compression": "none",
22
    "headers": {
23
      "Content-Type": "Test",
24
      "Authorization": "again"
25
    },
26
    "max_retry": 3,
27
    "retry_interval_sec": 1,
28
    "post_timeout_sec": 10
29
  },
30
  "status": "active"
31
}'
32

1
curl -X POST \
2
    "https://api.quicknode.com/streams/rest/v1/streams" \
3
    -H "accept: application/json" \
4
    -H "Content-Type: application/json" \
5
    -H "x-api-key: YOUR_API_KEY" \
6
    -d $'{
7
  "name": "My Stream",
8
  "network": "ethereum-mainnet",
9
  "dataset": "block",
10
  "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
11
  "region": "usa_east",
12
  "start_range": 100,
13
  "end_range": 200,
14
  "dataset_batch_size": 1,
15
  "destination": "webhook",
16
  "fix_block_reorgs": 0,
17
  "keep_distance_from_tip": 0,
18
  "elastic_batch_enabled": true,
19
  "destination_attributes": {
20
    "url": "https://wehook.site",
21
    "compression": "none",
22
    "headers": {
23
      "Content-Type": "Test",
24
      "Authorization": "again"
25
    },
26
    "max_retry": 3,
27
    "retry_interval_sec": 1,
28
    "post_timeout_sec": 10
29
  },
30
  "status": "active"
31
}'
32

1
const myHeaders = new Headers()
2
myHeaders.append('accept', 'application/json')
3
myHeaders.append('Content-Type', 'application/json')
4
myHeaders.append('x-api-key', 'YOUR_API_KEY') // Replace with your actual API key
5

6
const requestOptions = {
7
	method: 'POST',
8
	headers: myHeaders,
9
	redirect: 'follow',
10
	body: JSON.stringify({
11
		name: 'My Stream',
12
		network: 'ethereum-mainnet',
13
		dataset: 'block',
14
		filter_function:
15
			'ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==',
16
		region: 'usa_east',
17
		start_range: 100,
18
		end_range: 200,
19
		dataset_batch_size: 1,
20
		destination: 'webhook',
21
		elastic_batch_enabled: true,
22
		fix_block_reorgs: 0,
23
		keep_distance_from_tip: 0,
24
		destination_attributes: {
25
			url: 'https://webhook.site',
26
			compression: 'none',
27
			headers: {
28
				'Content-Type': 'Test',
29
				Authorization: 'again',
30
			},
31
			max_retry: 3,
32
			retry_interval_sec: 1,
33
			post_timeout_sec: 10,
34
		},
35
		status: 'active',
36
	}),
37
}
38

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

1
const myHeaders = new Headers()
2
myHeaders.append('accept', 'application/json')
3
myHeaders.append('Content-Type', 'application/json')
4
myHeaders.append('x-api-key', 'YOUR_API_KEY') // Replace with your actual API key
5

6
const requestOptions = {
7
	method: 'POST',
8
	headers: myHeaders,
9
	redirect: 'follow',
10
	body: JSON.stringify({
11
		name: 'My Stream',
12
		network: 'ethereum-mainnet',
13
		dataset: 'block',
14
		filter_function:
15
			'ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==',
16
		region: 'usa_east',
17
		start_range: 100,
18
		end_range: 200,
19
		dataset_batch_size: 1,
20
		destination: 'webhook',
21
		elastic_batch_enabled: true,
22
		fix_block_reorgs: 0,
23
		keep_distance_from_tip: 0,
24
		destination_attributes: {
25
			url: 'https://webhook.site',
26
			compression: 'none',
27
			headers: {
28
				'Content-Type': 'Test',
29
				Authorization: 'again',
30
			},
31
			max_retry: 3,
32
			retry_interval_sec: 1,
33
			post_timeout_sec: 10,
34
		},
35
		status: 'active',
36
	}),
37
}
38

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

1
import requests
2

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

5
payload = {
6
    "name": "My Stream",
7
    "network": "ethereum-mainnet",
8
    "dataset": "block",
9
    "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
10
    "region": "usa_east",
11
    "start_range": 100,
12
    "end_range": 200,
13
    "dataset_batch_size": 1,
14
    "destination": "webhook",
15
    "fix_block_reorgs": 0,
16
    "keep_distance_from_tip": 0,
17
    "elastic_batch_enabled": True,
18
    "destination_attributes": {
19
        "url": "https://webhook.site",
20
        "compression": "none",
21
        "headers": {
22
            "Content-Type": "Test",
23
            "Authorization": "again"
24
        },
25
        "max_retry": 3,
26
        "retry_interval_sec": 1,
27
        "post_timeout_sec": 10
28
    },
29
    "status": "active"
30
}
31

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

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

40
print(response.text)
41

1
import requests
2

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

5
payload = {
6
    "name": "My Stream",
7
    "network": "ethereum-mainnet",
8
    "dataset": "block",
9
    "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
10
    "region": "usa_east",
11
    "start_range": 100,
12
    "end_range": 200,
13
    "dataset_batch_size": 1,
14
    "destination": "webhook",
15
    "fix_block_reorgs": 0,
16
    "keep_distance_from_tip": 0,
17
    "elastic_batch_enabled": True,
18
    "destination_attributes": {
19
        "url": "https://webhook.site",
20
        "compression": "none",
21
        "headers": {
22
            "Content-Type": "Test",
23
            "Authorization": "again"
24
        },
25
        "max_retry": 3,
26
        "retry_interval_sec": 1,
27
        "post_timeout_sec": 10
28
    },
29
    "status": "active"
30
}
31

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

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

40
print(response.text)
41

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

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

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

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

16
request.body = {
17
  "name" => "My Stream",
18
  "network" => "ethereum-mainnet",
19
  "dataset" => "block",
20
  "filter_function" => "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
21
  "region" => "usa_east",
22
  "start_range" => 100,
23
  "end_range" => 200,
24
  "dataset_batch_size" => 1,
25
  "destination" => "webhook",
26
  "elastic_batch_enabled" => true,
27
  "fix_block_reorgs" => 0,
28
  "keep_distance_from_tip" => 0,
29
  "destination_attributes" => {
30
    "url" => "https://webhook.site",
31
    "compression" => "none",
32
    "headers" => {
33
      "Content-Type" => "Test",
34
      "Authorization" => "again"
35
    },
36
    "max_retry" => 3,
37
    "retry_interval_sec" => 1,
38
    "post_timeout_sec" => 10
39
  },
40
  "status" => "active"
41
}.to_json
42

43
response = https.request(request)
44
puts response.body
45

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

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

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

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

16
request.body = {
17
  "name" => "My Stream",
18
  "network" => "ethereum-mainnet",
19
  "dataset" => "block",
20
  "filter_function" => "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
21
  "region" => "usa_east",
22
  "start_range" => 100,
23
  "end_range" => 200,
24
  "dataset_batch_size" => 1,
25
  "destination" => "webhook",
26
  "elastic_batch_enabled" => true,
27
  "fix_block_reorgs" => 0,
28
  "keep_distance_from_tip" => 0,
29
  "destination_attributes" => {
30
    "url" => "https://webhook.site",
31
    "compression" => "none",
32
    "headers" => {
33
      "Content-Type" => "Test",
34
      "Authorization" => "again"
35
    },
36
    "max_retry" => 3,
37
    "retry_interval_sec" => 1,
38
    "post_timeout_sec" => 10
39
  },
40
  "status" => "active"
41
}.to_json
42

43
response = https.request(request)
44
puts response.body
45

Try in Swagger

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