Check if the account is ready to issue a block.

GET 
/api/core/v3/accounts/:bech32Address/congestion

Check the readiness of the node to issue a new block, the reference mana cost based on the rate setter and current network congestion, and the block issuance credits of the requested account.

Request

Path Parameters

bech32Address stringrequired
The Account Address in bech32.
Example: rms1pqm4xk8e9ny5w5rxjkvtp249tfhlwvcshyr3pc0665jvp7g3hc875k538hl

Responses

200

Successful operation.

application/json

Schema

Schema

slot integerrequired

The slot index for which the congestion estimate is provided.

ready booleanrequired

Indicates if a node is ready to issue a block in a current congestion or should wait.

referenceManaCost stringrequired

The cost in mana for issuing a block in a current congestion estimated based on RMC and slot index.

blockIssuanceCredits stringrequired

The Block Issuance Credits of the requested account.

Example (from schema)

{
  "slot": 0,
  "ready": true,
  "referenceManaCost": "string",
  "blockIssuanceCredits": "string"
}

CongestionResponse

{
  "slot": 20,
  "ready": true,
  "referenceManaCost": "50000",
  "blockIssuanceCredits": "10000000"
}

400

Unsuccessful operation: indicates that the provided data is invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

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"
  }
}

503

Unsuccessful operation: indicates that the node is not synced.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 503,
    "message": "service unavailable"
  }
}

Loading...