API Reference

Returns validators for your organization (via API key). All Figment validators created through Create Validators are automatically returned. Non-Figment validators first need to be tracked (see Track Validator).

Use include_fields to get extra information. For example to get exit messages for the validator, append ?include_fields=exit_message to the request. See below for all the fields that can be included.

A few noteworthy response fields:

  • status: refer to the Lifecycle of a Validator guide
  • status_history returns an array of all status transitions.
  • estimates for:
    • when a validator will become active (estimated_active_at)
    • when it will exit (estimated_exit_at)
    • and when the principal will be withdrawable (estimated_withdrawal_at)
Language