openapi: 3.2.0
info:
  version: 1.0.0
  title: Staking General API
  description: 'The Blockdaemon Staking API simplifies and streamlines institutional cryptocurrency staking. The API allows developers to interact with blockchain networks and perform various staking-related operations, such as delegating and undelegating tokens, in a single, unified interface.


    With the Staking API, you can quickly and easily build and deploy applications that automate staking activities and increase efficiency in your blockchain operations.'
  contact:
    name: Blockdaemon
    email: info@blockdaemon.com
    url: https://blockdaemon.com
  x-logo:
    url: https://assets-global.website-files.com/633c5e06513fa35f3391a5f9/645d33beb6fa65f6cfb95eb8_BD%20Logo%20Stack%20-%20Purple.svg
    backgroundColor: '#fafafa'
    altText: Blockdaemon logo
servers:
- url: https://svc.blockdaemon.com/boss
security:
- ApiKeyAuth: []
tags:
- name: General
  description: General endpoints
paths:
  /v1/plans:
    get:
      summary: List of customer's staking plans
      operationId: listCustomerPlans
      tags:
      - General
      description: 'This endpoint allows you to get a list of your staking plans.


        Staking plans are created by Blockdaemon on your behalf. They are a means to deploy white-label validators or get access to public Blockdaemon validators (depending on the protocol being used in the staking API).


        If you do not yet have a staking plan, please contact Blockdaemon sales to get started with our industry-leading staking API.'
      parameters:
      - $ref: '#/components/parameters/MevEnabled'
      - $ref: '#/components/parameters/ClientID'
      - $ref: '#/components/parameters/Protocols'
      - $ref: '#/components/parameters/Networks'
      - $ref: '#/components/parameters/Providers'
      - $ref: '#/components/parameters/Regions'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          $ref: '#/components/responses/ListPlans'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
  /v1/stake-intents:
    get:
      summary: List Your Stake Intents
      operationId: listStakeIntents
      tags:
      - General
      description: Retrieve a list of all outstanding stake intents.
      parameters:
      - name: protocols
        in: query
        required: false
        description: Protocol(s) to list stake intents for (one per argument).
        schema:
          type: array
          items:
            $ref: '#/components/schemas/Protocol'
      - name: networks
        in: query
        required: false
        description: Network(s) to list stake intents for (one per argument).
        schema:
          type: array
          items:
            $ref: '#/components/schemas/Network'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PerPage'
      - name: from_time
        in: query
        required: false
        description: Filter stake intents created on or after this time.
        schema:
          $ref: '#/components/schemas/Timestamp'
      - name: to_time
        in: query
        required: false
        description: Filter stake intents created on or before this time.
        schema:
          $ref: '#/components/schemas/Timestamp'
      responses:
        '200':
          $ref: '#/components/responses/ListStakeIntents'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
