> ## Documentation Index
> Fetch the complete documentation index at: https://api.docs.rocketfi.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get vault history

> ### Parameters

| Parameter | Required | Type | Description |
| --------- | -------- | ---- | ----------- |
| vault | yes | string (hex) | Vault address (required) |
| user | yes | string (hex) | User address (optional) |
| paginationData | yes | object | Pagination segment containing `pageNumber` and `pageSize` (serialized per gateway contract). |

### Response fields

| Parameter | Required | Type | Description |
| --------- | -------- | ---- | ----------- |
| `history` | yes | object[] | View containing multiple vault history entries with human-readable values |
| `history[].amount` | yes | string | Amount deposited or payout amount for withdrawals (human-readable) |
| `history[].assetId` | yes | integer | — |
| `history[].eventType` | yes | string | Type of vault history event |
| `history[].round` | yes | integer (int64) | — |
| `history[].shares` | yes | integer | — |
| `history[].timestamp` | yes | integer (int64) | — |
| `history[].txHash` | yes | string (hex) | Transaction hash |
| `history[].user` | yes | string (hex) | User who deposited/withdrew |
| `history[].vault` | yes | string (hex) | Vault address |
| `pageNumber` | yes | integer | — |
| `pageSize` | yes | integer | — |

### Response example

A sample **`200`** JSON body is attached to this operation as an OpenAPI **example** (Mintlify shows it in the example panel, similar to other exchange API docs).



## OpenAPI

````yaml /specs/openapi.json get /vault-history
openapi: 3.1.0
info:
  title: RocketFi REST API
  description: REST API for Rocket Chain / RocketFi integrations.
  license:
    name: ''
  version: 0.1.0
servers:
  - url: https://beta.rocketfi.io
    description: Beta
  - url: https://testnet.rocket-cluster-1.com
    description: Testnet
  - url: https://devnet.rocket-cluster-1.com
    description: Devnet
security: []
tags:
  - name: Service
    description: Health and availability.
  - name: Market data
    description: Instruments, candles, fees, leverage, and funding data.
  - name: Account
    description: Account nonce, fees, collateral, positions, and orders.
  - name: Trading
    description: Transactions and order activity.
  - name: Vault and bridge
    description: Vaults, history, and bridge events.
  - name: Faucet (testnet)
    description: Testnet faucet for development.
paths:
  /vault-history:
    get:
      tags:
        - Vault and bridge
      summary: Get vault history
      description: >-
        ### Parameters


        | Parameter | Required | Type | Description |

        | --------- | -------- | ---- | ----------- |

        | vault | yes | string (hex) | Vault address (required) |

        | user | yes | string (hex) | User address (optional) |

        | paginationData | yes | object | Pagination segment containing
        `pageNumber` and `pageSize` (serialized per gateway contract). |


        ### Response fields


        | Parameter | Required | Type | Description |

        | --------- | -------- | ---- | ----------- |

        | `history` | yes | object[] | View containing multiple vault history
        entries with human-readable values |

        | `history[].amount` | yes | string | Amount deposited or payout amount
        for withdrawals (human-readable) |

        | `history[].assetId` | yes | integer | — |

        | `history[].eventType` | yes | string | Type of vault history event |

        | `history[].round` | yes | integer (int64) | — |

        | `history[].shares` | yes | integer | — |

        | `history[].timestamp` | yes | integer (int64) | — |

        | `history[].txHash` | yes | string (hex) | Transaction hash |

        | `history[].user` | yes | string (hex) | User who deposited/withdrew |

        | `history[].vault` | yes | string (hex) | Vault address |

        | `pageNumber` | yes | integer | — |

        | `pageSize` | yes | integer | — |


        ### Response example


        A sample **`200`** JSON body is attached to this operation as an OpenAPI
        **example** (Mintlify shows it in the example panel, similar to other
        exchange API docs).
      operationId: get_vault_history
      parameters:
        - name: vault
          in: path
          description: Vault address (required)
          required: true
          schema:
            $ref: '#/components/schemas/AccountAddress'
        - name: user
          in: path
          description: User address (optional)
          required: true
          schema:
            oneOf:
              - type: 'null'
              - $ref: '#/components/schemas/AccountAddress'
        - name: paginationData
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/PaginationData'
          description: >-
            Pagination segment containing `pageNumber` and `pageSize`
            (serialized per gateway contract).
      responses:
        '200':
          description: Vault deposit/withdraw history
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVaultHistoryResponse'
              example:
                history: []
                pageNumber: 0
                pageSize: 25
        '400':
          description: Bad request - invalid parameters
components:
  schemas:
    AccountAddress:
      type: string
      format: hex
      description: An Ethereum-style account address (20 bytes).
    PaginationData:
      type: object
      properties:
        pageNumber:
          $ref: '#/components/schemas/usize'
        pageSize:
          $ref: '#/components/schemas/usize'
    GetVaultHistoryResponse:
      type: object
      description: Response containing vault history entries with human-readable values
      required:
        - history
        - pageNumber
        - pageSize
      properties:
        history:
          $ref: '#/components/schemas/VaultHistoryClientView'
        pageNumber:
          $ref: '#/components/schemas/usize'
        pageSize:
          $ref: '#/components/schemas/usize'
    usize:
      type: integer
      minimum: 0
    VaultHistoryClientView:
      type: array
      items:
        $ref: '#/components/schemas/VaultHistoryEntryClientView'
      description: >-
        View containing multiple vault history entries with human-readable
        values
    VaultHistoryEntryClientView:
      type: object
      description: A vault history entry with human-readable values
      required:
        - eventType
        - vault
        - user
        - assetId
        - amount
        - shares
        - timestamp
        - round
        - txHash
      properties:
        amount:
          type: string
          description: Amount deposited or payout amount for withdrawals (human-readable)
        assetId:
          $ref: '#/components/schemas/usize'
          description: Asset deposited/withdrawn
        eventType:
          $ref: '#/components/schemas/VaultHistoryEventType'
          description: Type of event (Deposit or Withdraw)
        round:
          $ref: '#/components/schemas/u64'
          description: Round in which the event occurred
        shares:
          $ref: '#/components/schemas/u128'
          description: Shares minted (for deposit) or burned (for withdraw)
        timestamp:
          $ref: '#/components/schemas/u64'
          description: Timestamp of the event
        txHash:
          type: string
          format: hex
          description: Transaction hash
        user:
          type: string
          format: hex
          description: User who deposited/withdrew
        vault:
          type: string
          format: hex
          description: Vault address
    VaultHistoryEventType:
      type: string
      description: Type of vault history event
      enum:
        - Deposit
        - Withdraw
    u64:
      type: integer
      format: int64
      minimum: 0
    u128:
      type: integer
      minimum: 0

````