Blockchain Intelligence APIs: GET Node Updates

curl --request GET \
  --url https://api.example.com/node_updates

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/node_updates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/node_updates"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/node_updates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "result": [
    {
      "_id": "64caad9ff235e4337cabb497",
      "name": "mainnet-v1.6.3",
      "chain": "sui",
      "category": "optional",
      "description": "The upgrade includes new linter warnings for custom transfer/share/freeze functions, support for selective suppression of linter warnings, changes in unit tests handling, a new TransactionKindIn filter for querying transaction blocks, and linter warnings for object transfers.",
      "repo_name": "sui",
      "tag": "mainnet-v1.6.3",
      "network": "mainnet",
      "client": "sui",
      "release_date": 1690959709,
      "release_notes_url": "https://github.com/MystenLabs/sui/releases/tag/mainnet-v1.6.3",
      "build_artifacts": [],
      "createdAt": 1691004319,
      "updatedAt": 1691004319,
      "version": "1.6.3",
      "commit_hash": "abc123",
      "priority": "High",
      "prerequisites": ["Previous version installed"],
      "breaking_changes": false,
      "breaking_change_summary": "No breaking changes",
      "upcoming_network_upgrade": "None",
      "required_for_upcoming_upgrade": false
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 10000,
    "total_pages": 1
  }
}

{
  "error": {
    "message": "Invalid api key unauthorized",
    "status": 401
  }
}

GET

node_updates

Blockchain Intelligence APIs: GET Node Updates

curl --request GET \
  --url https://api.example.com/node_updates

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/node_updates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/node_updates"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/node_updates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "result": [
    {
      "_id": "64caad9ff235e4337cabb497",
      "name": "mainnet-v1.6.3",
      "chain": "sui",
      "category": "optional",
      "description": "The upgrade includes new linter warnings for custom transfer/share/freeze functions, support for selective suppression of linter warnings, changes in unit tests handling, a new TransactionKindIn filter for querying transaction blocks, and linter warnings for object transfers.",
      "repo_name": "sui",
      "tag": "mainnet-v1.6.3",
      "network": "mainnet",
      "client": "sui",
      "release_date": 1690959709,
      "release_notes_url": "https://github.com/MystenLabs/sui/releases/tag/mainnet-v1.6.3",
      "build_artifacts": [],
      "createdAt": 1691004319,
      "updatedAt": 1691004319,
      "version": "1.6.3",
      "commit_hash": "abc123",
      "priority": "High",
      "prerequisites": ["Previous version installed"],
      "breaking_changes": false,
      "breaking_change_summary": "No breaking changes",
      "upcoming_network_upgrade": "None",
      "required_for_upcoming_upgrade": false
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 10000,
    "total_pages": 1
  }
}

{
  "error": {
    "message": "Invalid api key unauthorized",
    "status": 401
  }
}

Using Query Parameters with GET Node Updates

To enhance your experience with our ‘GET Node Updates’ endpoint, you can use various query parameters provided by the api-query-params library. These parameters allow for advanced filtering, sorting, and pagination, helping you tailor the response to your specific needs. Below are examples demonstrating how to effectively utilize these features.

Examples of Query Parameters

Filtering by Chain and Category with Sorting: Fetch updates for Ethereum mainnet in the, sorted by the release date and priority.
GET /node-updates?chain=eth&network=mainnet&breaking_changes=true&sort=priority,-release_date
Pagination and Selective Fields:: Retrieve the second page of updates, showing 10 records per page, displaying only name, version, and release date.
GET /node-updates?page=2&page_size=10&fields=name,version,release_date

Check out the api-query-params documentation for more information on how to use these query parameters. For any questions or feedback regarding the use of query parameters with our API, feel free to reach out to our support team at support@scale3labs.com. The complete list of query parameters supported by the ‘GET Node Updates’ endpoint is provided below.

string

Name of the node update

string

Node update category

string

required

Node update chain. Supported chains include: ( “aptos”, “arb”, “atom”, “avax”, “base”, “celo”, “dot”, “eth”, “flow”, “harmony”, “kava”, “mina”, “near”, “op”, “polygon”, “sei”, “sol”, “stx”, “sui”, “vet”, “xlm”)

