Path Parameters

key

string

REQUIRED

The unique key associated with the list

Body Parameters

addItems

array

An array of items to be added to the existing Key-Value Store list

removeItems

array

An array of items to be removed from the existing Key-Value Store list

Returns

code

number

Response status code

msg

string

Response message

data

null

No additional data

Request

1
curl -X PATCH \
2
    "https://api.quicknode.com/kv/rest/v1/lists/{key}" \
3
    -H "accept: application/json" \
4
    -H "Content-Type: application/json" \
5
    -H "x-api-key: YOUR_API_KEY" \
6
    -d $'{
7
    "addItems": [
8
      "item1",
9
      "item2"
10
    ],
11
    "removeItems": [
12
      "item3",
13
      "item5"
14
    ]
15
}'
16

1
curl -X PATCH \
2
    "https://api.quicknode.com/kv/rest/v1/lists/{key}" \
3
    -H "accept: application/json" \
4
    -H "Content-Type: application/json" \
5
    -H "x-api-key: YOUR_API_KEY" \
6
    -d $'{
7
    "addItems": [
8
      "item1",
9
      "item2"
10
    ],
11
    "removeItems": [
12
      "item3",
13
      "item5"
14
    ]
15
}'
16

1
var 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
var requestOptions = {
7
  method: 'PATCH',
8
  headers: myHeaders,
9
  redirect: 'follow',
10
  body: JSON.stringify({
11
    addItems: [
12
      'item1',
13
      'item2'
14
    ],
15
    removeItems: [
16
      'item3',
17
      'item5'
18
    ]
19
  })
20
};
21

22
fetch('https://api.quicknode.com/kv/rest/v1/lists/{key}', requestOptions)
23
  .then(response => response.text())
24
  .then(result => console.log(result))
25
  .catch(error => console.log('error', error));
26

1
var 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
var requestOptions = {
7
  method: 'PATCH',
8
  headers: myHeaders,
9
  redirect: 'follow',
10
  body: JSON.stringify({
11
    addItems: [
12
      'item1',
13
      'item2'
14
    ],
15
    removeItems: [
16
      'item3',
17
      'item5'
18
    ]
19
  })
20
};
21

22
fetch('https://api.quicknode.com/kv/rest/v1/lists/{key}', requestOptions)
23
  .then(response => response.text())
24
  .then(result => console.log(result))
25
  .catch(error => console.log('error', error));
26

1
import requests
2

3
url = "https://api.quicknode.com/kv/rest/v1/lists/{key}"
4

5
payload = {
6
    "addItems": [
7
    "item1",
8
    "item2"
9
  ],
10
  "removeItems": [
11
    "item3",
12
    "item5"
13
  ]
14
}
15

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

22
response = requests.patch(url, headers=headers, json=payload)
23

24
print(response.text)
25

1
import requests
2

3
url = "https://api.quicknode.com/kv/rest/v1/lists/{key}"
4

5
payload = {
6
    "addItems": [
7
    "item1",
8
    "item2"
9
  ],
10
  "removeItems": [
11
    "item3",
12
    "item5"
13
  ]
14
}
15

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

22
response = requests.patch(url, headers=headers, json=payload)
23

24
print(response.text)
25

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/kv/rest/v1/lists/{key}")
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
  "addItems" => [
18
    "item1",
19
    "item2"
20
  ],
21
  "removeItems" => [
22
    "item3",
23
    "item5"
24
  ]
25
}.to_json
26

27
response = https.request(request)
28
puts response.body
29

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/kv/rest/v1/lists/{key}")
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
  "addItems" => [
18
    "item1",
19
    "item2"
20
  ],
21
  "removeItems" => [
22
    "item3",
23
    "item5"
24
  ]
25
}.to_json
26

27
response = https.request(request)
28
puts response.body
29

1
qn kv list update {list_key} --add {item_to_add} --remove {item_to_remove} -o json

1
qn kv list update {list_key} --add {item_to_add} --remove {item_to_remove} -o json

1
import { QuicknodeSdk } from "@quicknode/sdk"
2

3
const qn = new QuicknodeSdk({ apiKey: "YOUR_API_KEY" })
4

5
const response = await qn.kvstore.updateList("watchlist", { addItems: ["0x0000000000000000000000000000000000000000"], removeItems: [] })
6
console.log(response)
7

1
import { QuicknodeSdk } from "@quicknode/sdk"
2

3
const qn = new QuicknodeSdk({ apiKey: "YOUR_API_KEY" })
4

5
const response = await qn.kvstore.updateList("watchlist", { addItems: ["0x0000000000000000000000000000000000000000"], removeItems: [] })
6
console.log(response)
7

1
import asyncio
2
from quicknode_sdk import QuicknodeSdk, SdkFullConfig
3

4

5
async def main():
6
    qn = QuicknodeSdk(SdkFullConfig(api_key="YOUR_API_KEY"))
7
    response = await qn.kvstore.update_list("watchlist", add_items=["0x0000000000000000000000000000000000000000"], remove_items=[])
8
    print(response)
9

10

11
asyncio.run(main())
12

1
import asyncio
2
from quicknode_sdk import QuicknodeSdk, SdkFullConfig
3

4

5
async def main():
6
    qn = QuicknodeSdk(SdkFullConfig(api_key="YOUR_API_KEY"))
7
    response = await qn.kvstore.update_list("watchlist", add_items=["0x0000000000000000000000000000000000000000"], remove_items=[])
8
    print(response)
9

10

11
asyncio.run(main())
12

1
require "quicknode_sdk"
2

3
qn = QuicknodeSdk::SDK.from_config(api_key: "YOUR_API_KEY")
4

5
response = qn.kvstore.update_list(key: "watchlist", add_items: ["0x0000000000000000000000000000000000000000"], remove_items: [])
6
puts response
7

1
require "quicknode_sdk"
2

3
qn = QuicknodeSdk::SDK.from_config(api_key: "YOUR_API_KEY")
4

5
response = qn.kvstore.update_list(key: "watchlist", add_items: ["0x0000000000000000000000000000000000000000"], remove_items: [])
6
puts response
7

1
use quicknode_sdk::{QuicknodeSdk, SdkFullConfig};
2

3
#[tokio::main]
4
async fn main() -> Result<(), Box<dyn std::error::Error>> {
5
    let qn = QuicknodeSdk::new(&SdkFullConfig::builder().api_key("YOUR_API_KEY").build())?;
6
    let response = qn.kvstore.update_list("watchlist", &quicknode_sdk::kvstore::UpdateListParams { add_items: Some(vec!["0x0000000000000000000000000000000000000000".to_string()]), remove_items: None }).await?;
7

8
    println!("{:?}", response);
9
    Ok(())
10
}
11

1
use quicknode_sdk::{QuicknodeSdk, SdkFullConfig};
2

3
#[tokio::main]
4
async fn main() -> Result<(), Box<dyn std::error::Error>> {
5
    let qn = QuicknodeSdk::new(&SdkFullConfig::builder().api_key("YOUR_API_KEY").build())?;
6
    let response = qn.kvstore.update_list("watchlist", &quicknode_sdk::kvstore::UpdateListParams { add_items: Some(vec!["0x0000000000000000000000000000000000000000".to_string()]), remove_items: None }).await?;
7

8
    println!("{:?}", response);
9
    Ok(())
10
}
11

Try in Swagger

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free