LogoLogo
Launch App ->
  • Overview
  • Product
    • Credit Vaults
      • Tranching
      • Live vaults
    • USP
      • Allocation
      • Risks
      • FAQs
    • Users
      • Lenders
        • Verification
        • Guides
          • Onboarding
          • Deposit
          • Redeem
      • Curators
      • Borrowers
  • Developers
    • Addresses
      • Product
        • Credit Vaults
        • USP
      • Governance
    • Integrators
    • API
      • Campaigns
      • Chains
      • Operators
      • Token blocks
      • Tokens
      • Transactions
      • Vaults
      • Vault blocks
      • Vault categories
      • Vault epochs
      • Vault performances
      • Vault types
    • Security
      • Audits
  • Resources
    • Media kit
Powered by GitBook
On this page
Export as PDF
  1. Developers
  2. API

Vault performances

Vault performances track yield metrics, user activity, and reward distributions for vaults. These metrics are used in analytics, reporting, and performance visualization on Pareto.

Structure

Each vault performance object includes:

  • _id (string) — Unique identifier

  • vaultId (string) — Vault being tracked

  • vaultBlockId (string) — Related vault block reference

  • block (object) — Block information:

    • number (number) — Block number

    • timestamp (number) — Unix timestamp

  • age (number) — Block age in seconds

  • holders (number) — Number of unique users in the vault

  • realizedAPY (number) — Realized annual percentage yield

  • accruedRewards (array of objects) —

    • tokenId (string) — Reward token ID

    • amount (string) — Raw amount of rewards

    • amountUSD (string) — Value in USD

    • APR (number) — APR contribution

    • percentage (number) — Share of total reward

  • earnings (object) —

    • USD (string) — USD-denominated earnings

    • token (string) — Token earnings amount

    • percentage (number) — Share of vault value

  • createdAt, updatedAt (string) — ISO 8601 timestamps

  • createdBy, updatedBy (string) — Actor IDs

Endpoints

PreviousVault epochsNextVault types

Last updated 1 month ago

List all vault performance entries

get
Responses
200
Vault performance data
application/json
get
GET /v1/vault-performances HTTP/1.1
Host: api.pareto.credit
Accept: */*
200

Vault performance data

{
  "data": [
    {
      "_id": "text",
      "vaultId": "text",
      "vaultBlockId": "text",
      "block": {
        "number": 1,
        "timestamp": 1
      },
      "age": 1,
      "holders": 1,
      "realizedAPY": 1,
      "accruedRewards": [
        {
          "tokenId": "text",
          "amount": "text",
          "amountUSD": "text",
          "APR": 1,
          "percentage": 1
        }
      ],
      "earnings": {
        "USD": "text",
        "token": "text",
        "percentage": 1
      },
      "createdAt": "2025-05-18T23:24:19.969Z",
      "updatedAt": "2025-05-18T23:24:19.969Z",
      "createdBy": "text",
      "updatedBy": "text"
    }
  ],
  "totalCount": 1
}

Get vault performance by ID

get
Path parameters
vaultPerformanceIdstringRequired
Responses
200
Vault performance entry
application/json
get
GET /v1/vault-performances/{vaultPerformanceId} HTTP/1.1
Host: api.pareto.credit
Accept: */*
200

Vault performance entry

{
  "_id": "text",
  "vaultId": "text",
  "vaultBlockId": "text",
  "block": {
    "number": 1,
    "timestamp": 1
  },
  "age": 1,
  "holders": 1,
  "realizedAPY": 1,
  "accruedRewards": [
    {
      "tokenId": "text",
      "amount": "text",
      "amountUSD": "text",
      "APR": 1,
      "percentage": 1
    }
  ],
  "earnings": {
    "USD": "text",
    "token": "text",
    "percentage": 1
  },
  "createdAt": "2025-05-18T23:24:19.969Z",
  "updatedAt": "2025-05-18T23:24:19.969Z",
  "createdBy": "text",
  "updatedBy": "text"
}
  • Structure
  • Endpoints
  • GETList all vault performance entries
  • GETGet vault performance by ID