> ## 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 bridge events

> Paginated bridge deposit and withdrawal events.

### Parameters

| Parameter | Required | Type | Description |
| --------- | -------- | ---- | ----------- |
| account | yes | string (hex) | Optional account address filter. |
| roundFrom | yes | string | null | Optional start round (inclusive). If provided, `roundTo` should also be provided. |
| roundTo | yes | string | null | Optional end round (inclusive). If provided, `roundFrom` should also be provided. |
| pageNumber | yes | integer | Zero-based page number. Accepts either a number or a numeric string. |
| pageSize | yes | integer | Page size (number of items per page). Accepts either a number or a numeric string. |

### Response fields

| Parameter | Required | Type | Description |
| --------- | -------- | ---- | ----------- |
| `events` | yes | object[] | — |
| `events[].accountAddress` | yes | string (hex) | An Ethereum-style account address (20 bytes). |
| `events[].amount` | yes | string | — |
| `events[].eventType` | yes | string | — |
| `events[].externalAddress` | yes | string | — |
| `events[].externalTokenAddress` | yes | string | — |
| `events[].id` | yes | integer (int64) | — |
| `events[].round` | yes | integer (int64) | — |
| `events[].timestamp` | yes | integer (int64) | — |

### Response example

A sample **`200`** response body is attached to this operation as an OpenAPI **example** — see the **Example** panel on this page.



## OpenAPI

````yaml /specs/indexer-openapi.json get /bridge-events
openapi: 3.1.0
info:
  title: Rocket Indexer API Documentation
  description: >-
    Welcome to the RocketChain Indexer API documentation!


    The indexer REST API serves historical and aggregated market data from
    ClickHouse. Endpoints cover candles, trades, order history, portfolio
    curves, funding events, bridge events, vault events, current/historical
    instruments, and live instrument details.
  license:
    name: MIT
    url: https://github.com/rocketfoundation/rocket-sdk-rust/blob/main/LICENSE
  version: '1.0'
  x-logo:
    altText: ROCKET
    backgroundColor: '#00000000'
    url: https://www.rocketfoundation.io/assets/rocket-logo.svg
servers:
  - url: https://beta.rocket-cluster-1.com/indexer
    description: Beta
  - url: https://testnet.rocket-cluster-1.com/indexer
    description: Testnet
  - url: https://devnet.rocket-cluster-1.com/indexer
    description: Devnet
security: []
tags:
  - name: Indexer REST-API
    description: >-
      Read-only REST endpoints backed by the RocketChain indexer. All routes are
      served over HTTP GET.
