Skip to content
Navigation

Reads the latest quotes for symbols.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/symbols/quotes/query

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Request body JSON required

  • symbols
    array of
    object
    required
    • symbol
      string
      required
      maxLength: 32 · minLength: 1 · pattern: ^[A-Za-z0-9.^=_&-]{1,32}$
    • symbol_type
      stock
      or
      crypto
      required

Returns

200

Reads the latest quotes for symbols.

JSON
  • items
    array of
    object
    required
    • symbol
      string
      required
    • symbol_type
      string
      required
    • price
      number
      required

      Per share or coin, in the currency's minor unit.

    • currency
      string
      required
    • exponent
      number
      required
    • change_percent
      required

      The day's move in percent, null when there is no prior close or the quote is stale.

      One of the following:

      • number
      • null
    • as_of
      required

      One of the following:

      • string
      • null
    • stale
      boolean
      required

      Too old to show as live.

  • unpriced
    array of
    object
    required
    • symbol
      string
      required
    • symbol_type
      string
      required
  • failed_types
    array of
    string
    required

    The types whose read failed, their symbols left unpriced, so a caller can ask again.

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