Returns general information about the node.

GET 
/api/core/v3/info

Returns general information about the node.

Responses

200

Successful operation.

application/json

Schema

Schema

name stringrequired

The name of the node.

version stringrequired

The semantic version of the node.

status required

Status of the node.

isHealthy booleanrequired

Tells whether the node is healthy or not.

acceptedTangleTime stringrequired

A notion of time that is anchored to the latest accepted block. It's in nanosecond-precision.

relativeAcceptedTangleTime stringrequired

The time after Accepted Tangle Time has advanced with the system clock. It's in nanosecond-precision.

confirmedTangleTime stringrequired

A notion of time that is anchored to the latest confirmed block. It's in nanosecond-precision.

relativeConfirmedTangleTime stringrequired

The time after Confirmed Tangle Time has advanced with the system clock. It's in nanosecond-precision.

latestCommitmentId stringrequired

The latest slot that the node has committed to.

latestFinalizedSlot integerrequired

The index of the latest finalized slot.

latestAcceptedBlockSlot integerrequired

The slot index of the latest accepted block.

latestConfirmedBlockSlot integerrequired

The slot index of the latest confirmed block.

pruningEpoch integerrequired

The index of the slot before which the tangle history is pruned.

metrics required

Node metrics.

blocksPerSecond floatrequired

The current rate of new blocks per second.

confirmedBlocksPerSecond floatrequired

The current rate of confirmed blocks per second.

confirmationRate floatrequired

The ratio of confirmed blocks to new blocks of the last confirmed slot.

protocolParameters object[]required
baseToken required

Gives info about the base token the network uses.

name stringrequired

The name of the base token of the network.

tickerSymbol stringrequired

Ticker symbol of the token to be displayed on trading platforms.

unit stringrequired

The primary unit of the token.

subunit string

The name of the smallest possible denomination of the primary unit. subunit * 10^decimals = unit

decimals integerrequired

Number of decimals the primary unit is divisible up to.

Example (from schema)

{
  "name": "string",
  "version": "string",
  "status": {
    "isHealthy": true,
    "acceptedTangleTime": "string",
    "relativeAcceptedTangleTime": "string",
    "confirmedTangleTime": "string",
    "relativeConfirmedTangleTime": "string",
    "latestCommitmentId": "string",
    "latestFinalizedSlot": 0,
    "latestAcceptedBlockSlot": 0,
    "latestConfirmedBlockSlot": 0,
    "pruningEpoch": 0
  },
  "metrics": {
    "blocksPerSecond": "string",
    "confirmedBlocksPerSecond": "string",
    "confirmationRate": "string"
  },
  "protocolParameters": [
    {
      "startEpoch": 0,
      "parameters": {
        "type": 0,
        "version": 0,
        "networkName": "string",
        "bech32Hrp": "string",
        "storageScoreParameters": {
          "storageCost": "string",
          "factorData": 0,
          "offsetOutputOverhead": "string",
          "offsetEd25519BlockIssuerKey": "string",
          "offsetStakingFeature": "string",
          "offsetDelegation": "string"
        },
        "workScoreParameters": {
          "dataByte": 0,
          "block": 0,
          "input": 0,
          "contextInput": 0,
          "output": 0,
          "nativeToken": 0,
          "staking": 0,
          "blockIssuer": 0,
          "allotment": 0,
          "signatureEd25519": 0
        },
        "manaParameters": {
          "bitsCount": 0,
          "generationRate": 0,
          "generationRateExponent": 0,
          "decayFactors": [
            0
          ],
          "decayFactorsExponent": 0,
          "decayFactorEpochsSum": 0,
          "decayFactorEpochsSumExponent": 0,
          "annualDecayFactorPercentage": 0
        },
        "tokenSupply": "string",
        "genesisSlot": 0,
        "genesisUnixTimestamp": "string",
        "slotDurationInSeconds": 0,
        "slotsPerEpochExponent": 0,
        "stakingUnbondingPeriod": 0,
        "validationBlocksPerSlot": 0,
        "punishmentEpochs": 0,
        "livenessThresholdLowerBound": 0,
        "livenessThresholdUpperBound": 0,
        "minCommittableAge": 0,
        "maxCommittableAge": 0,
        "epochNearingThreshold": 0,
        "congestionControlParameters": {
          "minReferenceManaCost": "string",
          "increase": "string",
          "decrease": "string",
          "increaseThreshold": 0,
          "decreaseThreshold": 0,
          "schedulerRate": 0,
          "maxBufferSize": 0,
          "maxValidationBufferSize": 0
        },
        "versionSignalingParameters": {
          "windowSize": 0,
          "windowTargetRatio": 0,
          "activationOffset": 0
        },
        "rewardsParameters": {
          "profitMarginExponent": 0,
          "bootstrappingDuration": 0,
          "rewardToGenerationRatio": 0,
          "initialTargetRewardsRate": "string",
          "finalTargetRewardsRate": "string",
          "poolCoefficientExponent": 0,
          "retentionPeriod": 0
        },
        "targetCommitteeSize": 0,
        "chainSwitchingThreshold": 0
      }
    }
  ],
  "baseToken": {
    "name": "string",
    "tickerSymbol": "string",
    "unit": "string",
    "subunit": "string",
    "decimals": 0
  }
}

