List staking requests by ID

get/api/staking/v1/requests/{stakingRequestId}

Retrieve A Specific Staking Request.

Path Parameters

  • stakingRequestIdstringRequired
    The ID for the staking request

200 Response

One of
delegations array[object]
Min items: >= 1 items
Max items: <= 1 items
id string
The staking request ID.
coin string
The staking asset.
walletId string
The ID of the wallet that the delegation is tied to.
delegationAddress string
The delegation address.
withdrawalAddress string
The withdrawal address.
delegated string
The delegation amount.
status string
The status of the delegation.
rewards string
The amount of rewards received over the lifetime.
lockedRewards string
The amount of locked rewards received.
pendingUnstake string
The amount that is pending unstake.
pendingStake string
The amount that is pending stake.
apy string
The estimated reward APY or APR if rewards are not compounding.
unstakingFee string
The total fees needed in the wallet to unstake an amount from the delegation.
unstakingMin string
The minimum amount needed to unstake from the delegation.
transactions array[object]
Min items: >= 1 items
Max items: <= 500 items
id string
The staking transaction ID.
stakingRequestId string required
The staking request ID.
transactionType string required
The transaction type (delegate).
Allowed values: delegate reward undelegate withdraw_undelegated authorize
txHash string
The transaction hash.
createdDate string <date-time>required
The date the transaction was created.
status string required
The status of the transaction, either NEW, READY, INITIATED, CONFIRMED, or REJECTED.
Allowed values: WAITING READY SENDING PENDING_APPROVAL PENDING_BITGO_TRUST_APPROVAL REJECTED PENDING FAILED CONFIRMED VALIDATOR_ACTIVATING DELAYED_READY
statusModifiedDate string <date-time>required
The last date the status changed.
error string
The reason the transaction failed.
amount string required
The transaction Amount in base units (i.e. Wei for ETH).
Example: 2000000
Match pattern: ^-?\d+$
delegationId string required
The staking delegation the transaction is acting on.
pendingApprovalId string
Pending Approval ID
transferId string
Transfer ID
txRequestId string
Transaction Request ID for the Transaction Request API
amount string
Amount to stake in base units.
id string required
Staking request ID.
clientId string
Optional clientId if passed into the request.
requestingUserId string required
The ID of the user that created the staking request.
enterpriseId string required
The ID of the enterprise where the the staking request was created.
walletId string required
The ID of the wallet where the staking request was created.
withdrawalAddress string required
Withdrawal Address
walletType string required
The type of wallet the staking request was created from either cold, custodial, or hot.
type string required
The type of staking request.
Allowed values: STAKE UNSTAKE CLAIM_REWARDS SWITCH_VALIDATOR CHECKPOINT UNSUPPORTED
coin string required
The coin to be staked (ETH, MATIC, NEAR, SOL).
createdDate string <date-time>required
The date the staking request was created.
status string required
The status of the staking request. For ETH the status will change from NEW to READY when a validator has been assigned to the wallet's address.
Allowed values: NEW PENDING_VALIDATORS READY PENDING_APPROVAL PENDING_BITGO_TRUST_APPROVAL PENDING FAILED REJECTED VALIDATOR_ACTIVATING PARTIAL_CONFIRMED CONFIRMED COOLDOWN WARMUP DELAYED_COOLDOWN DELAYED_WARMUP ETH_PARTIAL_EXITED ETH_EXITED
statusModifiedDate string required
The last date the status changed.
error string
The reason the staking request failed.
totalStaked string
The sum of the amounts of all confirmed staking transactions in this request.
Example: 2000000
Match pattern: ^-?\d+$

400 Response

error string
errorName string
reqId string
context object

401 Response

error string
errorName string
reqId string
context object

403 Response

error string
errorName string
reqId string
context object

404 Response

error string
errorName string
reqId string
context object

409 Response

error string
errorName string
reqId string
context object

500 Response

error string
errorName string
reqId string
context object