string

Node update description

string

Name of repository that contains the update code

string

Node update tag. The Tag contains the update version

string

Node update network (mainnet, testnet, devnet)

string

Node update client depending on the chain. For chains with no client the default value is the chain itself. Supported clients include: ( “aptos”, “atom”, “avalanchego”, “base”, “besu”, “bor”, “celo”, “flow”, “gaia”, “geth”, “harmony”, “heimdall”, “horizon”, “jito”, “kava”, “lighthouse”, “lodestar”, “mina”, “near”, “nethermind”, “nimbus”, “nitro”, “optimism”, “polkadot”, “polygon”, “rocketpool”, “sei”, “solana”, “stacks”, “sui”, “teku”, “thor”)

integer

Release date of the update (unix epoch timestamp)

string

Link to GitHub repository release notes

string

Version of the node update

string

Commit hash of the node update

string

Priority level of the node update

array

Array of prerequisites for the node update

boolean

Boolean indicating if the update has breaking changes

string

Summary of the breaking changes

string

Information about any upcoming network upgrades

boolean

Boolean indicating if the update is required for an upcoming network upgrade

integer

Size of a single page i.e how many records to send back in the response

integer

Page number

200 (OK) Response Object Schema

NodeUpdate[]

Hide Node Update Object Properties

string

required

Name of the node update

string

required

Node update category

string

required

Node update chain

string

required

Node update description

string

required

Name of repository that contains the update code

string

required

Node update tag. The Tag contains the update version

string

required

Node update network (mainnet, testnet, devnet)

string

required

Node update client depending on the chain. For chains with no client the default value is the chain itself

integer

required

Release date of the update (unix epoch timestamp)

string

required

Link to github repository release notes

BuildArtifact[]

required

Hide Build Artifact Object Properties

string

required

Build artifact type (docker, genisis or node)

string

required

Node update binary download url

string

Node update binary compatible os

string

Node update binary md5

string

Version of the node update

string

Commit hash of the node update

string

Priority level of the node update

array

Array of prerequisites for the node update

boolean

Boolean indicating if the update has breaking changes

string

Summary of the breaking changes

string

Information about any upcoming network upgrades

boolean

Boolean indicating if the update is required for an upcoming network upgrade

Metadata

required

Hide Metadata Object Properties

integer

required

Size of a single page i.e how many records to send back in the response

integer

required

Page number

integer

required

Total pages with the given page_size

APIError Response Object Schema

ApiError

Hide ApiError Object Properties

string

required

Error message

integer

required

Http status code

ApiError[]

Array of errors which led to the error

{
  "result": [
    {
      "_id": "64caad9ff235e4337cabb497",
      "name": "mainnet-v1.6.3",
      "chain": "sui",
      "category": "optional",
      "description": "The upgrade includes new linter warnings for custom transfer/share/freeze functions, support for selective suppression of linter warnings, changes in unit tests handling, a new TransactionKindIn filter for querying transaction blocks, and linter warnings for object transfers.",
      "repo_name": "sui",
      "tag": "mainnet-v1.6.3",
      "network": "mainnet",
      "client": "sui",
      "release_date": 1690959709,
      "release_notes_url": "https://github.com/MystenLabs/sui/releases/tag/mainnet-v1.6.3",
      "build_artifacts": [],
      "createdAt": 1691004319,
      "updatedAt": 1691004319,
      "version": "1.6.3",
      "commit_hash": "abc123",
      "priority": "High",
      "prerequisites": ["Previous version installed"],
      "breaking_changes": false,
      "breaking_change_summary": "No breaking changes",
      "upcoming_network_upgrade": "None",
      "required_for_upcoming_upgrade": false
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 10000,
    "total_pages": 1
  }
}

{
  "error": {
    "message": "Invalid api key unauthorized",
    "status": 401
  }
}

Home

Intel

Alerting

Monitoring

Logging

Nodepilot

Blockchain Node Setup

Command Line Interface

Blockchain Intelligence APIs: GET Node Updates

Using Query Parameters with GET Node Updates

Examples of Query Parameters

​Using Query Parameters with GET Node Updates

​Examples of Query Parameters

Using Query Parameters with GET Node Updates

Examples of Query Parameters