Skip to main content

terra_sdk.client.lcd.api.staking

RedelegationsOptions Objects​


_1
class RedelegationsOptions(PaginationOptions)

just internal class for relegation option

AsyncStakingAPI Objects​


_1
class AsyncStakingAPI(BaseAsyncAPI)

delegations​


_1
async def delegations(delegator: Optional[AccAddress] = None, validator: Optional[ValAddress] = None, params: Optional[APIParams] = None) -> (List[Delegation], dict)

Fetches current delegations, filtering by delegator, validator, or both.

Arguments:

  • delegator Optional[AccAddress], optional - delegator account address.
  • validator Optional[ValAddress], optional - validator operator address.
  • params APIParams, optional - additional params for the API like pagination

Raises:

  • TypeError - if both delegator and validator are None.

Returns:

  • List[Delegation] - delegations
  • dict - pagination info

delegation​


_1
async def delegation(delegator: AccAddress, validator: ValAddress) -> Delegation

Fetch a single delegation via a delegator, validator pair.

Arguments:

delegator (Optional[AccAddress), optional: delegator account address

  • validator Optional[ValAddress], optional - validator operator address

Returns:

  • Delegation - delegation

unbonding_delegations​


_1
async def unbonding_delegations(delegator: Optional[AccAddress] = None, validator: Optional[ValAddress] = None, params: Optional[APIParams] = None) -> (List[UnbondingDelegation], dict)

Fetches current undelegations, filtering by delegator, validator, or both.

Arguments:

  • delegator Optional[AccAddress], optional - delegator account address.
  • validator Optional[ValAddress], optional - validator operator address.
  • params APIParams, optional - additional params for the API like pagination

Raises:

  • TypeError - if both delegator and validator are None.

Returns:

  • List[UnbondingDelegation] - undelegations
  • dict - pagination info

unbonding_delegation​


_1
async def unbonding_delegation(delegator: AccAddress, validator: ValAddress) -> UnbondingDelegation

Fetch a single undelegation via a delegator, validator pair.

Arguments:

  • delegator AccAddress - delegator account address
  • validator ValAddress - validator operator address

Returns:

  • UnbondingDelegation - undelegation

redelegations​


_1
async def redelegations(delegator: Optional[AccAddress] = None, validator_src: Optional[ValAddress] = None, validator_dst: Optional[ValAddress] = None, params: Optional[APIParams] = None) -> (List[Redelegation], dict)

Fetch redelgations.

Arguments:

  • delegator Optional[AccAddress], optional - delegator account address.
  • validator_src Optional[ValAddress], optional - source validator operator address (from).
  • validator_dst Optional[ValAddress], optional - dest. validator operator address (to).
  • params APIParams, optional - additional params for the API like pagination

Returns:

  • List[Redelegation] - redelegations
  • dict - pagination info

bonded_validators​


_1
async def bonded_validators(delegator: AccAddress, params: Optional[PaginationOptions]) -> (List[Validator], dict)

Fetches the list of validators a delegator is currently delegating to.

Arguments:

  • delegator AccAddress - delegator account address
  • params APIParams, optional - additional params for the API like pagination

Returns:

  • List[Validator] - currently bonded validators
  • dict - pagination info

validators​


_1
async def validators(params: Optional[APIParams] = None) -> (List[Validator], dict)

Fetch information of all validators.

Arguments:

  • params APIParams, optional - additional params for the API like pagination

Returns:

  • List[Validator] - validator informations
  • dict - pagination info

validator​


_1
async def validator(validator: ValAddress) -> Validator

Fetch information about a single validator.

Arguments:

  • validator ValAddress - validator operator address

Returns:

  • Validator - validator information

pool​


_1
async def pool() -> StakingPool

Fetch current staking pool information.

Returns:

  • StakingPool - information about current staking pool

parameters​


_1
async def parameters() -> dict

Fetch Staking module parameters.

Returns:

  • dict - Staking module parameters