PATCH /streams/rest/v1/streams/{id} REST API Endpoint

Path Parameters

string

REQUIRED

Body Parameters

name

string

filter_function

string

start_range

integer

end_range

integer

dataset_batch_size

integer

status

string

activepaused

elastic_batch_enabled

boolean

fix_block_reorgs

integer

keep_distance_from_tip

integer

notification_email

string

destination

string

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 PATCH \
2
    "https://api.quicknode.com/streams/rest/v1/streams/{id}" \
3
    -H "accept: application/json" \
4
    -H "Content-Type: application/json" \
5
    -H "x-api-key: YOUR_API_KEY" \
6
    -d $'{
7
  "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
8
  "start_range": 100,
9
  "end_range": 200,
10
  "dataset_batch_size": 1,
11
  "destination": "webhook",
12
  "fix_block_reorgs": 0,
13
  "keep_distance_from_tip": 0,
14
  "destination_attributes": {
15
    "url": "https://wehook.site",
16
    "compression": "none",
17
    "headers": {
18
      "Content-Type": "Test",
19
      "Authorization": "again"
20
    },
21
    "max_retry": 3,
22
    "retry_interval_sec": 1,
23
    "post_timeout_sec": 10
24
  },
25
  "status": "active"
26
}'
27

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

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: 'PATCH',
8
	headers: myHeaders,
9
	redirect: 'follow',
10
	body: JSON.stringify({
11
		filter_function:
12
			'ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==',
13
		start_range: 100,
14
		end_range: 200,
15
		dataset_batch_size: 1,
16
		destination: 'webhook',
17
		fix_block_reorgs: 0,
18
		keep_distance_from_tip: 0,
19
		destination_attributes: {
20
			url: 'https://webhook.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
}
33

34
fetch('https://api.quicknode.com/streams/rest/v1/streams/{id}', requestOptions)
35
	.then(response => response.text())
36
	.then(result => console.log(result))
37
	.catch(error => console.log('error', error))
38

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: 'PATCH',
8
	headers: myHeaders,
9
	redirect: 'follow',
10
	body: JSON.stringify({
11
		filter_function:
12
			'ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==',
13
		start_range: 100,
14
		end_range: 200,
15
		dataset_batch_size: 1,
16
		destination: 'webhook',
17
		fix_block_reorgs: 0,
18
		keep_distance_from_tip: 0,
19
		destination_attributes: {
20
			url: 'https://webhook.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
}
33

34
fetch('https://api.quicknode.com/streams/rest/v1/streams/{id}', requestOptions)
35
	.then(response => response.text())
36
	.then(result => console.log(result))
37
	.catch(error => console.log('error', error))
38

1
import requests
2

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

5
payload = {
6
    "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
7
    "start_range": 100,
8
    "end_range": 200,
9
    "dataset_batch_size": 1,
10
    "destination": "webhook",
11
    "fix_block_reorgs": 0,
12
    "keep_distance_from_tip": 0,
13
    "destination_attributes": {
14
        "url": "https://webhook.site",
15
        "compression": "none",
16
        "headers": {
17
            "Content-Type": "Test",
18
            "Authorization": "again"
19
        },
20
        "max_retry": 3,
21
        "retry_interval_sec": 1,
22
        "post_timeout_sec": 10
23
    },
24
    "status": "active"
25
}
26

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

33
response = requests.patch(url, headers=headers, json=payload)
34

35
print(response.text)
36

1
import requests
2

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

5
payload = {
6
    "filter_function": "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
7
    "start_range": 100,
8
    "end_range": 200,
9
    "dataset_batch_size": 1,
10
    "destination": "webhook",
11
    "fix_block_reorgs": 0,
12
    "keep_distance_from_tip": 0,
13
    "destination_attributes": {
14
        "url": "https://webhook.site",
15
        "compression": "none",
16
        "headers": {
17
            "Content-Type": "Test",
18
            "Authorization": "again"
19
        },
20
        "max_retry": 3,
21
        "retry_interval_sec": 1,
22
        "post_timeout_sec": 10
23
    },
24
    "status": "active"
25
}
26

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

33
response = requests.patch(url, headers=headers, json=payload)
34

35
print(response.text)
36

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/{id}")
7

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

11
request = Net::HTTP::Patch.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
  "filter_function" => "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
18
  "start_range" => 100,
19
  "end_range" => 200,
20
  "dataset_batch_size" => 1,
21
  "destination" => "webhook",
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
}.to_json
37

38
response = https.request(request)
39
puts response.body
40

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/{id}")
7

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

11
request = Net::HTTP::Patch.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
  "filter_function" => "ZnVuY3Rpb24gbWFpbihkYXRhKSB7CiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEuc3RyZWFtRGF0YS5udW1iZXIsIDE2KTsKICAgIHZhciBmaWx0ZXJlZERhdGEgPSB7CiAgICAgICAgaGFzaDogZGF0YS5zdHJlYW1EYXRhLmhhc2gsCiAgICAgICAgbnVtYmVyOiBudW1iZXJEZWNpbWFsCiAgICB9OwogICAgcmV0dXJuIGZpbHRlcmVkRGF0YTsKfQ==",
18
  "start_range" => 100,
19
  "end_range" => 200,
20
  "dataset_batch_size" => 1,
21
  "destination" => "webhook",
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
}.to_json
37

38
response = https.request(request)
39
puts response.body
40

Try in Swagger

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free

PATCH /streams/rest/v1/streams/{id} REST API Endpoint

Loading...

Path Parameters

Body Parameters

Returns