GET
/
v1
/
nodes
curl --request GET \
  --url https://api.chainstack.com/v1/nodes/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "ND-123-456-789",
      "name": "My Polygon PoS archive node",
      "network": "NW-123-456-7",
      "organization": "RG-123-456",
      "type": "dedicated",
      "role": "peer",
      "provider": "gcloud",
      "region": "asia-southeast1",
      "status": "running",
      "configuration": {
        "archive": true
      },
      "details": {
        "mode": "archive",
        "version": "1.0.6",
        "api_namespaces": [
          "net",
          "eth",
          "web3",
          "txpool",
          "debug",
          "parlia"
        ],
        "graphql_endpoint": "https://nd-123-456-789.p2pify.com/graphql",
        "https_endpoint": "https://nd-123-456-789.p2pify.com",
        "wss_endpoint": "wss://ws-nd-123-456-789.p2pify.com",
        "auth_username": "user-name",
        "auth_password": "pass-word-pass-word-pass-word",
        "auth_key": "3c6e0b8a9c15224a8228b9a98ca1531d"
      },
      "created_at": "2020-06-15T07:38:00.747Z",
      "creator": {
        "id": "UR-111-111-111",
        "email": "john.smith@example.com",
        "first_name": "John",
        "last_name": "Smith",
        "organization": {
          "id": "RG-123-456",
          "name": "My organization"
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Chainstack API uses API keys to authenticate requests. You can view and manage your API keys in the platform UI. Your API keys carry many privileges, so be sure to keep them secure! Provide your API key as the Authorization header. The value of the header consists of Bearer prefix and secret key generated through the platform UI.

curl -X GET 'https://api.chainstack.com/v1/organization/' \
--header 'Authorization: Bearer FX7CWlLg.FMpAO8cgCX2N7s41EncRru2nb5CmTZUt'

All API requests must be made over HTTPS.

Query Parameters

​
order_by
enum<string>

Which field to use when ordering the results. <br> Use the - prefix to perform descending ordering (-name).

Available options:
name,
created_at
​
page
integer

A page number within the paginated result set.

​
project
string

Filter by project ID.

​
organization
string

Filter by organization ID.

​
network
string

Filter by network ID.

​
region
enum<string>

Filter by the region the node is deployed to.

Available options:
asia-southeast1,
ap-southeast-1,
us-west-2,
us-east-1,
uksouth,
eu3
​
provider
enum<string>

Filter by the cloud provider of the node.

Available options:
aws,
azure,
gcloud,
vzo
​
protocol
enum<string>

Filter by protocol.

Available options:
ethereum,
polygon-pos,
bsc,
avalanche,
arbitrum,
near,
aurora,
gnosis,
cronos,
fantom,
starknet,
harmony,
tezos,
fuse,
bitcoin
​
status
enum<string>

Filter by node status.

Available options:
pending,
running,
maintenance,
failed,
error,
stopping,
stopped,
starting
​
role
enum<string>

Filter by node role.

Available options:
peer
​
type
enum<string>

Filter by node type.

Available options:
shared,
dedicated
​
archive
boolean

Filter Ethereum, Polygon PoS, Binance Smart Chain, Avalanche, Fantom, and Tezos nodes by the archive mode flag.

​
public_network
enum<string>

Filter by public network.

Available options:
ethereum-mainnet,
ethereum-ropsten-testnet,
ethereum-rinkeby-testnet,
polygon-pos-mainnet,
polygon-pos-testnet,
bsc-mainnet,
bsc-testnet,
avalanche-mainnet,
avalanche-testnet,
arbitrum-mainnet,
arbitrum-goerli,
near-mainnet,
near-testnet,
aurora-mainnet,
aurora-testnet,
gnosis-mainnet,
gnosis-testnet,
cronos-mainnet,
cronos-testnet,
fantom-mainnet,
fantom-testnet,
starknet-mainnet,
starknet-testnet,
harmony-mainnet,
harmony-devnet,
tezos-mainnet,
tezos-testnet,
fuse-mainnet,
fuse-testnet,
bitcoin-mainnet,
bitcoin-testnet
Example:

"corda-network-uat"

​
name
string

Filter by name.

​
project_type
enum<string>

Filter by project type.

Available options:
public

Response

200 - application/json
​
count
integer

Number of the objects in the paginated results.

Example:

123

​
next
string | null

Link to the next page.

​
previous
string | null

Link to the previous page.

​
results
object[]