---
title: "Pages a portfolio's events: trades, cash and notes."
---

> 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 merchant API › portfolio

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

## Authentication

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

## Path parameters

- `store` (`listPortfolioEvents.path.store`; string, required) — The store's id.
- `product` (`listPortfolioEvents.path.product`; string, required) — An id, or `slug:<slug>`.
  - minLength 1

## Query parameters

- `filter` (`listPortfolioEvents.query.filter`; object, optional) — `filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.
- `sort` (`listPortfolioEvents.query.sort`; string, optional)
  - one of `"occurred"`
- `direction` (`listPortfolioEvents.query.direction`; string, optional)
  - one of `"asc"`, `"desc"`
- `limit` (`listPortfolioEvents.query.limit`; integer, optional)
  - min 1; max 100
- `cursor` (`listPortfolioEvents.query.cursor`; string, optional)
  - maxLength 8192
- `count` (`listPortfolioEvents.query.count`; boolean, optional)
- `search` (`listPortfolioEvents.query.search`; string, optional)
  - minLength 1; maxLength 200

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/portfolio/events';
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/merchant/v1/stores/<store>/products/<product>/portfolio/events"

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

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

print(response.text)
```

## Responses

### 200

Pages a portfolio's events: trades, cash and notes.

#### Example

```json
{
  "items": [
    {
      "id": "string",
      "portfolio_id": "string",
      "symbol": "string",
      "type": "string",
      "shares": 0,
      "price": 0,
      "amount": 0,
      "note": "string",
      "effective_date": "string",
      "symbol_type": "string",
      "currency": "string",
      "exponent": 0,
      "price_currency": "string",
      "price_exponent": 0,
      "allocation": 0,
      "allocation_change": 0,
      "ratio": {
        "num": 0,
        "den": 0
      },
      "occurred_at": "string",
      "recorded_at": "string",
      "metadata": {
        "source": "string",
        "recorded_by": "string",
        "file_ids": [
          "string"
        ],
        "remediated": true,
        "kind": "string",
        "name": "string",
        "notify": true,
        "price_quoted": true,
        "property1": true,
        "property2": true
      }
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  }
}
```

- `items` (`listPortfolioEvents.response.200.items`; array<object>, required)
  - `id` (`listPortfolioEvents.response.200.items.id`; string, required)
  - `portfolio_id` (`listPortfolioEvents.response.200.items.portfolio_id`; string, required)
  - `symbol` (`listPortfolioEvents.response.200.items.symbol`; any of, required)
    - any of: `string`, `null`
  - `type` (`listPortfolioEvents.response.200.items.type`; string, required)
  - `shares` (`listPortfolioEvents.response.200.items.shares`; any of, required)
    - any of: `number`, `null`
  - `price` (`listPortfolioEvents.response.200.items.price`; any of, required)
    - any of: `number`, `null`
  - `amount` (`listPortfolioEvents.response.200.items.amount`; any of, required)
    - any of: `number`, `null`
  - `note` (`listPortfolioEvents.response.200.items.note`; any of, required)
    - any of: `string`, `null`
  - `effective_date` (`listPortfolioEvents.response.200.items.effective_date`; any of, required)
    - any of: `string`, `null`
  - `symbol_type` (`listPortfolioEvents.response.200.items.symbol_type`; any of, required)
    - any of: `string`, `null`
  - `currency` (`listPortfolioEvents.response.200.items.currency`; string, required)
  - `exponent` (`listPortfolioEvents.response.200.items.exponent`; any of, required)
    - any of: `number`, `null`
  - `price_currency` (`listPortfolioEvents.response.200.items.price_currency`; string, required)
  - `price_exponent` (`listPortfolioEvents.response.200.items.price_exponent`; any of, required)
    - any of: `number`, `null`
  - `allocation` (`listPortfolioEvents.response.200.items.allocation`; any of, required)
    - any of: `number`, `null`
  - `allocation_change` (`listPortfolioEvents.response.200.items.allocation_change`; any of, required)
    - any of: `number`, `null`
  - `ratio` (`listPortfolioEvents.response.200.items.ratio`; any of, required)
    - any of: `object`, `null`
  - `occurred_at` (`listPortfolioEvents.response.200.items.occurred_at`; any of, required)
    - any of: `string`, `null`
  - `recorded_at` (`listPortfolioEvents.response.200.items.recorded_at`; any of, required)
    - any of: `string`, `null`
  - `metadata` (`listPortfolioEvents.response.200.items.metadata`; object, required)
    - `source` (`listPortfolioEvents.response.200.items.metadata.source`; string, optional) — `manual` for a member's entry, `auto` for the pipeline.
    - `recorded_by` (`listPortfolioEvents.response.200.items.metadata.recorded_by`; string, optional) — The member who recorded a manual entry.
    - `file_ids` (`listPortfolioEvents.response.200.items.metadata.file_ids`; array<string>, optional) — For a file event, the assets it announces on the holding.
    - `remediated` (`listPortfolioEvents.response.200.items.metadata.remediated`; boolean, optional) — A later correction stands in for it.
    - `kind` (`listPortfolioEvents.response.200.items.metadata.kind`; string, optional) — For a split, what the ratio alone cannot tell apart.
    - `name` (`listPortfolioEvents.response.200.items.metadata.name`; string, optional) — The instrument's name core resolved when the event was recorded, never a member's.
    - `notify` (`listPortfolioEvents.response.200.items.metadata.notify`; boolean, optional) — For a trade, whether the seller asked to notify the customers with access.
    - `price_quoted` (`listPortfolioEvents.response.200.items.metadata.price_quoted`; boolean, optional) — The price was left empty and took the symbol's latest quote.
- `cursor` (`listPortfolioEvents.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listPortfolioEvents.response.200.total`; number, optional)
- `facets` (`listPortfolioEvents.response.200.facets`; map<map<number>>, optional)

### default

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

#### Example

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

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


Source: https://docs.sherpo.io/merchant-api/reference/list-portfolio-events/index.md
