chainstack/json-schema/chainstack-node-schema.json at main · api-evangelist/chainstack · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/chainstack/main/json-schema/chainstack-node-schema.json",
  "title": "ChainstackNode",
  "description": "Schema for a Chainstack-managed blockchain node as exposed by the Platform API.",
  "type": "object",
  "required": ["id", "name", "type", "protocol", "network", "status"],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^nd-[0-9]{3}-[0-9]{3}-[0-9]{3}$",
      "description": "Stable Chainstack node identifier."
    },
    "name": {
      "type": "string",
      "description": "Human-readable node name."
    },
    "type": {
      "type": "string",
      "enum": ["global", "dedicated", "unlimited", "trader"],
      "description": "Node deployment archetype."
    },
    "protocol": {
      "type": "string",
      "description": "Blockchain protocol (e.g. ethereum, solana, bitcoin, bnb, polygon, arbitrum, base, optimism, avalanche, ton, sui, tron, starknet, zksync, hyperliquid)."
    },
    "network": {
      "type": "string",
      "description": "Network ID this node serves (e.g. ethereum-mainnet, polygon-amoy, solana-devnet)."
    },
    "region": {
      "type": "string",
      "enum": ["us-east", "us-west", "eu-west", "eu-central", "ap-southeast", "ap-northeast"],
      "description": "Deployment region."
    },
    "status": {
      "type": "string",
      "enum": ["pending", "running", "stopped", "error", "deleting"],
      "description": "Lifecycle status of the node."
    },
    "details": {
      "type": "object",
      "description": "Per-protocol node details including HTTPS RPC URL, WSS URL, and any chain-specific properties.",
      "properties": {
        "https_endpoint": {
          "type": "string",
          "format": "uri",
          "description": "Authenticated HTTPS RPC URL."
        },
        "wss_endpoint": {
          "type": "string",
          "format": "uri",
          "description": "Authenticated WSS RPC URL."
        },
        "client": {
          "type": "string",
          "description": "Underlying node client (e.g. geth, erigon, nethermind, reth, solana-validator, bitcoin-core)."
        },
        "archive": {
          "type": "boolean",
          "description": "Whether this node serves archive (historical state) requests."
        },
        "extra_namespaces": {
          "type": "array",
          "items": {"type": "string"},
          "description": "Extended namespaces enabled on this node (e.g. debug, trace, txpool)."
        }
      }
    },
    "configuration": {
      "type": "object",
      "description": "Deployment configuration (machine size, archive add-on, MEV protection, etc.)."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}