Skip to content

Get Portfolio Details

Retrieves detailed metadata about a specific portfolio, including the vaults it controls. This endpoint is accessed through the organization API.

Request URL

GET https://ddp.definitive.fi/v2/organization/portfolios/{portfolioId}

Path Parameters

ParameterTypeRequiredDescription
portfolioIdstringYesUUID of the portfolio to retrieve

Example

const json = await AuthHelpers.signAndSend({
  path: "/v2/organization/portfolios/00000000-0000-0000-0000-000000000001",
  method: "GET",
  organizationId: "00000000-0000-0000-0000-000000000000",
  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",
      multiuserChainAddress: "0x0000000000000000000000000000000000000002",
      name: "Trading Vault",
      status: "ACTIVE", // may also be PENDING, INACTIVE, etc.
      chain: {
        name: "Ethereum",
        id: "1",
        namespace: "eip:155"
      }
    }
    // ... additional vaults
  ]
}

Notes

  • address is the main deposit address used by the system.
  • multiuserChainAddress may be used for alternate flows depending on chain setup.
  • status represents the vault's lifecycle state and may include:
    • ACTIVE: Vault is ready and usable
    • PENDING: Deployment or funding still in progress
    • INACTIVE: Vault is deprecated or disabled