Get Portfolio Details

Retrieves detailed metadata about a specific portfolio, including the vaults it controls.

Endpoint

Portfolio API: GET https://ddp.definitive.fi/v2/portfolio

Organization API: Replace /v2/portfolio with /v2/organization/portfolios/{portfolioId}. See Portfolio vs. Organization API.

Examples

const json = await AuthHelpers.signAndSend({
  path: "/v2/portfolio",
  method: "GET",
  apiKey: process.env.API_KEY,
  apiSecret: process.env.API_SECRET,
});
console.log(json);

Response

{
  portfolioId: "00000000-0000-0000-0000-000000000001",
  portfolioName: "Example Portfolio",
  organizationId: "00000000-0000-0000-0000-000000000002",
  createdAt: "2024-08-05T20:48:11.584Z",
  vaults: [
    {
      vaultId: "00000000-0000-0000-0000-000000000003",
      address: "0x0000000000000000000000000000000000000001",
      name: "Trading Vault",
      status: "VAULT_STATUS_ACTIVE",
      chain: {
        name: "Ethereum",
        id: "1",
        namespace: "eip155"
      },
      signers: [
        "0x0000000000000000000000000000000000000099"
      ]
    }
    // ... additional vaults
  ]
}

Notes

address is the primary deposit address for this vault.
signers is an array of wallet addresses authorized to sign transactions for this vault.
status represents the vault's lifecycle state and may include:
- VAULT_STATUS_ACTIVE: Vault is ready and usable
- VAULT_STATUS_INACTIVE: Vault is deprecated or disabled
- VAULT_STATUS_UNDEPLOYED: Vault has not yet been deployed on-chain
- VAULT_STATUS_UNSPECIFIED: Status has not been set