components:
  schemas:
    StakeIntentCosmos:
      type: object
      description: Cosmos Stake Intent response
      required:
      - unsigned_transaction
      - amount
      - delegator_address
      - validator_address
      properties:
        unsigned_transaction:
          $ref: '#/components/schemas/UnsignedTransaction'
        delegator_address:
          $ref: '#/components/schemas/CosmosAccountAddress'
        validator_address:
          $ref: '#/components/schemas/CosmosAccountAddress'
        amount:
          $ref: '#/components/schemas/CosmosUatom'
        hex_transaction:
          $ref: '#/components/schemas/ProcessedComosTransaction'
    Region:
      description: cloud provider's zone code
      type: string
    Relay:
      type: string
      format: uri
      description: Relay url
    PlanId:
      type: string
      description: This feature enables you to stake to validators from the specified plan(s). When no plan id is specified, validators across all plans that match the API route will be available for staking. If it is a shared plan, you can to stake to validators on a shared node from the specified plan.
      example: plan_Wgx98Rbi8nQuL9ddn3mTk1
    StakeIntentEthereumStake:
      type: object
      description: Individual Ethereum Stake Response
      required:
      - stake_id
      - amount
      - validator_public_key
      - withdrawal_credentials
      - fee_recipient
      properties:
        stake_id:
          $ref: '#/components/schemas/StakeId'
        amount:
          $ref: '#/components/schemas/Gwei'
        validator_public_key:
          $ref: '#/components/schemas/PublicKey'
        withdrawal_credentials:
          $ref: '#/components/schemas/EthereumWithdrawalCredentials'
        fee_recipient:
          $ref: '#/components/schemas/FeeRecipient'
    Network:
      type: string
      description: Protocol-specific network.
      enum:
      - mainnet
      - localnet
      - goerli
      - prater
      - hoodi
      - testnet
      - devnet
      - kusama
      - westend
      - preprod
      - fuji
      - local
    UnsignedTransactionHash:
      type: string
      format: base64
      description: A generated transaction that is ready to sign.
      example: '120000007465737477616c6c65742e746573746e65740025150c44ecddfe779c2ca '
    StakeIntentAvalanche:
      type: object
      description: Avalanche Stake Intent
      required:
      - validator_address
      - unsigned_transaction
      - amount
      - delegator_address
      - start_time
      - end_time
      properties:
        validator_address:
          $ref: '#/components/schemas/AvalancheValidatorAddress'
        unsigned_transaction:
          $ref: '#/components/schemas/UnsignedTransaction'
          example: 120000007465737477616c6c65742e746573746e65740025150c44ecddfe779c2ca624cae002ef5bf6efbb9167fe3920d6595163574dc585ca49a33e2f0000170000006e6f64656173792e706f6f6c2e663836333937332e6d308e9076d7ec46d5c1d876bb5461c4a31469d50825695a1a23ee873ed532cadb2f0100000002110000006465706f7369745f616e645f7374616b65020000007b7d00c06e31d9100100000000e4d20cc8dcd2b7520000000000
        amount:
          $ref: '#/components/schemas/AvalancheNano'
        delegator_address:
          $ref: '#/components/schemas/AvalancheAddress'
        start_time:
          $ref: '#/components/schemas/AvalancheStakingTimestamp'
          description: Avalanche staking start time
        end_time:
          $ref: '#/components/schemas/AvalancheStakingTimestamp'
          description: Avalanche staking end time
    Relays:
      type: array
      description: List of Relay urls
      items:
        $ref: '#/components/schemas/Relay'
      minItems: 1
    AvalancheNano:
      type: string
      description: Denomination of Avalanche.
      pattern: ^[1-9]\d+$
      example: '10000000000'
    Minimum:
      description: minimum number of validators to be available. required for white label plans
      type: integer
      format: int64
    TotalPending:
      description: total number of pending validators in a staking plan
      type: integer
      format: int64
    NearAddress:
      type: string
      description: Base58 encoded public key or registered named account. [Accounts](https://docs.near.org/concepts/basics/accounts/account-id/).
      pattern: ^([a-km-zA-HJ-NP-Z1-9]{22,44})|((([a-z\d]+[-_])*[a-z\d]+\.)*([a-z\d]+[-_])*[a-z\d]+)$
      example: alice.near
    EthereumAddress:
      type: string
      description: Hex-encoded Ethereum [account or smart contract address](https://ethereum.org/en/developers/docs/accounts/).
      format: hex
      pattern: ^0x[a-fA-F0-9]{40}$
      example: '0x00000000219ab540356cBB839Cbe05303d7705Fa'
    Lamport:
      type: string
      description: Denomination of the cryptocurrency Solana.
      pattern: ^[1-9]\d+$
      example: '100'
    ExpirationTime:
      type: integer
      description: Transaction expiration time
      format: int64
      example: 1689939023
    NearPublicKey:
      type: string
      description: Base58 encoded public key prefixed by ed25519, associated with the private key that will be used to sign the transaction.
      example: ed25519:Cxg2wgFYrdLTEkMu6j5D6aEZqTb3kXbmJygS48ZKbo1S
      pattern: ^ed25519:[a-km-zA-HJ-NP-Z1-9]{22,44}$
    AvalancheValidatorAddress:
      type: string
      description: Avalanche validator node address
      pattern: ^NodeID-[A-Za-z0-9]{43}$
      example: NodeID-B19uSxUKerjjnA215czAJLHMqNJMbsAMWuSxUKerjjW
    RemoteSigner:
      type: object
      properties:
        public_keys:
          type: array
          items:
            $ref: '#/components/schemas/PublicKey'
        url:
          type: string
    PlanAvalancheConfig:
      type: object
      description: Avalanche staking plan config
      required:
      - validator_address
      properties:
        validator_address:
          type: object
          required:
          - mainnet
          - fuji
          properties:
            mainnet:
              $ref: '#/components/schemas/AvalancheValidatorAddress'
            fuji:
              $ref: '#/components/schemas/AvalancheValidatorAddress'
    Plan:
      type: object
      description: staking plan for validators
      required:
      - id
      - protocol
      - network
      - config
      - customer_id
      - staking_plan_type
      - title
      properties:
        id:
          $ref: '#/components/schemas/PlanId'
        customer_id:
          $ref: '#/components/schemas/CustomerId'
        protocol:
          $ref: '#/components/schemas/Protocol'
        network:
          $ref: '#/components/schemas/Network'
        provider:
          $ref: '#/components/schemas/Provider'
        region:
          $ref: '#/components/schemas/Region'
        minimum:
          $ref: '#/components/schemas/Minimum'
        config:
          x-go-type: interface{}
          oneOf:
          - $ref: '#/components/schemas/PlanEthereumConfig'
          - $ref: '#/components/schemas/PlanSolanaConfig'
          - $ref: '#/components/schemas/PlanPolygonConfig'
          - $ref: '#/components/schemas/PlanCardanoConfig'
          - $ref: '#/components/schemas/PlanAvalancheConfig'
          - $ref: '#/components/schemas/PlanCosmosConfig'
          - $ref: '#/components/schemas/PlanBinanceConfig'
        total_pending:
          $ref: '#/components/schemas/TotalPending'
        total_available:
          $ref: '#/components/schemas/TotalAvailable'
        total_active:
          $ref: '#/components/schemas/TotalActive'
        staking_plan_type:
          $ref: '#/components/schemas/StakingPlanType'
        title:
          $ref: '#/components/schemas/PlanTitle'
        total_reserved:
          $ref: '#/components/schemas/TotalReserved'
        sync_status:
          $ref: '#/components/schemas/sync_status'
        supported_withdrawal_types:
          $ref: '#/components/schemas/ListWithdrawalType'
    StakeIntentId:
      type: string
      format: base58
      description: Unique idenifier for a group of stakes.
      example: stake_intent_Wgx98Rbi8nQuL9ddn3mTk1
    TotalReserved:
      description: total number of reserved validators in a staking plan
      type: integer
      format: int64
    CustomerId:
      type: string
      description: Unique identifier for a customer
      example: SatoshiNakamoto-xUYJbPw9hw
      minimum: 1
    BinanceAccountAddress:
      type: string
      description: Binance beacon chain address.
      format: bech32
      pattern: ^bnb[0-9a-z]+$
      example: bnb13ym5szfmwh0wz9j8wr2lu2gaml94h895u9el2e
    StakeIntentList:
      type: object
      required:
      - stake_intents
      - pagination
      properties:
        stake_intents:
          type: array
          description: List of stake intents
          items:
            $ref: '#/components/schemas/StakeIntent'
        pagination:
          $ref: '#/components/schemas/Pagination'
    PlanSolanaConfig:
      type: object
      description: Solana staking plan config
      required:
      - validator_address
      properties:
        validator_address:
          type: object
          required:
          - mainnet
          - testnet
          properties:
            mainnet:
              $ref: '#/components/schemas/SolanaPublicKey'
            testnet:
              $ref: '#/components/schemas/SolanaPublicKey'
    Protocol:
      type: string
      description: Blockchain protocol.
      enum:
      - ethereum
      - polkadot
      - solana
      - cosmos
      - polygon
      - near
      - cardano
      - avalanche
      - binance
    ExecutionClient:
      type: string
      description: The execution client to use on the node
      enum:
      - geth
      - besu
      - nethermind
    AvalancheAddress:
      type: string
      description: Avalanche platform chain address
      pattern: ^([P]|[a-km-zA-HJ-NP-Z1-9]{36,72})-[a-zA-Z]{1,83}1[qpzry9x8gf2tvdw0s3jn54khce6mua7l]{38}$
      example: P-fuji1g2g0jxcfn5sp59ld7g0t0tp4jrqppvqcfqc7hy
    WithdrawalType:
      type: string
      description: 'Specifies the type of validator withdrawal credential. - `0x01`: Standard withdrawal type with manual reward management. - `0x02`: Auto-compounding withdrawal type, allowing higher staking limits and requiring manual skimming for early reward access.

        '
      enum:
      - '0x01'
      - '0x02'
    ProcessedComosTransaction:
      type: object
      description: Returns back the transactionHash and unsignedTxHex for signing purposes
      required:
      - transactionHash
      - unsignedTxHex
      properties:
        transaction_hash:
          type: string
          description: The SHA-256 hash of the signable transaction in hexadecimal format.
          example: BD2B84693A0AE959C63A8D4D1F77125449312EED64E53C654D2D7F07E4592BAE
        unsigned_transaction_hex:
          type: string
          description: The original unsigned transaction encoded in hexadecimal format.
          example: APOENA93A0AE959C63A8D4D1F77125449312EED64E53C654D2D7F07E4592BAAF
    PlanInventoryType:
      type: string
      description: Indicates if the quantity of validators for the staking plan is static or dynamic. Static is a once off deployment of a specified quantity of validators. Dynamic is where an initial quantity of validators is deployed with a threshold of available validators also configured. If the number of available validators within the validator inventory drops below the threshold (by being reserved as part of a stake intents API call) then the dynamic plan will automatically deploy the required infrastructure to bring the number of available validators above the threshold.
      enum:
      - static
      - dynamic
      - remote_signer
    Error:
      type: object
      description: Error response envelope
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
          description: Error code
          example: 500
        message:
          type: string
          description: Error Message
          example: A descriptive error message
    PublicKey:
      type: string
      description: A BLS public Key.
      format: base64
      example: '0xa1d1ad0714035353258038e964ae9675dc0252ee22cea896825c01458e1807bfad2f9969338798548d9858a571f7425c'
    PlanCosmosConfig:
      type: object
      description: Cosmos staking plan config
      required:
      - validator_address
      properties:
        validator_address:
          type: object
          required:
          - mainnet
          - testnet
          properties:
            mainnet:
              $ref: '#/components/schemas/CosmosAccountAddress'
            testnet:
              $ref: '#/components/schemas/CosmosAccountAddress'
    StakeIntentPolygon:
      type: object
      description: Polygon Stake Intent
      required:
      - to
      - unsigned_transaction
      - amount
      - wallet_address
      properties:
        to:
          $ref: '#/components/schemas/EthereumAddress'
        unsigned_transaction:
          $ref: '#/components/schemas/UnsignedTransaction'
        amount:
          $ref: '#/components/schemas/Wei'
        wallet_address:
          $ref: '#/components/schemas/EthereumAddress'
    TotalAvailable:
      description: total number of available validators in a staking plan
      type: integer
      format: int64
    PlanPolygonConfig:
      type: object
      description: Polygon staking plan config
      required:
      - validator_share_address
      properties:
        validator_share_address:
          type: object
          required:
          - mainnet
          - testnet
          properties:
            mainnet:
              $ref: '#/components/schemas/EthereumAddress'
            testnet:
              $ref: '#/components/schemas/EthereumAddress'
    PlanTitle:
      type: string
      description: Plan title for display purposes
    Mev:
      type: object
      properties:
        id:
          type: string
          description: ID of the MEV fee recipient. optional
        enabled:
          type: boolean
        relays:
          $ref: '#/components/schemas/Relays'
    sync_status:
      description: Indicates node's sync status
      type: boolean
    Wei:
      type: string
      description: Denomination of the cryptocurrency Polygon.
      pattern: ^[1-9]\d+$
      example: '100'
    AvalancheStakingTimestamp:
      type: integer
      description: Avalanche staking start time
      format: int64
      example: 1689939023
    UnsignedTransaction:
      type: string
      format: base64
      description: Generated unsigned transaction smart contract call data.
      example: '0x22895118000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000e00000000000000000000000000000000000000000000000000000000000000120087fed394b43849eebef1e88873cd9efdbe33136656e5148e659b8b2f33625d40000000000000000000000000000000000000000000000000000000000000030b81748644e23c4d950f9dd709f3eb73d5eacd9657997e1d9dde7c4ebd8a6519ecb9d0a7fb603d3b68e023278f9650122000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000020010000000000000000000000c509bb854c526af4cee5e037089f7aa8e091d8870000000000000000000000000000000000000000000000000000000000000060b36b79b4b206c0310472c117fa40c05342b5dc3e89f98f42c9da3ce6450d4c603cad55248017fd4eca3ab277cca64569193e4d487f5b2ea78a2bcdc81926c313c05842a3af318967a775783bba22519e8b8886587efa99aa7dab5784f792b187

        '
    PlanEthereumConfig:
      type: object
      description: Ethereum staking plan config
      required:
      - inventory_type
      properties:
        suggested_fee_recipient:
          type: string
          description: the suggested fee recipient address
          minimum: 1
        mev:
          $ref: '#/components/schemas/Mev'
        inventory_type:
          $ref: '#/components/schemas/PlanInventoryType'
        execution_client:
          $ref: '#/components/schemas/ExecutionClient'
        consensus_client:
          $ref: '#/components/schemas/ConsensusClient'
        remote_signer:
          $ref: '#/components/schemas/RemoteSigner'
    ConsensusClient:
      type: string
      description: The consensus client to use on the node
      enum:
      - lighthouse
      - nimbus
      - prysm
      - teku
    UnauthorizedError:
      type: object
      description: Error response envelope
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
          description: Error code
          example: 401
        message:
          type: string
          description: Error Message
          example: A human-readable diagnostic message detailing any authorization failure
    CardanoBaseAddress:
      type: string
      description: bech32 encoded base address. [Accounts](https://cips.cardano.org/cips/cip19/).
      format: bech32
      example: addr1vpu5vlrf4xkxv2qpwngf6cjhtw542ayty80v8dyr49rf5eg0yu80w
    StakeIntentCardano:
      type: object
      description: Cardano Protocol Stake Intent
      required:
      - pool_id
      - unsigned_transaction
      - base_address
      properties:
        pool_id:
          $ref: '#/components/schemas/CardanoPoolId'
        unsigned_transaction:
          $ref: '#/components/schemas/UnsignedTransaction'
        base_address:
          $ref: '#/components/schemas/CardanoBaseAddress'
    PlanBinanceConfig:
      type: object
      description: Binance staking plan config
      required:
      - validator_address
      properties:
        validator_address:
          type: object
          required:
          - mainnet
          - testnet
          properties:
            mainnet:
              $ref: '#/components/schemas/BinanceValidatorAddress'
            testnet:
              $ref: '#/components/schemas/BinanceValidatorAddress'
    CosmosUatom:
      type: string
      description: Denomination of the cryptocurrency Cosmos.
      pattern: ^[1-9]\d+$
      example: '100'
    Provider:
      description: Cloud provider which will host the node.
      x-go-type: models.ProviderID
      x-go-type-import:
        path: go.blockdaemon.com/nodeq-server/pkg/models
        name: models
    StakeIntent:
      type: object
      required:
      - stake_intent_id
      - protocol
      - network
      - customer_id
      properties:
        stake_intent_id:
          $ref: '#/components/schemas/StakeIntentId'
        protocol:
          $ref: '#/components/schemas/Protocol'
        network:
          $ref: '#/components/schemas/Network'
        ethereum:
          $ref: '#/components/schemas/StakeIntentEthereum'
        solana:
          $ref: '#/components/schemas/StakeIntentSolana'
        cosmos:
          $ref: '#/components/schemas/StakeIntentCosmos'
        binance:
          $ref: '#/components/schemas/StakeIntentBinance'
        polygon:
          $ref: '#/components/schemas/StakeIntentPolygon'
        near:
          $ref: '#/components/schemas/StakeIntentNear'
        cardano:
          $ref: '#/components/schemas/StakeIntentCardano'
        avalanche:
          $ref: '#/components/schemas/StakeIntentAvalanche'
        customer_id:
          $ref: '#/components/schemas/CustomerId'
        plan_id:
          $ref: '#/components/schemas/PlanId'
        created_at:
          $ref: '#/components/schemas/Timestamp'
        updated_at:
          $ref: '#/components/schemas/Timestamp'
    StakeIntentEthereum:
      type: object
      description: Ethereum Stake Intent response
      required:
      - stakes
      - contract_address
      - unsigned_transaction
      - estimated_gas
      - expiration_time
      properties:
        stakes:
          description: Stakes being made.
          type: array
          items:
            $ref: '#/components/schemas/StakeIntentEthereumStake'
        contract_address:
          $ref: '#/components/schemas/EthereumAddress'
        unsigned_transaction:
          $ref: '#/components/schemas/UnsignedTransaction'
        estimated_gas:
          $ref: '#/components/schemas/EthereumGas'
        expiration_time:
          $ref: '#/components/schemas/ExpirationTime'
    CosmosAccountAddress:
      type: string
      description: Public Key of an asymmetric key-pair.
      format: bech32
      pattern: ^cosmos[1-9a-zA-Z]{39}$
      example: cosmos1wvvhhfm387xvfnqshmdaunnpujjrdxznr5d5x9
    StakingPlanType:
      type: string
      description: Indicates if the staking plan requires a Blockdaemon validator launch or it is associated to a public validator.
      enum:
      - white_label
      - public
    ListWithdrawalType:
      type: array
      description: List of supported Withdrawal Types
      minItems: 1
      items:
        $ref: '#/components/schemas/WithdrawalType'
    StakeIntentBinance:
      type: object
      description: Binance Stake Intent response
      required:
      - unsigned_transaction
      - amount
      - delegator_address
      - validator_address
      properties:
        unsigned_transaction:
          $ref: '#/components/schemas/UnsignedTransaction'
        delegator_address:
          $ref: '#/components/schemas/BinanceAccountAddress'
        validator_address:
          $ref: '#/components/schemas/BinanceValidatorAddress'
        amount:
          $ref: '#/components/schemas/BinanceJager'
    EthereumWithdrawalCredentials:
      type: string
      format: hex
      pattern: ^0x0(0|1)[a-fA-F0-9]{62}$
      example: '0x0092c20062cee70389f1cb4fa566a2be5e2319ff43965db26dbaa3ce90b9df99'
      description: 'Hexadecimal encoded [withdrawal credentials](https://github.com/ethereum/consensus-specs/blob/master/specs/phase0/validator.md#withdrawal-credentials) which can be either a BLS public key or an Ethereum account address.


        This parameter currently accepts ETH1 and BLS withdrawal credentials, but it is considered deprecated after the Capella/Shanghai fork. All users are now advised to use an ETH1 withdrawal address, specified through the `withdrawal_address` parameter as this is required to enable the ongoing accrual of rewards.


        For more information regarding creating withdrawal credentials, please see the official [Ethereum Launchpad FAQ](https://launchpad.ethereum.org/en/faq#withdrawal-credentials).'
    StakeIntentSolana:
      type: object
      description: Solana Stake Intent response
      required:
      - stake_id
      - amount
      - validator_public_key
      - withdrawal_authority
      - staking_authority
      - stake_account_public_key
      - unsigned_transaction
      - expiration_time
      properties:
        stake_id:
          $ref: '#/components/schemas/StakeId'
        amount:
          $ref: '#/components/schemas/Lamport'
        validator_public_key:
          $ref: '#/components/schemas/PublicKey'
        staking_authority:
          $ref: '#/components/schemas/SolanaPublicKey'
        withdrawal_authority:
          $ref: '#/components/schemas/PublicKey'
        stake_account_public_key:
          $ref: '#/components/schemas/SolanaPublicKey'
        unsigned_transaction:
          $ref: '#/components/schemas/UnsignedTransaction'
        expiration_time:
          $ref: '#/components/schemas/ExpirationTime'
    FeeRecipient:
      type: string
      description: An Ethereum address to receive transaction fees from published blocks. 20-bytes, hex encoded with 0x prefix, case insensitive.
      example: '0x93247f2209abcacf57b75a51dafae777f9dd38bc'
      pattern: ^0x[a-fA-F0-9]{40}$
    Gwei:
      type: string
      description: Amount of ETH (denominated in Gwei).
      pattern: ^[1-9]\d{10,}$
      example: '32000000000'
    Pagination:
      type: object
      description: encapsulates pagination properties
      required:
      - page
      - per_page
      - total
      properties:
        page:
          description: current page number
          type: integer
          format: int64
        per_page:
          description: number of results per page
          type: integer
          format: int64
        total:
          description: total number of results
          type: integer
          format: int64
    PlanCardanoConfig:
      type: object
      description: Cardano staking plan config
      required:
      - stake_pool_id
      properties:
        stake_pool_id:
          type: object
          required:
          - mainnet
          - preprod
          properties:
            mainnet:
              $ref: '#/components/schemas/CardanoPoolId'
            preprod:
              $ref: '#/components/schemas/CardanoPoolId'
    NearYocto:
      type: string
      description: Denomination of NEAR Protocol.
      pattern: ^[1-9]\d+$
      example: '100000000000000000000000000'
    Timestamp:
      description: Timestamp
      type: string
      example: '2023-01-11 06:22:46.182'
    BinanceValidatorAddress:
      type: string
      description: Binance beacon chain validator address.
      format: bech32
      pattern: ^bva[0-9a-zA-Z]*$
      example: bva1mrpf5n5e5knn3z9qng5pnex3m9pvyhg6434j0t
    CardanoPoolId:
      type: string
      description: bech32 encoded pool id.
      format: bech32
      example: pool1ev8fwfccn8gr0zcz3uyps0t0mcrefc6s95wjc6aed3ngc86y5rk
    SolanaPublicKey:
      type: string
      description: Public Key of an asymmetric key-pair.
      format: base58
      pattern: ^[1-9A-HJ-NP-Za-km-z]{44}$
      example: 5xot9PVkphiX2adznghwrAuxGs2zeWisNSxMW6hU6Hkj
    StakeIntentNear:
      type: object
      description: NEAR Protocol Stake Intent
      required:
      - to
      - unsigned_transaction
      - unsigned_transaction_hash
      - amount
      - wallet_address
      - public_key
      - expiration_time
      properties:
        to:
          $ref: '#/components/schemas/NearAddress'
        unsigned_transaction:
          $ref: '#/components/schemas/UnsignedTransaction'
          example: 120000007465737477616c6c65742e746573746e65740025150c44ecddfe779c2ca624cae002ef5bf6efbb9167fe3920d6595163574dc585ca49a33e2f0000170000006e6f64656173792e706f6f6c2e663836333937332e6d308e9076d7ec46d5c1d876bb5461c4a31469d50825695a1a23ee873ed532cadb2f0100000002110000006465706f7369745f616e645f7374616b65020000007b7d00c06e31d9100100000000e4d20cc8dcd2b7520000000000
        unsigned_transaction_hash:
          $ref: '#/components/schemas/UnsignedTransactionHash'
        amount:
          $ref: '#/components/schemas/NearYocto'
        wallet_address:
          $ref: '#/components/schemas/NearAddress'
        public_key:
          $ref: '#/components/schemas/NearPublicKey'
        expiration_time:
          $ref: '#/components/schemas/ExpirationTime'
    StakeId:
      description: Unique stake identifier.
      type: string
      format: base58
      example: stake_Wgx98Rbi8nQuL9ddn3mTk1
    EthereumGas:
      type: integer
      description: Gas estimation of the transaction
      format: uint64
      example: 1001
    TotalActive:
      description: total number of active validators in a staking plan
      type: integer
      format: int64
    BinanceJager:
      type: string
      description: The smallest denomination of Binance Coin (BNB) is called Jager. 1 Jager =0.00000001 BNB.
      pattern: ^[1-9]\d+$
      example: '10000000000'
  responses:
    Unauthorized:
      description: Header 'X-API-Key' missing.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
    ListStakeIntents:
      description: Successful operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StakeIntentList'
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InvalidRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            type: object
            description: Error response envelope
            required:
            - code
            - message
            properties:
              code:
                type: integer
                format: int32
                description: Error code
                example: 400
              message:
                type: string
                description: Error Message
                example: Detailed human-readable diagnostic message regarding any invalid request parameters
    ListPlans:
      description: Successful operation
      content:
        application/json:
          schema:
            type: object
            required:
            - plans
            - pagination
            properties:
              pagination:
                $ref: '#/components/schemas/Pagination'
              plans:
                type: array
                items:
                  $ref: '#/components/schemas/Plan'
  parameters:
    Regions:
      name: regions
      in: query
      required: false
      description: A filter on the type of regions.
      schema:
        type: array
        items:
          $ref: '#/components/schemas/Region'
    Protocols:
      name: protocols
      in: query
      required: false
      description: A filter on the type of protocols.
      schema:
        type: array
        items:
          $ref: '#/components/schemas/Protocol'
    PerPage:
      in: query
      name: per_page
      required: false
      schema:
        type: integer
        format: int64
        minimum: 1
        maximum: 1000
        default: 250
      description: The number of items to include on a single page
    ClientID:
      name: X-Client-ID
      in: header
      description: Unique ID of the client/customer
      schema:
        type: string
        minLength: 1
      required: true
    Page:
      in: query
      name: page
      required: false
      schema:
        type: integer
        format: int64
        minimum: 1
        default: 1
      description: The result set page to view
    Providers:
      name: providers
      in: query
      required: false
      description: A filter on the type of providers.
      schema:
        type: array
        items:
          $ref: '#/components/schemas/Provider'
    Networks:
      name: networks
      in: query
      required: false
      description: A filter on the type of networks.
      schema:
        type: array
        items:
          $ref: '#/components/schemas/Network'
    MevEnabled:
      in: query
      name: mev_enabled
      required: false
      schema:
        type: boolean
      description: A filter on MEV on/off
  securitySchemes:
    ApiKeyAuth:
      description: 'When signing up for a staking account, you are provided with an API key.


        To authenticate a Staking API request, pass your API key in the `X-API-Key` header.'
      type: apiKey
      in: header
      name: X-API-KEY
x-provenance:
  method: searched
  source: https://docs.blockdaemon.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.blockdaemon.com/reference/activeexitingqueueprogress.md
  - https://docs.blockdaemon.com/reference/cancelneardeactivationintent.md
  - https://docs.blockdaemon.com/reference/cancelpolygondeactivationintent.md
  - https://docs.blockdaemon.com/reference/cancelsolanadeactivationintent.md
  - https://docs.blockdaemon.com/reference/cancelsolanawithdrawalintent.md
  - https://docs.blockdaemon.com/reference/exitethereumvalidator.md
  - https://docs.blockdaemon.com/reference/exitethereumvalidators.md
  - https://docs.blockdaemon.com/reference/generateethereumlaunchpaddeposit.md
  - https://docs.blockdaemon.com/reference/generatesignedvoluntaryexit.md
  - https://docs.blockdaemon.com/reference/getbinancedeactivatableamount.md
  - https://docs.blockdaemon.com/reference/getbinancedeactivationintents.md
  - https://docs.blockdaemon.com/reference/getbinancerestakeintents.md
  - https://docs.blockdaemon.com/reference/getcardanodeactivationintents.md
  - https://docs.blockdaemon.com/reference/getcardanorewardswithdrawalintents.md
  - https://docs.blockdaemon.com/reference/getcosmosdeactivatableamount.md
  - https://docs.blockdaemon.com/reference/getcosmosdeactivationintents.md
  - https://docs.blockdaemon.com/reference/getcosmosrestakeintents.md
  - https://docs.blockdaemon.com/reference/getcosmoswithdrawablerewardsamount.md
  - https://docs.blockdaemon.com/reference/getethwithdrawableamount.md
  - https://docs.blockdaemon.com/reference/getneardeactivatableamount.md
  - https://docs.blockdaemon.com/reference/getneardeactivationintents.md
  - https://docs.blockdaemon.com/reference/getnearwithdrawableamount.md
  - https://docs.blockdaemon.com/reference/getnearwithdrawalintents.md
  - https://docs.blockdaemon.com/reference/getpolygondeactivationintents.md
  - https://docs.blockdaemon.com/reference/getsolanadeactivatableamount.md
  - https://docs.blockdaemon.com/reference/getsolanadeactivationintents.md
  - https://docs.blockdaemon.com/reference/getsolanawithdrawableamount.md
  - https://docs.blockdaemon.com/reference/getsolanawithdrawalintents.md
  - https://docs.blockdaemon.com/reference/getstakeaccountssolana.md
  - https://docs.blockdaemon.com/reference/listcustomerplans.md
  - https://docs.blockdaemon.com/reference/listethereumexits.md
  - https://docs.blockdaemon.com/reference/liststakeintents.md
  - https://docs.blockdaemon.com/reference/pendingqueuedprogress.md
  - https://docs.blockdaemon.com/reference/postavaxstakeintent.md
  - https://docs.blockdaemon.com/reference/postbinancedeactivationintent.md
  - https://docs.blockdaemon.com/reference/postbinancerestakeintent.md
  - https://docs.blockdaemon.com/reference/postbinancestakeintent.md
  - https://docs.blockdaemon.com/reference/postcardanodeactivationintent.md
  - https://docs.blockdaemon.com/reference/postcardanorewardswithdrawalintent.md
  - https://docs.blockdaemon.com/reference/postcardanostakeintent.md
  - https://docs.blockdaemon.com/reference/postcosmosdeactivationintent.md
  - https://docs.blockdaemon.com/reference/postcosmosrestakeintent.md
  - https://docs.blockdaemon.com/reference/postcosmosrewardswithdrawalintent.md
  - https://docs.blockdaemon.com/reference/postcosmosstakeintent.md
  - https://docs.blockdaemon.com/reference/postethereumcompoundingintent.md
  - https://docs.blockdaemon.com/reference/postethereumstakeintent.md
  - https://docs.blockdaemon.com/reference/postethereumtopupintent.md
  - https://docs.blockdaemon.com/reference/postethereumwithdrawalintentexit.md
  - https://docs.blockdaemon.com/reference/postethereumwithdrawalintentpartial.md
  - https://docs.blockdaemon.com/reference/postneardeactivationintent.md
  - https://docs.blockdaemon.com/reference/postnearstakeintent.md
  - https://docs.blockdaemon.com/reference/postnearwithdrawalintent.md
  - https://docs.blockdaemon.com/reference/postpolygonbootstrappingintent.md
  - https://docs.blockdaemon.com/reference/postpolygondeactivationintent.md
  - https://docs.blockdaemon.com/reference/postpolygonrewardsrestakeintent.md
  - https://docs.blockdaemon.com/reference/postpolygonrewardswithdrawalintent.md
  - https://docs.blockdaemon.com/reference/postpolygonstakeintent.md
  - https://docs.blockdaemon.com/reference/postpolygonwithdrawalintent.md
  - https://docs.blockdaemon.com/reference/postsolanadeactivationintent.md
  - https://docs.blockdaemon.com/reference/postsolanastakeintent.md
  - https://docs.blockdaemon.com/reference/postsolanawithdrawalintent.md
  - https://docs.blockdaemon.com/reference/submittransaction.md
  merge:
    pages: 62
    deduped: 1027
    conflicts_kept_first: 0