---
title: "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.

Path: Sherpo customer API › portfolio

`GET /v1/stores/{store}/products/{product}/portfolio/valuation`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `read`

## Path parameters

- `store` (`getPortfolioValuation.path.store`; string, required) — A hostname of the store.
- `product` (`getPortfolioValuation.path.product`; string, required) — An id, or `slug:<slug>`.
  - minLength 1

## Query parameters

- `preview` (`getPortfolioValuation.query.preview`; string, optional) — 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.
  - minLength 1; maxLength 128

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/customer/v1/stores/<store>/products/<product>/portfolio/valuation' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/customer/v1/stores/<store>/products/<product>/portfolio/valuation';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/customer/v1/stores/<store>/products/<product>/portfolio/valuation"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Values a portfolio at live quotes and prices its watchlist, for a customer with access.

#### Example

```json
{
  "product_id": "string",
  "currency": "string",
  "exponent": 0,
  "as_of": "string",
  "cash": 0,
  "holdings_value": 0,
  "total_value": 0,
  "change_percent": 0,
  "prices_stale": true,
  "failed_types": [
    "string"
  ],
  "holdings": [
    {
      "id": "string",
      "symbol": "string",
      "symbol_type": "string",
      "name": "string",
      "note": "string",
      "shares": 0,
      "avg_cost": 0,
      "cost_currency": "string",
      "cost_exponent": 0,
      "value": 0,
      "day_change": 0,
      "quote": {
        "price": 0,
        "currency": "string",
        "exponent": 0,
        "change_percent": 0,
        "as_of": "string",
        "stale": true
      }
    }
  ],
  "watchlist": [
    {
      "id": "string",
      "symbol": "string",
      "symbol_type": "string",
      "name": "string",
      "note": "string",
      "was_held": true,
      "avg_cost": 0,
      "cost_currency": "string",
      "cost_exponent": 0,
      "watched_at": "string",
      "quote": {
        "price": 0,
        "currency": "string",
        "exponent": 0,
        "change_percent": 0,
        "as_of": "string",
        "stale": true
      }
    }
  ]
}
```

- `product_id` (`getPortfolioValuation.response.200.product_id`; string, required)
- `currency` (`getPortfolioValuation.response.200.currency`; string, required)
- `exponent` (`getPortfolioValuation.response.200.exponent`; any of, required)
  - any of: `number`, `null`
- `as_of` (`getPortfolioValuation.response.200.as_of`; string, required)
- `cash` (`getPortfolioValuation.response.200.cash`; any of, required)
  - any of: `number`, `null`
- `holdings_value` (`getPortfolioValuation.response.200.holdings_value`; number, required)
- `total_value` (`getPortfolioValuation.response.200.total_value`; any of, required)
  - any of: `number`, `null`
- `change_percent` (`getPortfolioValuation.response.200.change_percent`; any of, required)
  - any of: `number`, `null`
- `prices_stale` (`getPortfolioValuation.response.200.prices_stale`; boolean, required)
- `failed_types` (`getPortfolioValuation.response.200.failed_types`; array<string>, required)
- `holdings` (`getPortfolioValuation.response.200.holdings`; array<object>, required)
  - `id` (`getPortfolioValuation.response.200.holdings.id`; string, required)
  - `symbol` (`getPortfolioValuation.response.200.holdings.symbol`; string, required)
  - `symbol_type` (`getPortfolioValuation.response.200.holdings.symbol_type`; string, required)
  - `name` (`getPortfolioValuation.response.200.holdings.name`; string, required)
  - `note` (`getPortfolioValuation.response.200.holdings.note`; any of, required)
    - any of: `string`, `null`
  - `shares` (`getPortfolioValuation.response.200.holdings.shares`; number, required) — Scaled by 1e8.
  - `avg_cost` (`getPortfolioValuation.response.200.holdings.avg_cost`; any of, required) — Per share, in `cost_currency`'s minor unit.
    - any of: `number`, `null`
  - `cost_currency` (`getPortfolioValuation.response.200.holdings.cost_currency`; string, required) — The currency the holding's cost was recorded in (`metadata.cost_currency`), else the portfolio's, as for an unknown code.
  - `cost_exponent` (`getPortfolioValuation.response.200.holdings.cost_exponent`; any of, required) — `cost_currency`'s exponent, null when central does not know it.
    - any of: `number`, `null`
  - `value` (`getPortfolioValuation.response.200.holdings.value`; any of, required) — At the live price, in the quote's currency's minor unit; null without a quote.
    - any of: `number`, `null`
  - `day_change` (`getPortfolioValuation.response.200.holdings.day_change`; any of, required) — The position's move today, in the quote's currency's minor unit; null without a fresh change.
    - any of: `number`, `null`
  - `quote` (`getPortfolioValuation.response.200.holdings.quote`; any of, required)
    - any of: `object`, `null`
- `watchlist` (`getPortfolioValuation.response.200.watchlist`; array<object>, required)
  - `id` (`getPortfolioValuation.response.200.watchlist.id`; string, required)
  - `symbol` (`getPortfolioValuation.response.200.watchlist.symbol`; string, required)
  - `symbol_type` (`getPortfolioValuation.response.200.watchlist.symbol_type`; string, required)
  - `name` (`getPortfolioValuation.response.200.watchlist.name`; string, required)
  - `note` (`getPortfolioValuation.response.200.watchlist.note`; any of, required)
    - any of: `string`, `null`
  - `was_held` (`getPortfolioValuation.response.200.watchlist.was_held`; boolean, required) — Once a position, since sold to zero.
  - `avg_cost` (`getPortfolioValuation.response.200.watchlist.avg_cost`; any of, required) — The cost per share a once-held symbol keeps, in `cost_currency`'s minor unit; null for one never held.
    - any of: `number`, `null`
  - `cost_currency` (`getPortfolioValuation.response.200.watchlist.cost_currency`; string, required) — The currency the holding's cost was recorded in (`metadata.cost_currency`), else the portfolio's, as for an unknown code.
  - `cost_exponent` (`getPortfolioValuation.response.200.watchlist.cost_exponent`; any of, required) — `cost_currency`'s exponent, null when central does not know it.
    - any of: `number`, `null`
  - `watched_at` (`getPortfolioValuation.response.200.watchlist.watched_at`; any of, required) — When it was last put on the watchlist, null for a row no watch event names.
    - any of: `string`, `null`
  - `quote` (`getPortfolioValuation.response.200.watchlist.quote`; any of, required)
    - any of: `object`, `null`

### default

A problem; see https://api.sherpo.io/customer/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`getPortfolioValuation.response.default.type`; string, required)
  - format `uri`
- `title` (`getPortfolioValuation.response.default.title`; string, required)
- `status` (`getPortfolioValuation.response.default.status`; integer, required)
- `detail` (`getPortfolioValuation.response.default.detail`; string, required)
- `code` (`getPortfolioValuation.response.default.code`; string, optional)
- `context` (`getPortfolioValuation.response.default.context`; object, optional)
- `reached_core` (`getPortfolioValuation.response.default.reached_core`; boolean, optional)
- `core_answer` (`getPortfolioValuation.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/customer-api/reference/get-portfolio-valuation/index.md
