GET
/
node_updates
{
  "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
  }
}

​
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

  1. 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
  2. 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.

name
string

Name of the node update

category
string

Node update category

chain
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”)

description
string

Node update description

repo_name
string

Name of repository that contains the update code

tag
string

Node update tag. The Tag contains the update version

network
string

Node update network (mainnet, testnet, devnet)

client
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”)

release_date
integer

Release date of the update (unix epoch timestamp)

release_notes_url
string

Link to GitHub repository release notes

version
string

Version of the node update

commit_hash
string

Commit hash of the node update

priority
string

Priority level of the node update

prerequisites
array

Array of prerequisites for the node update

breaking_changes
boolean

Boolean indicating if the update has breaking changes

breaking_change_summary
string

Summary of the breaking changes

upcoming_network_upgrade
string

Information about any upcoming network upgrades

required_for_upcoming_upgrade
boolean

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

page_size
integer

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

page
integer

Page number