Skip to main content
GET
/
vaults
/
{address}
Get vault details
curl --request GET \
  --url https://api.circular.rosetta.sh/api/v1/vaults/{address} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.circular.rosetta.sh/api/v1/vaults/{address}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.circular.rosetta.sh/api/v1/vaults/{address}', 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://api.circular.rosetta.sh/api/v1/vaults/{address}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$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://api.circular.rosetta.sh/api/v1/vaults/{address}"

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

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.circular.rosetta.sh/api/v1/vaults/{address}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.circular.rosetta.sh/api/v1/vaults/{address}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": {
    "address": "<string>",
    "name": "<string>",
    "curator": "<string>",
    "chainId": 123,
    "asset": "<string>",
    "tvl": 123,
    "apy": {
      "base": 123,
      "rewards": 123,
      "total": 123
    },
    "allocations": [
      {
        "marketId": "<string>",
        "collateral": "<string>",
        "share": 123,
        "apy": 123,
        "supplyUsd": 123
      }
    ],
    "leverageExposure": 123,
    "topDepositors": 123
  },
  "meta": {
    "latencyMs": 123,
    "freshness": "<string>",
    "source": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API key in format circ_live_* or circ_test_*

Path Parameters

address
string
required

Vault contract address (0x...)

Response

200 - application/json

Vault details

data
object
meta
object