Figment Vaults API

The Vaults API from Figment — 19 operation(s) for vaults.

OpenAPI Specification

figment-vaults-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Figment Vaults API
  version: 2.0.0+1190.1
  termsOfService: https://figment.io/staking-terms-of-use
servers:
- url: https://api.figment.io
tags:
- name: Vaults
paths:
  /vaults/transactions/create_vault:
    post:
      summary: Create Vault
      tags:
      - Vaults
      operationId: create-vault-transactions
      parameters: []
      responses:
        '200':
          description: Transaction payload to create a Vault.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ethereum_transaction'
                example:
                  data:
                    unsigned_transaction_serialized: '0x02f90135824268248459682f008501b0f8d21a8308667b949741f8e49ffa322714511b5d17bd052698eafa43843b9aca00b901049a0d79ad0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000020ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000c0'
                    unsigned_transaction_hash: '0x7de4a33e6cb731239cbf58c915b666cb9680cf14cc2d144d0bad5d7140c84fa7'
                    max_transaction_cost: 3999034319785598
                    calldata: '0x9a0d79ad0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000020ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000'
        '422':
          description: Invalid transaction
        '400':
          description: Bad Request
        '401':
          description: Invalid API key
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                network:
                  type: string
                  example: hoodi
                  enum:
                  - mainnet
                  - hoodi
                  description: Network name
                admin_address:
                  type: string
                  example: '0xdb007d02efef6640f9cfcfc8d2e0ba39fe4457de'
                  description: Address of the Vault admin
              required:
              - network
              - admin_address
        required: true
  /vaults/{vault_address}:
    patch:
      summary: Set Region
      tags:
      - Vaults
      operationId: set-region
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      responses:
        '200':
          description: Set Region
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/vault'
                example:
                  data:
                  - id: 95dfa576-c11a-428c-8844-a1744eee95a1
                    address: '0xb67c867f975e9b6a022dd6b69672345268f0c877'
                    fee_recipient_address: '0xa6372f319628bef9ad7a902a52e59c14797184be'
                    network: hoodi
                    region: ca-central-1
                    vault_admin_id: 703a145f-a034-469e-a0a9-624130d462d8
                    admin_address: '0xa73bacbb54faac0144fe749273a552026d0ff334'
                    validators_manager_address: '0xdd1b638b81b8e447b3acb96e9fa7c7a39e6dc3d7'
                    fee_bps: 500
                    capacity_wei: 1
                    own_mev_escrow: true
                    reward_splitter_contract_address: '0xa73bacbb54faac0144fe749273a552026d0ff334'
                    created_at: '2024-05-21T16:32:45Z'
                    updated_at: '2024-05-21T16:32:45Z'
                  meta:
                    pagination:
                      current_page: 1
                      total_pages: 1
                      total_item_count: 1
        '401':
          description: Invalid API key
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                network:
                  type: string
                  example: hoodi
                  enum:
                  - mainnet
                  - hoodi
                  description: Network name
                region:
                  type: string
                  example: ca-central-1
                  enum:
                  - ca-central-1
                  - eu-west-1
                  description: Region to provision the Validators in your Vault
              required:
              - network
              - region
        required: true
  /vaults/{vault_address}/transactions/configure_figment_vault:
    post:
      summary: Configure Figment Validator Vault
      tags:
      - Vaults
      operationId: configure-figment-vault
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      responses:
        '200':
          description: Transaction payload to set validator manager and fee recipient address.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ethereum_transaction'
                example:
                  data:
                    unsigned_transaction_serialized: '0x02f90135824268248459682f008501b0f8d21a8308667b949741f8e49ffa322714511b5d17bd052698eafa43843b9aca00b901049a0d79ad0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000020ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000c0'
                    unsigned_transaction_hash: '0x7de4a33e6cb731239cbf58c915b666cb9680cf14cc2d144d0bad5d7140c84fa7'
                    max_transaction_cost: 3999034319785598
                    calldata: '0x9a0d79ad0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000020ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000'
        '401':
          description: Invalid API key
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                network:
                  type: string
                  example: hoodi
                  enum:
                  - mainnet
                  - hoodi
                  description: Network name
              required:
              - network
        required: true
  /vaults/{vault_address}/transactions/update_allowlist:
    post:
      summary: Update Allowlist
      tags:
      - Vaults
      operationId: update-allowlist-transactions
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      responses:
        '200':
          description: Transaction payload to update a Vault allow list.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ethereum_transaction'
                example:
                  data:
                    unsigned_transaction_serialized: '0x02f90135824268248459682f008501b0f8d21a8308667b949741f8e49ffa322714511b5d17bd052698eafa43843b9aca00b901049a0d79ad0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000020ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000c0'
                    unsigned_transaction_hash: '0x7de4a33e6cb731239cbf58c915b666cb9680cf14cc2d144d0bad5d7140c84fa7'
                    max_transaction_cost: 3999034319785598
                    calldata: '0x9a0d79ad0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000020ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000'
        '400':
          description: Failed request
        '422':
          description: Invalid request
        '401':
          description: Invalid API key
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                network:
                  type: string
                  example: hoodi
                  enum:
                  - mainnet
                  - hoodi
                  description: Network name
                wallet_address:
                  type: array
                  example: '["0x4c6c8b265103a6b0c9a1f23f776b198237adb69e"]'
                  description: A list of eth wallet addresses to add or remove from the allow list
                allowed:
                  type: boolean
                  example: true
                  description: Sets the address to allowed or not allowed
              required:
              - network
              - wallet_address
              - allowed
        required: true
  /vaults/{vault_address}/transactions/deposit:
    post:
      summary: Deposit
      tags:
      - Vaults
      operationId: deposit-transactions
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      responses:
        '200':
          description: Transaction payload to deposit Eth.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ethereum_transaction'
                example:
                  data:
                    unsigned_transaction_serialized: '0x02f90135824268248459682f008501b0f8d21a8308667b949741f8e49ffa322714511b5d17bd052698eafa43843b9aca00b901049a0d79ad0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000020ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000c0'
                    unsigned_transaction_hash: '0x7de4a33e6cb731239cbf58c915b666cb9680cf14cc2d144d0bad5d7140c84fa7'
                    max_transaction_cost: 3999034319785598
                    calldata: '0x9a0d79ad0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000020ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000'
        '422':
          description: Transaction failed due to invalid input parameters
        '400':
          description: Bad Request
        '401':
          description: Invalid API key
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                network:
                  type: string
                  example: hoodi
                  enum:
                  - mainnet
                  - hoodi
                  description: Network name
                from_address:
                  type: string
                  example: '0xa067dace6d518235489d9dcee8d9879703fd99f24'
                  description: Address of the depositor
                receiver_address:
                  type: string
                  example: '0xa067dace6d518235489d9dcee8d9879703fd99f24'
                  description: Address of the receiver
                amount:
                  type: string
                  pattern: ^\d+(\.\d+)?$
                  example: '10.0'
                  description: Amount of ETH to deposit
              required:
              - network
              - from_address
              - receiver_address
              - amount
        required: true
  /vaults/{vault_address}/transactions/withdraw:
    post:
      summary: Withdraw
      tags:
      - Vaults
      operationId: create-withdraw-transactions
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      responses:
        '200':
          description: Transaction payload to enter in the exit queue.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ethereum_transaction'
                example:
                  data:
                    unsigned_transaction_serialized: '0x02f90135824268248459682f008501b0f8d21a8308667b949741f8e49ffa322714511b5d17bd052698eafa43843b9aca00b901049a0d79ad0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000020ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000c0'
                    unsigned_transaction_hash: '0x7de4a33e6cb731239cbf58c915b666cb9680cf14cc2d144d0bad5d7140c84fa7'
                    max_transaction_cost: 3999034319785598
                    calldata: '0x9a0d79ad0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000020ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000'
        '400':
          description: Bad Request
        '401':
          description: Invalid API key
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                network:
                  type: string
                  example: hoodi
                  enum:
                  - mainnet
                  - hoodi
                  description: Network name
                from_address:
                  type: string
                  example: '0xa067dace6d518235489d9dcee8d9879703fd99f24'
                  description: Address of the signer
                receiver_address:
                  type: string
                  example: '0xa067dace6d518235489d9dcee8d9879703fd99f24'
                  description: Address of the receiver
                assets:
                  type: string
                  pattern: ^\d+(\.\d+)?$
                  example: '10.0'
                  description: Amount of ETH to withdraw
              required:
              - network
              - from_address
              - receiver_address
              - assets
        required: true
  /vaults/{vault_address}/transactions/claim_withdrawal:
    post:
      summary: Claim Withdrawal
      tags:
      - Vaults
      operationId: create-claim-withdrawal-transactions
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      responses:
        '200':
          description: Transaction payload to claim the withdrawal.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ethereum_transaction'
                example:
                  data:
                    unsigned_transaction_serialized: '0x02f90135824268248459682f008501b0f8d21a8308667b949741f8e49ffa322714511b5d17bd052698eafa43843b9aca00b901049a0d79ad0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000020ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000c0'
                    unsigned_transaction_hash: '0x7de4a33e6cb731239cbf58c915b666cb9680cf14cc2d144d0bad5d7140c84fa7'
                    max_transaction_cost: 3999034319785598
                    calldata: '0x9a0d79ad0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000020ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000'
        '400':
          description: Bad Request
        '401':
          description: Invalid API key
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                network:
                  type: string
                  example: hoodi
                  enum:
                  - mainnet
                  - hoodi
                  description: Network name
                position_ticket:
                  type: string
                  example: '1234'
                  description: The exit queue ticket received
                timestamp:
                  type: string
                  example: '1717010271'
                  description: The timestamp when the shares entered the exit queue
                from_address:
                  type: string
                  example: '0xa067dace6d518235489d9dcee8d9879703fd99f24'
                  description: Address of the signer
              required:
              - network
              - position_ticket
              - timestamp
              - from_address
        required: true
  /vaults/{vault_address}/allowlist:
    get:
      summary: Allowlist
      tags:
      - Vaults
      operationId: show-allowlist
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      - name: network
        in: query
        schema:
          type: string
          enum:
          - mainnet
          - hoodi
        example: hoodi
        required: true
      responses:
        '200':
          description: Allowlist
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/stake_wise_allowlist_entry'
                example:
                  data:
                    allowlist:
                    - created_at: 1719345504000
                      address: '0xE373733544a50A5Ea8A4Aa0209d30d1Eab13fD2b'
                    - created_at: 1719321972000
                      address: '0xC0B0D5F4A73b348A1dD2deD11ED9e409fe7685a8'
        '401':
          description: Invalid API key
  /vaults/{vault_address}/address/{id}/actions:
    get:
      summary: Address Actions
      tags:
      - Vaults
      operationId: show-address-actions
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      - name: id
        in: path
        schema:
          type: string
          description: Wallet Address
        required: true
      - name: network
        in: query
        schema:
          type: string
          enum:
          - mainnet
          - hoodi
        example: hoodi
        required: true
      - name: limit
        in: query
        schema:
          type: integer
          description: Limit for Address Actions
        example: '10'
        required: false
      - name: offset
        in: query
        schema:
          type: integer
          description: Offset for Address Actions
        example: '1'
        required: false
      responses:
        '200':
          description: Address Actions
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/stake_wise_depositor_actions'
                example:
                  data:
                    stakerActions:
                    - id: 0x08cbc471958019c940ca822b8a6e29a1425ce3574cdd2e5644789a24caea0072-139
                      assets: '0.1'
                      shares: '0.1'
                      createdAt: 1716914868000
                      actionType: Redeemed
                      link: https://hoodi.etherscan.io/tx/0x08cbc471958019c940ca822b8a6e29a1425ce3574cdd2e5644789a24caea0072
                    - id: 0x854f766c2e64b219bbfb613c59a7a506eea08e63eb38beb75a349a1b12f789ab-8
                      assets: '0.1'
                      shares: '0.1'
                      createdAt: 1716327696000
                      actionType: Deposited
                      link: https://hoodi.etherscan.io/tx/0x854f766c2e64b219bbfb613c59a7a506eea08e63eb38beb75a349a1b12f789ab
                    - id: 0x2954b40c0aa829d07e9ab5209d52cb01ffef6737cd81e8327c1895e9ec518a85-17
                      assets: '0.1'
                      shares: '0.1'
                      createdAt: 1716295452000
                      actionType: Deposited
                      link: https://hoodi.etherscan.io/tx/0x2954b40c0aa829d07e9ab5209d52cb01ffef6737cd81e8327c1895e9ec518a85
                    - id: 0x67b822d7cae981e74f369400ef3b87e61c8d8616031fd4c413e310b6fc76167f-93
                      assets: '0.1'
                      shares: '0.1'
                      createdAt: 1716295128000
                      actionType: Deposited
                      link: https://hoodi.etherscan.io/tx/0x67b822d7cae981e74f369400ef3b87e61c8d8616031fd4c413e310b6fc76167f
        '401':
          description: Invalid API key
  /vaults/{vault_address}/address/{id}/balance:
    get:
      summary: Address Balance
      tags:
      - Vaults
      operationId: show-address-balance
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      - name: id
        in: path
        schema:
          type: string
          description: Wallet Address
        required: true
      - name: network
        in: query
        schema:
          type: string
          enum:
          - mainnet
          - hoodi
        example: hoodi
        required: true
      responses:
        '200':
          description: Address Balance
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/stake_wise_depositor_balance'
                example:
                  data:
                    balance: '0.2'
        '401':
          description: Invalid API key
  /vaults/{vault_address}/address/{id}/rewards:
    get:
      summary: List Address Rewards
      tags:
      - Vaults
      operationId: list-address-rewards
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      - name: id
        in: path
        schema:
          type: string
          description: Wallet Address
        required: true
      - name: network
        in: query
        schema:
          type: string
          enum:
          - mainnet
          - hoodi
        example: hoodi
        required: true
      - name: start_date
        in: query
        schema:
          type: string
          description: Start date for rewards data. Defaults to 1 month ago.
        example: '2024-01-01'
        required: false
      - name: end_date
        in: query
        schema:
          type: string
          description: End date for rewards data
        example: '2024-02-01'
        required: false
      responses:
        '200':
          description: Address Rewards
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/stake_wise_depositor_rewards'
                example:
                  data:
                    rewards:
                    - date: '2024-08-14T00:00:00Z'
                      sum_rewards: '0.008092870114883128'
                      daily_rewards: '0.003493495227587289'
                      daily_rewards_eur: '8.54'
                      daily_rewards_gbp: '7.33'
                      daily_rewards_usd: '9.41'
                    - date: '2024-08-15T00:00:00Z'
                      sum_rewards: '0.012130082097944445'
                      daily_rewards: '0.004037211983061317'
                      daily_rewards_eur: '9.46'
                      daily_rewards_gbp: '8.09'
                      daily_rewards_usd: '10.4'
                    - date: '2024-08-16T00:00:00Z'
                      sum_rewards: '0.014103402730016545'
                      daily_rewards: '0.001973320632072101'
                      daily_rewards_eur: '4.71'
                      daily_rewards_gbp: '4.02'
                      daily_rewards_usd: '5.17'
        '401':
          description: Invalid API key
  /vaults/{vault_address}/commission/{commission_address}/actions:
    get:
      summary: Commission Actions
      tags:
      - Vaults
      operationId: show-commission-actions
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      - name: commission_address
        in: path
        schema:
          type: string
          description: Address of the commission
        required: true
      - name: network
        in: query
        schema:
          type: string
          enum:
          - mainnet
          - hoodi
        example: hoodi
        required: true
      - name: limit
        in: query
        schema:
          type: integer
          description: Limit for Staker Actions
        example: '10'
        required: false
      - name: offset
        in: query
        schema:
          type: integer
          description: Offset for Staker Actions
        example: '1'
        required: false
      responses:
        '200':
          description: Commission Actions
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/stake_wise_shareholder_actions'
                example:
                  data:
                    actions:
                    - id: 0x9b516fb296aa5170419316efd6c15c561b1f8dc75c6b62d1be4750b759f09740-2
                      assets: '0.000000999999999999'
                      shares: '0.0'
                      created_at: '2024-08-15T14:21:36Z'
                      action_type: ExitedAssetsClaimed
                      link: https://hoodi.etherscan.io/tx/0x8535d751c6c020e6eae637746ef16d1c8703e6d295b24bf3e317aa67ec12957e
        '401':
          description: Invalid API key
  /vaults/{vault_address}/commission/{commission_address}/balance:
    get:
      summary: Commission Balance
      tags:
      - Vaults
      operationId: show-commission-balance
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      - name: commission_address
        in: path
        schema:
          type: string
          description: Address of the commision
        required: true
      - name: network
        in: query
        schema:
          type: string
          enum:
          - mainnet
          - hoodi
        example: hoodi
        required: true
      responses:
        '200':
          description: Commission Balance
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/stake_wise_shareholder_balance'
                example:
                  data:
                    balance: '0.000216504418283007'
        '401':
          description: Invalid API key
  /vaults/{vault_address}/transactions/withdraw_commission:
    post:
      summary: Withdraw commission
      tags:
      - Vaults
      operationId: create-withdraw-commission-transactions
      parameters:
      - name: vault_address
        in: path
        schema:
          type: string
          description: Address of the Vault
        required: true
      responses:
        '200':
          description: Transaction payload to withdraw comission.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ethereum_transaction'
                example:
                  data:
                    unsigned_transaction_serialized: '0x02f90135824268248459682f008501b0f8d21a8308667b949741f8e49ffa322714511b5d17bd052698eafa43843b9aca00b901049a0d79ad00000000000000000000000000000000000000000000000000000000000000400000000000

# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/figment/refs/heads/main/openapi/figment-vaults-api-openapi.yml