Skip to content
Navigation

Values a portfolio at live quotes and prices its watchlist.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/portfolio/valuation

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Returns

200

Values a portfolio at live quotes and prices its watchlist.

JSON
  • product_id
    string
    required
  • currency
    string
    required
  • exponent
    required

    One of the following:

    • number
    • null
  • as_of
    string
    required
  • cash
    required

    One of the following:

    • number
    • null
  • holdings_value
    number
    required
  • total_value
    required

    One of the following:

    • number
    • null
  • change_percent
    required

    One of the following:

    • number
    • null
  • prices_stale
    boolean
    required
  • failed_types
    array of
    string
    required
  • holdings
    array of
    object
    required
    • id
      string
      required
    • symbol
      string
      required
    • symbol_type
      string
      required
    • name
      string
      required
    • note
      required

      One of the following:

      • string
      • null
    • shares
      number
      required

      Scaled by 1e8.

    • avg_cost
      required

      Per share, in cost_currency's minor unit.

      One of the following:

      • number
      • null
    • 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
      required

      cost_currency's exponent, null when central does not know it.

      One of the following:

      • number
      • null
    • value
      required

      At the live price, in the quote's currency's minor unit; null without a quote.

      One of the following:

      • number
      • null
    • day_change
      required

      The position's move today, in the quote's currency's minor unit; null without a fresh change.

      One of the following:

      • number
      • null
    • quote
      required

      One of the following:

      • object
      • null
  • watchlist
    array of
    object
    required
    • id
      string
      required
    • symbol
      string
      required
    • symbol_type
      string
      required
    • name
      string
      required
    • note
      required

      One of the following:

      • string
      • null
    • was_held
      boolean
      required

      Once a position, since sold to zero.

    • avg_cost
      required

      The cost per share a once-held symbol keeps, in cost_currency's minor unit; null for one never held.

      One of the following:

      • number
      • null
    • 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
      required

      cost_currency's exponent, null when central does not know it.

      One of the following:

      • number
      • null
    • watched_at
      required

      When it was last put on the watchlist, null for a row no watch event names.

      One of the following:

      • string
      • null
    • quote
      required

      One of the following:

      • object
      • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close