Ctrl+K

List staking requests by enterprise

get/api/staking/v1/enterprises/{enterpriseId}/requests/transactions

Retrieve staking requests and staking transactions for a given enterprise and query params.

Path Parameters

  • enterpriseIdstringRequired
    The enterprise ID.

Query Parameters

  • coinstring
    Filter by coin.
    Example: eth
  • walletTypestring
    Filter by Wallet Type (e.g. custodial, hot)
  • walletIdsarray[string]
    Wallet Ids
  • requestTypestring
    Filter by Staking Request Type
    Enum: STAKE UNSTAKE CLAIM_REWARDS SWITCH_VALIDATOR CHECKPOINT UNSUPPORTED
  • requestStatusstring
    Filter by Staking Request status
    Enum: 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
  • expandBuildParamsboolean
    True, if to include staking build params
  • pageintegerDefault: 1
    The page number for pagination.
    Minimum: >= 1
  • pageSizeintegerDefault: 20
    The page size for pagination.
    Minimum: >= 1
    Maximum: <= 100
  • sortBystringDefault: -createdDate
    Sort By field
    Enum: -createdDate createdDate

200 Response

requests
gasPrice string
User overridden gas price to apply for the generated transactions for this request. GasPrice is in base units.
delegations array[object]
Min items: >= 1 items
Max items: <= 500 items
transactions array[object]
Min items: >= 1 items
Max items: <= 500 items
amount string
Amount to stake in base units (i.e. Wei for ETH). For Ethereum the amount needs to be a multiple of 32 ETH (32000000000000000000 Wei). For Testnet the 32 ETH multiple restriction does not apply.
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+$
page integer
The page number for paging purposes.
totalPages integer
The total number of pages for paging purposes.
totalElements integer
The number of elements per page used for paging purposes.

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