openapi: 3.2.0
info:
  version: 1.0.0
  title: Staking Cardano 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: Cardano
  description: Cardano endpoints
paths:
  /v1/cardano/{network}/deactivation-intents:
    parameters:
    - $ref: '#/components/parameters/CardanoNetwork'
    post:
      summary: Post Deactivation Intent
      operationId: postCardanoDeactivationIntent
      tags:
      - Cardano
      description: Create a transaction for deactivating staked Cardano tokens.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewDeactivateIntentCardano'
      responses:
        '200':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardanoDeactivationIntentResponse'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - ApiKeyAuth: []
    get:
      summary: List Deactivation Intents
      operationId: getCardanoDeactivationIntents
      tags:
      - Cardano
      description: Retrieve a list of all outstanding deactivation intents.
      responses:
        '200':
          description: Created
          content:
            application/json:
              schema:
                type: object
                description: Deactivation intents
                required:
                - protocol
                - network
                - customer_id
                properties:
                  protocol:
                    $ref: '#/components/schemas/CardanoProtocol'
                  network:
                    $ref: '#/components/schemas/CardanoNetwork'
                  cardano:
                    $ref: '#/components/schemas/DeactivationIntentsCardano'
                  customer_id:
                    $ref: '#/components/schemas/CustomerId'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - ApiKeyAuth: []
  /v1/cardano/{network}/rewards/withdrawal-intents:
    parameters:
    - $ref: '#/components/parameters/CardanoNetwork'
    post:
      summary: Post Rewards Withdrawal Intent
      operationId: postCardanoRewardsWithdrawalIntent
      tags:
      - Cardano
      description: Creates a new withdrawal intent that withdraws only the accumulated rewards. Staked tokens stay untouched and keep earning rewards.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              x-go-type: interface{}
              oneOf:
              - $ref: '#/components/schemas/NewRewardsWithdrawIntentCardano'
      responses:
        '200':
          $ref: '#/components/responses/RewardsWithdrawIntentCardano'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - ApiKeyAuth: []
    get:
      summary: List Rewards Withdrawal Intents
      operationId: getCardanoRewardsWithdrawalIntents
      tags:
      - Cardano
      description: Retrieve a list of all outstanding rewards withdrawal intents.
      responses:
        '200':
          description: List of rewards withdraw intents.
          content:
            application/json:
              schema:
                type: object
                description: Rewards withdrawal intents.
                required:
                - protocol
                - network
                - customer_id
                properties:
                  protocol:
                    $ref: '#/components/schemas/CardanoProtocol'
                  network:
                    $ref: '#/components/schemas/CardanoNetwork'
                  cardano:
                    $ref: '#/components/schemas/RewardsWithdrawIntentsCardano'
                  customer_id:
                    $ref: '#/components/schemas/CustomerId'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - ApiKeyAuth: []
  /v1/cardano/{network}/stake-intents:
    parameters:
    - $ref: '#/components/parameters/CardanoNetwork'
    - $ref: '#/components/parameters/IdempotencyKey'
    post:
      summary: Post Stake Intent
      operationId: postCardanoStakeIntent
      tags:
      - Cardano
      description: Return an unsigned transaction that can be used to stake your tokens with the Blockdaemon staking pool.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewStakeIntentCardano'
      responses:
        '200':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardanoStakeIntentResponse'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/NoValidatorsError'
      security:
      - ApiKeyAuth: []
  /v1/cardano/{network}/transaction-submission:
    parameters:
    - $ref: '#/components/parameters/CardanoNetwork'
    post:
      summary: Broadcast Transaction
      operationId: submitTransaction
      tags:
      - Cardano
      description: Submits a signed transaction to the Cardano network.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewTransactionSubmission'
      responses:
        '200':
          description: Transaction for submission response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionSubmission'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/NoValidatorsError'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
