---
title: "Fetch smallcase investments"
method: GET
path: "/{gatewayname}/engine/user/investments"
---

# Fetch smallcase investments

`GET /{gatewayname}/engine/user/investments`

## Request

- Base URL: `https://gatewayapi.smallcase.com/v1`
- URL: `https://gatewayapi.smallcase.com/v1/{gatewayname}/engine/user/investments`
- Auth: none required

The API provides the list of all the user smallcase investment details or returns the user investment details for a particular smallcase, provided a particular iscid in query param. Data like the current config of the smallcase, stats, returns, smallcase description, and much more is shared.

If query param "aggregatedData" is provided, the API shares user’s aggregated investment details. “data” object field containing aggregated data would be returned.

**<<apiUseCaseTerm>>**: This is an ideal data api when you want to display information to a user about the investments that have been made by the user

## Path parameters

- `gatewayname` string, required

## Query parameters

- `iscids` string[]
- `aggregatedData` boolean

## Headers

- `x-gateway-secret` string, required
- `x-gateway-authtoken` string, required

## Response `200`

200

- union
  - object
    - `success` boolean
    - `errors` unknown
    - `data` object[]
      - `investment` object
        - `currentConfig` object
          - `constituents` object[]
            - `averagePrice` number
            - `shares` integer
            - `returns` number
            - `ticker` string
            - `stockName` string
        - `returns` object
          - `accruedReturns` object
            - `LBES` integer
            - `DSPL` integer
          - `creditedReturns` object
            - `LBES` integer
            - `DSPL` integer
          - `networth` number
          - `unrealizedInvestment` number
          - `realizedInvestment` integer
          - `realizedReturns` integer
          - `otherReturns` integer
          - `divReturns` integer
          - `accruedDivReturns` integer
          - `creditedDivReturns` integer
          - `weekly` integer
          - `monthly` integer
          - `insights` object
            - `currentInvestment` number
            - `currentValue` number
            - `totalReturns` number
            - `totalReturnsPercent` number
            - `currentReturns` number
            - `currentReturnsPercent` number
            - `dividendReturns` integer
        - `stats` object
          - `indexValue` number
          - `lastCloseIndex` number
          - `pe` integer
          - `lastToLastWeekCloseIndex` number
          - `lastWeekCloseIndex` number
          - `lastMonthCloseIndex` number
        - `flags` object
          - `amoPending` boolean
          - `private` boolean
          - `sip` boolean
        - `name` string
        - `scid` string
        - `shortDescription` string
        - `date` string
        - `status` string
        - `version` integer
        - `iscid` string
        - `imageUrl` string
        - `recommendedAction` string
      - `actions` object
        - `rebalance` object[]
        - `fix` object[]
        - `sip` object[]
  - object
    - `success` boolean
    - `errors` unknown
    - `data` object
      - `aggregated` object
        - `currentInvestment` integer
        - `currentReturns` number
        - `networth` number
        - `totalReturns` number
        - `currentReturnsPercent` number
        - `totalReturnsPercent` number
  - object
    - `success` boolean
    - `errors` unknown
    - `data` object[]
      - `investment` object
        - `returns` object
          - `accruedReturns` object
            - `LBES` integer
            - `DSPL` integer
          - `creditedReturns` object
            - `LBES` integer
            - `DSPL` integer
          - `networth` number
          - `unrealizedInvestment` number
          - `realizedInvestment` integer
          - `realizedReturns` integer
          - `otherReturns` integer
          - `divReturns` integer
          - `accruedDivReturns` integer
          - `creditedDivReturns` integer
          - `weekly` integer
          - `monthly` integer
          - `insights` object
            - `currentInvestment` number
            - `currentValue` number
            - `totalReturns` number
            - `totalReturnsPercent` number
            - `currentReturns` number
            - `currentReturnsPercent` number
            - `dividendReturns` integer
        - `name` string
        - `scid` string
        - `shortDescription` string
        - `date` string
        - `status` string
        - `version` integer
        - `currentConfig` object
          - `constituents` object[]
            - `averagePrice` number
            - `shares` integer
            - `returns` number
            - `ticker` string
            - `stockName` string
        - `stats` object
          - `indexValue` number
          - `lastCloseIndex` number
          - `pe` integer
          - `lastToLastWeekCloseIndex` unknown
          - `lastWeekCloseIndex` number
        - `flags` object
          - `amoPending` boolean
          - `private` boolean
          - `sip` boolean
          - `sipType` string
        - `iscid` string
        - `imageUrl` string
        - `recommendedAction` string
      - `actions` object
        - `rebalance` object[]
        - `fix` object[]
        - `sip` object[]
          - `hidden` boolean
          - `iscid` string
          - `scid` string
          - `name` string
          - `source` string
          - `frequency` string
          - `amount` number
          - `scheduledDate` string
          - `iscidObj` string
  - object
    - `success` boolean
    - `errors` unknown
    - `data` object[]
      - `investment` object
        - `returns` object
          - `accruedReturns` object
            - `LBES` integer
            - `DSPL` integer
          - `creditedReturns` object
            - `LBES` integer
            - `DSPL` integer
          - `networth` integer
          - `unrealizedInvestment` integer
          - `realizedInvestment` integer
          - `realizedReturns` integer
          - `otherReturns` integer
          - `divReturns` integer
          - `accruedDivReturns` integer
          - `creditedDivReturns` integer
          - `weekly` integer
          - `monthly` integer
          - `insights` object
            - `currentInvestment` integer
            - `currentValue` integer
            - `totalReturns` integer
            - `totalReturnsPercent` unknown
            - `currentReturns` integer
            - `currentReturnsPercent` unknown
            - `dividendReturns` integer
        - `name` string
        - `scid` string
        - `shortDescription` string
        - `date` string
        - `status` string
        - `version` integer
        - `currentConfig` object
          - `constituents` object[]
        - `stats` object
          - `indexValue` unknown
          - `lastCloseIndex` integer
          - `pe` integer
          - `lastToLastWeekCloseIndex` unknown
          - `lastWeekCloseIndex` integer
        - `flags` object
          - `amoPending` boolean
          - `private` boolean
        - `iscid` string
        - `imageUrl` string
        - `recommendedAction` string
      - `actions` object
        - `rebalance` object[]
        - `fix` object[]
          - `hidden` boolean
          - `iscid` string
          - `date` string
          - `name` string
          - `batchId` string
          - `scid` string
          - `source` string
          - `filled` integer
          - `quantity` integer
          - `originalLabel` string
          - `iscidObj` string
        - `sip` object[]
  - object
    - `success` boolean
    - `errors` unknown
    - `data` object[]
      - `investment` object
        - `returns` object
          - `accruedReturns` object
            - `LBES` integer
            - `DSPL` integer
          - `creditedReturns` object
            - `LBES` integer
            - `DSPL` integer
          - `networth` number
          - `unrealizedInvestment` number
          - `realizedInvestment` integer
          - `realizedReturns` integer
          - `otherReturns` integer
          - `divReturns` integer
          - `accruedDivReturns` integer
          - `creditedDivReturns` integer
          - `weekly` integer
          - `monthly` integer
          - `insights` object
            - `currentInvestment` number
            - `currentValue` number
            - `totalReturns` number
            - `totalReturnsPercent` number
            - `currentReturns` number
            - `currentReturnsPercent` number
            - `dividendReturns` integer
        - `name` string
        - `scid` string
        - `shortDescription` string
        - `date` string
        - `status` string
        - `version` integer
        - `currentConfig` object
          - `constituents` object[]
            - `averagePrice` number
            - `shares` integer
            - `returns` number
            - `ticker` string
            - `stockName` string
        - `stats` object
          - `indexValue` number
          - `lastCloseIndex` number
          - `pe` integer
          - `lastToLastWeekCloseIndex` unknown
          - `lastWeekCloseIndex` number
        - `flags` object
          - `amoPending` boolean
          - `private` boolean
          - `sip` boolean
          - `sipType` string
        - `iscid` string
        - `imageUrl` string
        - `recommendedAction` string
      - `actions` object
        - `rebalance` object[]
          - `iscid` string
          - `scid` string
          - `date` string
          - `name` string
          - `label` string
          - `version` integer
          - `rationale` string
          - `hidden` boolean
        - `fix` object[]
        - `sip` object[]

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/smallcase/apis/smallcase-data-v1.md) - [All operations](https://skmtc.dev/smallcase/apis/smallcase-data-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/smallcase/apis/smallcase-data-v1/revisions/9e1b64a1d830?raw)