---
title: "Value portfolio"
description: "Values a portfolio at live quotes and prices its watchlist, for a customer with access."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Value portfolio

Needs the read scope.

## Call

- Tool: `get_portfolio_valuation`
- Scope: `read`
- Reads only.
- Acts on a store.

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `product` | `object` | Yes |  |
| `preview` | `string` | No | A token a seller made for the product's page or one of its entries, which opens an unpublished product's portfolio, gated as ever. |

```json
{
  "type": "object",
  "properties": {
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "preview": {
      "description": "A token a seller made for the product's page or one of its entries, which opens an unpublished product's portfolio, gated as ever.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": [
    "product"
  ],
  "additionalProperties": false
}
```

## Answer

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `product_id` | `string` | Yes |  |
| `currency` | `string` | Yes |  |
| `exponent` | `number or null` | Yes |  |
| `as_of` | `string` | Yes |  |
| `cash` | `number or null` | Yes |  |
| `holdings_value` | `number` | Yes |  |
| `total_value` | `number or null` | Yes |  |
| `change_percent` | `number or null` | Yes |  |
| `prices_stale` | `boolean` | Yes |  |
| `failed_types` | `array of string` | Yes |  |
| `holdings` | `array of object` | Yes |  |
| `watchlist` | `array of object` | Yes |  |

The answer's full shape is on [its API reference page](/customer-api/reference/get-portfolio-valuation).

Source: https://docs.sherpo.io/customer-mcp/tools/get_portfolio_valuation/index.mdx