paths:
  /bridge-events:
    get:
      tags:
        - Indexer REST-API
      summary: Get bridge events
      description: >-
        Paginated bridge deposit and withdrawal events.


        ### Parameters


        | Parameter | Required | Type | Description |

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

        | account | yes | string (hex) | Optional account address filter. |

        | roundFrom | yes | string | null | Optional start round (inclusive). If
        provided, `roundTo` should also be provided. |

        | roundTo | yes | string | null | Optional end round (inclusive). If
        provided, `roundFrom` should also be provided. |

        | pageNumber | yes | integer | Zero-based page number. Accepts either a
        number or a numeric string. |

        | pageSize | yes | integer | Page size (number of items per page).
        Accepts either a number or a numeric string. |


        ### Response fields


        | Parameter | Required | Type | Description |

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

        | `events` | yes | object[] | — |

        | `events[].accountAddress` | yes | string (hex) | An Ethereum-style
        account address (20 bytes). |

        | `events[].amount` | yes | string | — |

        | `events[].eventType` | yes | string | — |

        | `events[].externalAddress` | yes | string | — |

        | `events[].externalTokenAddress` | yes | string | — |

        | `events[].id` | yes | integer (int64) | — |

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

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


        ### Response example


        A sample **`200`** response body is attached to this operation as an
        OpenAPI **example** — see the **Example** panel on this page.
      operationId: getBridgeEvents
      parameters:
        - name: account
          in: path
          description: Optional account address filter.
          required: true
          schema:
            type: string
            format: hex
          example: '0xf19e16fe3cf25c630f55f66d6c6cbf64f84fc86b'
        - name: roundFrom
          in: path
          description: >-
            Optional start round (inclusive). If provided, `roundTo` should also
            be provided.
          required: true
          schema:
            type:
              - string
              - 'null'
          example: 1000
        - name: roundTo
          in: path
          description: >-
            Optional end round (inclusive). If provided, `roundFrom` should also
            be provided.
          required: true
          schema:
            type:
              - string
              - 'null'
          example: 1100
        - name: pageNumber
          in: path
          description: |-
            Zero-based page number.
            Accepts either a number or a numeric string.
          required: true
          schema:
            oneOf:
              - $ref: '#/components/schemas/usize'
            default: 0
          example: 0
        - name: pageSize
          in: path
          description: |-
            Page size (number of items per page).
            Accepts either a number or a numeric string.
          required: true
          schema:
            oneOf:
              - $ref: '#/components/schemas/usize'
            default: 2000
          example: 100
      responses:
        '200':
          description: Bridge events
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBridgeEventsResponse'
              example:
                events:
                  - accountAddress: '0xD6963Dda208f0f36acd13ccE5bbC26720c8b612f'
                    amount: '5'
                    eventType: Deposit
                    externalAddress: '0xD6963Dda208f0f36acd13ccE5bbC26720c8b612f'
                    externalTokenAddress: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831'
                    id: 2
                    round: 4263425
                    timestamp: 1771860706130
                  - accountAddress: '0x5ff593a3eeb56A7F9aB082A2009686a12d1f8894'
                    amount: '53.64'
                    eventType: Deposit
                    externalAddress: '0x5ff593a3eeb56A7F9aB082A2009686a12d1f8894'
                    externalTokenAddress: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831'
                    id: 1
                    round: 10576897
                    timestamp: 1772497183113
        '400':
          description: Invalid query parameters
          content:
            text/plain:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            text/plain:
              schema:
                type: string
components:
  schemas:
    usize:
      type: integer
      minimum: 0
    GetBridgeEventsResponse:
      type: object
      required:
        - events
      properties:
        events:
          $ref: '#/components/schemas/BridgeEventsSetClientView'
          description: Bridge events returned for the selected account or round range.
      examples:
        - events:
            - accountAddress: '0xD6963Dda208f0f36acd13ccE5bbC26720c8b612f'
              amount: '5'
              eventType: Deposit
              externalAddress: '0xD6963Dda208f0f36acd13ccE5bbC26720c8b612f'
              externalTokenAddress: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831'
              id: 2
              round: 4263425
              timestamp: 1771860706130
            - accountAddress: '0x5ff593a3eeb56A7F9aB082A2009686a12d1f8894'
              amount: '53.64'
              eventType: Deposit
              externalAddress: '0x5ff593a3eeb56A7F9aB082A2009686a12d1f8894'
              externalTokenAddress: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831'
              id: 1
              round: 10576897
              timestamp: 1772497183113
    BridgeEventsSetClientView:
      type: array
      items:
        $ref: '#/components/schemas/BridgeEventClientView'
    BridgeEventClientView:
      type: object
      required:
        - round
        - timestamp
        - accountAddress
        - externalAddress
        - externalTokenAddress
        - id
        - amount
        - eventType
      properties:
        accountAddress:
          $ref: '#/components/schemas/AccountAddress'
        amount:
          type: string
        eventType:
          $ref: '#/components/schemas/BridgeEventType'
        externalAddress:
          type: string
        externalTokenAddress:
          type: string
        id:
          type: integer
          format: int64
          minimum: 0
        round:
          type: integer
          format: int64
          minimum: 0
        timestamp:
          $ref: '#/components/schemas/u64'
    AccountAddress:
      type: string
      format: hex
      description: An Ethereum-style account address (20 bytes).
      example: '0xf19e16fe3cf25c630f55f66d6c6cbf64f84fc86b'
    BridgeEventType:
      type: string
      enum:
        - Deposit
        - Withdraw
    u64:
      type: integer
      format: int64
      minimum: 0

````