default

{
  "name": "test",
  "version": "2.0.0",
  "status": {
    "isHealthy": false,
    "acceptedTangleTime": "1690879505000000000",
    "relativeAcceptedTangleTime": "1690879505000000000",
    "confirmedTangleTime": "1690879505000000000",
    "relativeConfirmedTangleTime": "1690879505000000000",
    "latestCommitmentId": "0xf35c9c906190e9fb02b7969ea69567e5a4bbfdbcc389f93e2b5d0c105e03979aed5b248e",
    "latestFinalizedSlot": 1,
    "latestAcceptedBlockSlot": 2,
    "latestConfirmedBlockSlot": 3,
    "pruningEpoch": 4
  },
  "metrics": {
    "blocksPerSecond": "1.1E+00",
    "confirmedBlocksPerSecond": "2.2E+00",
    "confirmationRate": "3.3E+00"
  },
  "protocolParameters": [
    {
      "startEpoch": 0,
      "parameters": {
        "type": 0,
        "version": 3,
        "networkName": "testnet",
        "bech32Hrp": "rms",
        "storageScoreParameters": {
          "storageCost": "100",
          "factorData": 1,
          "offsetOutputOverhead": "10",
          "offsetEd25519BlockIssuerKey": "100",
          "offsetStakingFeature": "100",
          "offsetDelegation": "100"
        },
        "workScoreParameters": {
          "dataByte": 1,
          "block": 2,
          "input": 3,
          "contextInput": 4,
          "output": 5,
          "nativeToken": 6,
          "staking": 7,
          "blockIssuer": 8,
          "allotment": 9,
          "signatureEd25519": 10
        },
        "manaParameters": {
          "bitsCount": 63,
          "generationRate": 1,
          "generationRateExponent": 17,
          "decayFactors": [
            10,
            20
          ],
          "decayFactorsExponent": 32,
          "decayFactorEpochsSum": 2262417561,
          "decayFactorEpochsSumExponent": 21,
          "annualDecayFactorPercentage": 70
        },
        "tokenSupply": "1813620509061365",
        "genesisSlot": 0,
        "genesisUnixTimestamp": "1695275822",
        "slotDurationInSeconds": 10,
        "slotsPerEpochExponent": 13,
        "stakingUnbondingPeriod": 10,
        "validationBlocksPerSlot": 10,
        "punishmentEpochs": 10,
        "livenessThresholdLowerBound": 15,
        "livenessThresholdUpperBound": 30,
        "minCommittableAge": 10,
        "maxCommittableAge": 20,
        "epochNearingThreshold": 60,
        "congestionControlParameters": {
          "minReferenceManaCost": "1",
          "increase": "0",
          "decrease": "0",
          "increaseThreshold": 800000,
          "decreaseThreshold": 500000,
          "schedulerRate": 100000,
          "maxBufferSize": 1000,
          "maxValidationBufferSize": 100
        },
        "versionSignalingParameters": {
          "windowSize": 7,
          "windowTargetRatio": 5,
          "activationOffset": 7
        },
        "rewardsParameters": {
          "profitMarginExponent": 8,
          "bootstrappingDuration": 1079,
          "rewardToGenerationRatio": 5,
          "initialTargetRewardsRate": "10",
          "finalTargetRewardsRate": "20",
          "poolCoefficientExponent": 11,
          "retentionPeriod": 384
        },
        "targetCommitteeSize": 32,
        "chainSwitchingThreshold": 3
      }
    }
  ],
  "baseToken": {
    "name": "Shimmer",
    "tickerSymbol": "SMR",
    "unit": "SMR",
    "subunit": "glow",
    "decimals": 6
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

Loading...