HTTP endpoints

Get vault events

Paginated vault deposit and withdrawal events.

Parameters

Parameter	Required	Type	Description
vault	yes	string (hex)	Optional vault address filter.
account	yes	string (hex)	Optional account address filter.
roundFrom	yes	string	null
roundTo	yes	string	null
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[]	Vault events returned for the selected filters.
`events[].account`	yes	string (hex)	Account associated with the event.
`events[].amount`	yes	string	Absolute collateral amount in dollar units.
`events[].assetId`	yes	integer	—
`events[].eventIndex`	yes	integer (int32)	Event index within the round.
`events[].eventType`	yes	string	Event type exposed to clients (`deposit` or `withdraw` for vault flows).
`events[].round`	yes	integer (int64)	—
`events[].shares`	yes	string	Signed share delta stored in the vault event row.
`events[].timestamp`	yes	integer (int64)	—
`events[].txHash`	yes	string (hex)	Transaction hash as a hex string.
`events[].txIndex`	yes	integer (int32)	Transaction index within the round.
`events[].vault`	yes	string (hex)	Vault address.
`pageNumber`	yes	integer	—
`pageSize`	yes	integer	—

Response example

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

GET

vault-events

Get vault events

curl --request GET \
  --url https://beta.rocket-cluster-1.com/indexer/vault-events

const options = {method: 'GET'};

fetch('https://beta.rocket-cluster-1.com/indexer/vault-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://beta.rocket-cluster-1.com/indexer/vault-events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://beta.rocket-cluster-1.com/indexer/vault-events"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://beta.rocket-cluster-1.com/indexer/vault-events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "events": [
    {
      "account": "0xd6963dda208f0f36acd13cce5bbc26720c8b612f",
      "amount": "5000",
      "assetId": 0,
      "eventIndex": 0,
      "eventType": "deposit",
      "round": 29083401,
      "shares": "500000",
      "timestamp": 1774368107590,
      "txHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "txIndex": 0,
      "vault": "0xf19e16fe3cf25c630f55f66d6c6cbf64f84fc86b"
    }
  ],
  "pageNumber": 0,
  "pageSize": 100
}

"<string>"

"<string>"

Path Parameters

vault

string<hex>

required

Optional vault address filter.

account

string<hex>

required

Optional account address filter.

roundFrom

string | null

required

Optional start round (inclusive). If provided, roundTo should also be provided.

roundTo

string | null

required

Optional end round (inclusive). If provided, roundFrom should also be provided.

pageNumber

integer

default:0

required

Zero-based page number. Accepts either a number or a numeric string.

Required range: x >= 0

pageSize

integer

default:2000

required

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

Required range: x >= 0

Response

Vault events

events

object[]

required

Vault events returned for the selected filters.

Show child attributes

pageNumber

integer

required

Zero-based page number.

Required range: x >= 0

pageSize

integer

required

Page size (max items per page).

Required range: x >= 0

Get vault events

curl --request GET \
  --url https://beta.rocket-cluster-1.com/indexer/vault-events

const options = {method: 'GET'};

fetch('https://beta.rocket-cluster-1.com/indexer/vault-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://beta.rocket-cluster-1.com/indexer/vault-events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://beta.rocket-cluster-1.com/indexer/vault-events"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://beta.rocket-cluster-1.com/indexer/vault-events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "events": [
    {
      "account": "0xd6963dda208f0f36acd13cce5bbc26720c8b612f",
      "amount": "5000",
      "assetId": 0,
      "eventIndex": 0,
      "eventType": "deposit",
      "round": 29083401,
      "shares": "500000",
      "timestamp": 1774368107590,
      "txHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "txIndex": 0,
      "vault": "0xf19e16fe3cf25c630f55f66d6c6cbf64f84fc86b"
    }
  ],
  "pageNumber": 0,
  "pageSize": 100
}

"<string>"

"<string>"

Introduction

Public REST-API

Private REST-API

Indexer REST-API

Public WebSocket streams

Private WebSocket streams

WebSocket API

Error responses

Get vault events

Parameters

Response fields

Response example

Path Parameters

Response