Return the information of committee members.

GET 
http://127.0.0.1:14265/api/core/v3/committee

Return the information of committee members at the given epoch index. If epoch index is not provided, the current committee members are returned.

Request

Query Parameters

epochIndex integer
The epoch index to query.
Example: 20

Responses

200

Successful operation.

application/json

Schema

Schema

epoch integer

The epoch index of the committee.

totalStake string

The total amount of delegated and staked IOTA tokens in the selected committee.

totalValidatorStake string

The total amount of staked IOTA tokens in the selected committee.

committee object[]
The validators of the committee.
Array [
oneOf
CommitteeMember
address string
The account address of the validator.
poolStake string
The total stake of the pool, including delegators.
validatorStake string
The stake of a validator.
fixedCost string
The fixed cost of the validator, which it receives as part of its Mana rewards.
]

Example (from schema)

{
  "epoch": 0,
  "totalStake": "string",
  "totalValidatorStake": "string",
  "committee": [
    null
  ]
}

CommitteeResponse

{
  "epoch": 10,
  "totalStake": "900000000",
  "totalValidatorStake": "60000000",
  "committee": [
    {
      "address": "rms1pqm4xk8e9ny5w5rxjkvtp249tfhlwvcshyr3pc0665jvp7g3hc875k538hl",
      "poolStake": "200000",
      "validatorStake": "100000",
      "fixedCost": "50000"
    },
    {
      "address": "rms1pp4wuuz0y42caz48vv876qfpmffswsvg40zz8v79sy8cp0jfxm4kunflcgt",
      "poolStake": "205000",
      "validatorStake": "90000",
      "fixedCost": "52000"
    }
  ]
}

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'http://127.0.0.1:14265/api/core/v3/committee' \
-H 'Accept: application/json'

Request Collapse all

Base URL

http://127.0.0.1:14265

Parameters

epochIndex — query

ResponseClear

Click the Send API Request button above and see the response here!