Vaults

Vaults are the core contracts of the Pareto protocol. They represent on-chain vehicles that accept user deposits, deploy strategies, and accrue yield over time.

Each vault is tied to a specific strategy, chain, and token, and is managed by one or more operators.

Structure

Each vault object includes:

• _id (string) — Unique identifier

• tokenId (string) — Accepted token reference

• chainId (string) — Blockchain network identifier

• typeId (string) — Reference to vault type

• categoryId (string) — Vault category

• operatorIds (array[string]) — Managing entities

• name (string) — Name of the vault

• address (string) — On-chain vault contract address

• symbol (string) — Symbol of the share token

• protocol (string) — Strategy protocol (e.g., AaveV2, Clearpool, Morpho, etc.)

• contractType (string) — Contract logic (e.g., BestYield, CDO, CDO_EPOCH)

• abi (array) — ABI definition

• description, shortDescription, caption (object) — Multilingual metadata

• keyInfo (array) — Key-value UI information

• visibility (string) — One of: PUBLIC, RESTRICTED, HIDDEN

• status (string) — Deployment status (e.g., READY, PAUSED, DISABLED)

• feePercentage (number) — Vault fee as percentage

• createdAt, updatedAt (string) — ISO timestamps

• createdBy, updatedBy (string) — System actor IDs

Endpoints

List all vaults

get

Responses

200

A list of vaults

application/json

totalCountintegerOptional

get

/vaults

HTTPcURLJavaScriptPython

GET /v1/vaults HTTP/1.1
Host: api.pareto.credit
Accept: */*

200

A list of vaults

{
  "data": [
    {
      "_id": "text",
      "tokenId": "text",
      "chainId": "text",
      "typeId": "text",
      "categoryId": "text",
      "operatorIds": [
        "text"
      ],
      "name": "text",
      "address": "text",
      "symbol": "text",
      "protocol": "Idle",
      "contractType": "BestYield",
      "abi": [
        {}
      ],
      "description": {
        "en": "text"
      },
      "shortDescription": {
        "en": "text"
      },
      "caption": {
        "en": "text"
      },
      "keyInfo": [
        {
          "label": {
            "en": "text"
          },
          "value": {
            "en": "text"
          }
        }
      ],
      "visibility": "HIDDEN",
      "status": "PAUSED",
      "feePercentage": 1,
      "createdAt": "2026-03-24T07:20:53.686Z",
      "createdBy": "text",
      "updatedAt": "2026-03-24T07:20:53.686Z",
      "updatedBy": "text"
    }
  ],
  "totalCount": 1
}

Get vault by ID

get

Path parameters

vaultIdstringRequired

Responses

200

Single vault object

application/json

_idstringRequired

tokenIdstringRequired

chainIdstringRequired

typeIdstringRequired

categoryIdstringRequired

operatorIdsstring[]Required

namestringRequired

addressstringRequired

symbolstringRequired

protocolstring · enumRequiredPossible values:

contractTypestring · enumRequiredPossible values:

abiobject[]Required

visibilitystring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

feePercentagenumberRequired

createdAtstring · date-timeRequired

createdBystringRequired

updatedAtstring · date-timeRequired

updatedBystringRequired

get

/vaults/{vaultId}

HTTPcURLJavaScriptPython

GET /v1/vaults/{vaultId} HTTP/1.1
Host: api.pareto.credit
Accept: */*

200

Single vault object

{
  "_id": "text",
  "tokenId": "text",
  "chainId": "text",
  "typeId": "text",
  "categoryId": "text",
  "operatorIds": [
    "text"
  ],
  "name": "text",
  "address": "text",
  "symbol": "text",
  "protocol": "Idle",
  "contractType": "BestYield",
  "abi": [
    {}
  ],
  "description": {
    "en": "text"
  },
  "shortDescription": {
    "en": "text"
  },
  "caption": {
    "en": "text"
  },
  "keyInfo": [
    {
      "label": {
        "en": "text"
      },
      "value": {
        "en": "text"
      }
    }
  ],
  "visibility": "HIDDEN",
  "status": "PAUSED",
  "feePercentage": 1,
  "createdAt": "2026-03-24T07:20:53.686Z",
  "createdBy": "text",
  "updatedAt": "2026-03-24T07:20:53.686Z",
  "updatedBy": "text"
}

Aggregated vault performance list

get

Responses

200

Vaults performance metrics

application/json

dataobject[]Optional

totalCountintegerOptional

get

/vaults/performances

HTTPcURLJavaScriptPython

GET /v1/vaults/performances HTTP/1.1
Host: api.pareto.credit
Accept: */*

200

Vaults performance metrics

{
  "data": [
    {}
  ],
  "totalCount": 1
}

Get integrations related to a vault

get

Path parameters

vaultIdstringRequired

Responses

200

Integration data

application/json

Other propertiesanyOptional

get

/vaults/{vaultId}/integrations

HTTPcURLJavaScriptPython

GET /v1/vaults/{vaultId}/integrations HTTP/1.1
Host: api.pareto.credit
Accept: */*

200

Integration data

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}