components:
  schemas:
    DeactivationIntentsCardano:
      type: array
      description: List of deactivation intents
      items:
        type: object
        description: Cardano Protocol Deactivate Intent
        required:
        - deactivate_intent_id
        - base_address
        - unsigned_transaction
        properties:
          deactivate_intent_id:
            $ref: '#/components/schemas/DeactivateIntentId'
          base_address:
            $ref: '#/components/schemas/CardanoBaseAddress'
          unsigned_transaction:
            $ref: '#/components/schemas/UnsignedTransaction'
    CardanoStakeIntentResponse:
      allOf:
      - $ref: '#/components/schemas/CommonStakeIntentResponse'
      - type: object
        required:
        - protocol
        - network
        properties:
          protocol:
            $ref: '#/components/schemas/CardanoProtocol'
          network:
            $ref: '#/components/schemas/CardanoNetwork'
          cardano:
            $ref: '#/components/schemas/StakeIntentCardano'
    NewTransactionSubmission:
      type: object
      description: Transaction for submission
      required:
      - signed_transaction
      properties:
        signed_transaction:
          $ref: '#/components/schemas/SignedTransaction'
    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
    TransactionSubmission:
      type: object
      description: Transaction for submission response
      required:
      - protocol
      - network
      - transaction_id
      - customer_id
      properties:
        protocol:
          $ref: '#/components/schemas/CardanoProtocol'
        network:
          $ref: '#/components/schemas/CardanoNetwork'
        transaction_id:
          $ref: '#/components/schemas/TransactionId'
        customer_id:
          $ref: '#/components/schemas/CustomerId'
    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
    CardanoDeactivationIntentResponse:
      allOf:
      - $ref: '#/components/schemas/CommonDeactivationResponse'
      - type: object
        description: Response to a new deactivation intent request.
        required:
        - network
        - protocol
        - cardano
        properties:
          protocol:
            $ref: '#/components/schemas/CardanoProtocol'
          network:
            $ref: '#/components/schemas/CardanoNetwork'
          cardano:
            $ref: '#/components/schemas/DeactivateIntentCardano'
    RewardsWithdrawIntentsCardano:
      type: array
      description: List of Rewards Withdrawal Intents
      items:
        type: object
        description: Cardano Protocol Reward Withdrawal Intent
        required:
        - base_address
        - rewards_amount
        - unsigned_transaction
        properties:
          base_address:
            $ref: '#/components/schemas/CardanoBaseAddress'
          rewards_amount:
            $ref: '#/components/schemas/CardanoLovelace'
          unsigned_transaction:
            $ref: '#/components/schemas/UnsignedTransaction'
    CardanoRewardsWithdrawIntent:
      type: object
      required:
      - base_address
      - rewards_amount
      - unsigned_transaction
      properties:
        base_address:
          $ref: '#/components/schemas/CardanoBaseAddress'
        rewards_amount:
          $ref: '#/components/schemas/CardanoLovelace'
        unsigned_transaction:
          $ref: '#/components/schemas/UnsignedTransaction'
    CardanoProtocol:
      type: string
      description: Cardano protocol
      enum:
      - cardano
    NewStakeIntentCardano:
      type: object
      description: Request object to create a new stake intent for Cardano protocol
      required:
      - base_address
      properties:
        base_address:
          $ref: '#/components/schemas/CardanoBaseAddress'
        plan_id:
          $ref: '#/components/schemas/PlanId'
    StakeIntentId:
      type: string
      format: base58
      description: Unique idenifier for a group of stakes.
      example: stake_intent_Wgx98Rbi8nQuL9ddn3mTk1
    CommonDeactivationResponse:
      type: object
      required:
      - deactivate_intent_id
      - customer_id
      properties:
        deactivate_intent_id:
          $ref: '#/components/schemas/DeactivateIntentId'
        customer_id:
          $ref: '#/components/schemas/CustomerId'
    RewardsWithdrawIntentCardano:
      type: object
      required:
      - protocol
      - network
      - cardano
      - customer_id
      properties:
        protocol:
          $ref: '#/components/schemas/CardanoProtocol'
        network:
          $ref: '#/components/schemas/CardanoNetwork'
        cardano:
          $ref: '#/components/schemas/CardanoRewardsWithdrawIntent'
        customer_id:
          $ref: '#/components/schemas/CustomerId'
    CustomerId:
      type: string
      description: Unique identifier for a customer
      example: SatoshiNakamoto-xUYJbPw9hw
      minimum: 1
    CardanoPoolId:
      type: string
      description: bech32 encoded pool id.
      format: bech32
      example: pool1ev8fwfccn8gr0zcz3uyps0t0mcrefc6s95wjc6aed3ngc86y5rk
    TransactionId:
      type: string
      description: Unique identifier for a transaction
      format: base58
      example: transaction_Wgx98Rbi8nQuL9ddn3mTk1
    CardanoLovelace:
      type: string
      description: Denomination of the cryptocurrency Cardano.
      pattern: ^[1-9]\d+$
      example: '100'
    CardanoNetwork:
      type: string
      description: Cardano network
      enum:
      - mainnet
      - preprod
      - localnet
    NewRewardsWithdrawIntentCardano:
      type: object
      description: Request object to create a new rewards withdrawal intent for Cardano.
      required:
      - base_address
      properties:
        base_address:
          $ref: '#/components/schemas/CardanoBaseAddress'
    NewDeactivateIntentCardano:
      type: object
      description: Request object to create a new deactivation intent for Cardano.
      required:
      - base_address
      properties:
        base_address:
          $ref: '#/components/schemas/CardanoBaseAddress'
    UnsignedTransaction:
      type: string
      format: base64
      description: Generated unsigned transaction smart contract call data.
      example: '0x22895118000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000e00000000000000000000000000000000000000000000000000000000000000120087fed394b43849eebef1e88873cd9efdbe33136656e5148e659b8b2f33625d40000000000000000000000000000000000000000000000000000000000000030b81748644e23c4d950f9dd709f3eb73d5eacd9657997e1d9dde7c4ebd8a6519ecb9d0a7fb603d3b68e023278f9650122000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000020010000000000000000000000c509bb854c526af4cee5e037089f7aa8e091d8870000000000000000000000000000000000000000000000000000000000000060b36b79b4b206c0310472c117fa40c05342b5dc3e89f98f42c9da3ce6450d4c603cad55248017fd4eca3ab277cca64569193e4d487f5b2ea78a2bcdc81926c313c05842a3af318967a775783bba22519e8b8886587efa99aa7dab5784f792b187

        '
    CommonStakeIntentResponse:
      type: object
      required:
      - stake_intent_id
      - customer_id
      properties:
        stake_intent_id:
          $ref: '#/components/schemas/StakeIntentId'
        customer_id:
          $ref: '#/components/schemas/CustomerId'
        plan_id:
          $ref: '#/components/schemas/PlanId'
    DeactivateIntentId:
      type: string
      format: uuid
      description: Unique idenifier for deactivate intent.
      example: 4ba06e89-8c29-483e-ac36-318de5aa7364
    DeactivateIntentCardano:
      type: object
      description: Result of the new Deactivate Intent request.
      required:
      - base_address
      - unsigned_transaction
      properties:
        base_address:
          $ref: '#/components/schemas/CardanoBaseAddress'
        unsigned_transaction:
          $ref: '#/components/schemas/UnsignedTransaction'
    CardanoBaseAddress:
      type: string
      description: bech32 encoded base address. [Accounts](https://cips.cardano.org/cips/cip19/).
      format: bech32
      example: addr1vpu5vlrf4xkxv2qpwngf6cjhtw542ayty80v8dyr49rf5eg0yu80w
    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
    SignedTransaction:
      type: string
      format: base64
      description: Hex-encoded raw bytes of a protocol-specific signed transaction.
      example: '0x22895118000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000e00000000000000000000000000000000000000000000000000000000000000120087fed394b43849eebef1e88873cd9efdbe33136656e5148e659b8b2f33625d40000000000000000000000000000000000000000000000000000000000000030b81748644e23c4d950f9dd709f3eb73d5eacd9657997e1d9dde7c4ebd8a6519ecb9d0a7fb603d3b68e023278f9650122000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000020010000000000000000000000c509bb854c526af4cee5e037089f7aa8e091d8870000000000000000000000000000000000000000000000000000000000000060b36b79b4b206c0310472c117fa40c05342b5dc3e89f98f42c9da3ce6450d4c603cad55248017fd4eca3ab277cca64569193e4d487f5b2ea78a2bcdc81926c313c05842a3af318967a775783bba22519e8b8886587efa99aa7dab5784f792b187

        '
    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'
  parameters:
    IdempotencyKey:
      in: header
      name: Idempotency-Key
      description: the unique idempotency key for this request
      example: f1c971b4-7114-4c4b-8ad2-a6f9e33e2cd0
      schema:
        type: string
        format: uuid
      required: false
    CardanoNetwork:
      name: network
      in: path
      description: Cardano network
      required: true
      schema:
        $ref: '#/components/schemas/CardanoNetwork'
  responses:
    RewardsWithdrawIntentCardano:
      description: Rewards withdrawal intent created
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RewardsWithdrawIntentCardano'
    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
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Header 'X-API-Key' missing.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
    NoValidatorsError:
      description: Insufficient validators available to process Stake Intent request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  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