Query Parameters

limit

integer

Specifies the maximum number of endpoints to retrieve in the response. The default value is set to 20

offset

integer

Specifies the number of endpoints to skip before starting to retrieve the list

search

string

Search endpoints by subdomain or label

sort_by

string

Sort field. Accepted values: name, status, network, label, tags, usage, created_at. Default value: created_at

sort_direction

string

Sort direction. Accepted values: asc, desc. Default value: ASC

networks

array

Filter by network name(s)

statuses

array

Filter by endpoint status. Accepted values: active, paused

labels

array

Filter by endpoint label(s)

dedicated

boolean

Filter for dedicated endpoints only

is_flat_rate

boolean

Filter for flat rate endpoints only

tag_ids

integer or array

Filter endpoints by tag IDs. Can be a single integer or an array of integers. Optional. Cannot be used together with tag_labels

tag_labels

string or array

Filter endpoints by tag labels. Can be a single string or an array of strings. Optional. Cannot be used together with tag_ids

Returns

data

array

An array of data which contains the following fields:

id

string

A unique identifier for the specific endpoint

name

string

The endpoint subdomain

label

string

A descriptive label for the endpoint

status

string

The current status of the endpoint (active or paused)

chain

string

The blockchain the endpoint is associated with

network

string

The specific network of the blockchain

is_dedicated

boolean

Whether the endpoint is a dedicated endpoint

is_flat_rate

boolean

Whether the endpoint is a flat rate endpoint

is_multichain

boolean

Whether the endpoint is a multichain endpoint

http_url

string

The HTTP URL to access the endpoint

wss_url

string

The WebSocket URL to access the endpoint

tags

array

An array of tags associated with the endpoint

tag_id

integer

The unique identifier for the tag

label

string

The label/name of the tag

pagination

object

Pagination details for the response

total

integer

The total number of endpoints matching the query

limit

integer

The maximum number of endpoints returned per page

offset

integer

The number of endpoints skipped

error

string

An error message if any issue occurs

Request

1
curl -X 'GET' \
2
  'https://api.quicknode.com/v0/endpoints?limit=20&offset=0' \
3
  -H 'accept: application/json' \
4
  -H 'x-api-key: YOUR_API_KEY'

1
curl -X 'GET' \
2
  'https://api.quicknode.com/v0/endpoints?limit=20&offset=0' \
3
  -H 'accept: application/json' \
4
  -H 'x-api-key: YOUR_API_KEY'

1
const myHeaders = new Headers();
2
myHeaders.append("accept", "application/json");
3
myHeaders.append("x-api-key", "YOUR_API_KEY");
4

5
const requestOptions = {
6
  method: "GET",
7
  headers: myHeaders,
8
  redirect: "follow"
9
};
10

11
fetch("https://api.quicknode.com/v0/endpoints?limit=20&offset=0", requestOptions)
12
  .then((response) => response.text())
13
  .then((result) => console.log(result))
14
  .catch((error) => console.error(error));

1
const myHeaders = new Headers();
2
myHeaders.append("accept", "application/json");
3
myHeaders.append("x-api-key", "YOUR_API_KEY");
4

5
const requestOptions = {
6
  method: "GET",
7
  headers: myHeaders,
8
  redirect: "follow"
9
};
10

11
fetch("https://api.quicknode.com/v0/endpoints?limit=20&offset=0", requestOptions)
12
  .then((response) => response.text())
13
  .then((result) => console.log(result))
14
  .catch((error) => console.error(error));

1
import requests
2

3
url = "https://api.quicknode.com/v0/endpoints?limit=20&offset=0"
4

5
payload = {}
6
headers = {
7
  'accept': 'application/json',
8
  'x-api-key': 'YOUR_API_KEY',
9
}
10

11
response = requests.request("GET", url, headers=headers, data=payload)
12

13
print(response.text)
14

1
import requests
2

3
url = "https://api.quicknode.com/v0/endpoints?limit=20&offset=0"
4

5
payload = {}
6
headers = {
7
  'accept': 'application/json',
8
  'x-api-key': 'YOUR_API_KEY',
9
}
10

11
response = requests.request("GET", url, headers=headers, data=payload)
12

13
print(response.text)
14

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

4
url = URI("https://api.quicknode.com/v0/endpoints?limit=20&offset=0")
5

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

9
request = Net::HTTP::Get.new(url)
10
request["accept"] = "application/json"
11
request["x-api-key"] = "YOUR_API_KEY"
12

13
response = https.request(request)
14
puts response.read_body
15

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

4
url = URI("https://api.quicknode.com/v0/endpoints?limit=20&offset=0")
5

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

9
request = Net::HTTP::Get.new(url)
10
request["accept"] = "application/json"
11
request["x-api-key"] = "YOUR_API_KEY"
12

13
response = https.request(request)
14
puts response.read_body
15

1
qn endpoint list --network mainnet --status active --label prod --limit 50 -o json

1
qn endpoint list --network mainnet --status active --label prod --limit 50 -o json

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

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

5
const response = await qn.admin.getEndpoints({ limit: 20 })
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.admin.getEndpoints({ limit: 20 })
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.admin.get_endpoints(limit=20)
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.admin.get_endpoints(limit=20)
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.admin.get_endpoints(limit: 20)
6
puts response
7

1
require "quicknode_sdk"
2

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

5
response = qn.admin.get_endpoints(limit: 20)
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.admin.get_endpoints(&Default::default()).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.admin.get_endpoints(&Default::default()).await?;
7

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

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free