doc and types for getPortfolios

site/docs/pages/api/get-portfolio-token-balances.mdx → site/docs/pages/api/get-portfolios.mdx

@@ -1,22 +1,24 @@
-# `getPortfolioTokenBalances`
+# `getPortfolios`
 
-The `getPortfolioTokenBalances` function returns an object containing an array of
+The `getPortfolios` function returns an object containing an array of
 portfolios for the provided addresses. Each portfolio is an object with the address
 of the wallet, the fiat value of the portfolio, and an array of tokens held by the
 provided address.
 
+:::info
 Before using this endpoint, make sure to obtain a [Client API Key](https://portal.cdp.coinbase.com/projects/api-keys/client-key)
 from Coinbase Developer Platform.
+:::
 
 ## Usage
 
 :::code-group
 
 ```tsx twoslash [code]
 import { setOnchainKitConfig } from '@coinbase/onchainkit';
-import { getPortfolioTokenBalances } from '@coinbase/onchainkit/api';
+import { getPortfolios } from '@coinbase/onchainkit/api';
 
-const response = await getPortfolioTokenBalances({
+const response = await getPortfolios({
   addresses: ['0x...'],
 });
 ```
@@ -44,8 +46,8 @@ const response = await getPortfolioTokenBalances({
 
 ## Returns
 
-[`Promise<GetPortfoliosAPIResponse>`](/api/types#getportfoliosapiresponse)
+[`Promise<GetPortfoliosResponse>`](/api/types#getportfoliosresponse)
 
 ## Parameters
 
-[`GetPortfolioTokenBalancesParams`](/api/types#getportfoliotokenbalancesparams)
+[`GetPortfoliosParams`](/api/types#getportfoliosparams)

site/docs/pages/api/types.mdx

@@ -142,20 +142,18 @@ type BuildMintTransactionParams = {
 type BuildMintTransactionResponse = MintTransaction | APIError;
 ```
 
-## `GetPortfolioTokenBalancesParams`
+## `GetPortfolioParams`
 
 ```ts
-type GetPortfolioTokenBalancesParams = {
+type GetPortfolioParams = {
   addresses: Address[] | null | undefined;
 };
 ```
 
-## `PortfolioTokenBalances`
+## `GetPortfoliosResponse`
 
 ```ts
-type PortfolioTokenBalances = {
-  address: Address;
-  portfolioBalanceInUsd: number;
-  tokenBalances: PortfolioTokenWithFiatValue[];
+type GetPortfoliosResponse = {
+  portfolios: Portfolio[];
 };
 ```