Skip to content
Navigation

Searches the market for symbols by name or ticker.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/symbols

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Query parameters

  • query
    string
    required
    maxLength: 64 · minLength: 1 · pattern: \S
  • symbol_type
    optional

    One of the following:

    • string
    • null

Returns

200

Searches the market for symbols by name or ticker.

JSON
  • items
    array of
    object
    required
    • symbol
      string
      required
    • name
      string
      required
    • symbol_type
      string
      required
    • region
      required

      One of the following:

      • string
      • null
    • currency
      required

      The lowercase ISO currency it is listed in, null when the market data names none.

      One of the following:

      • string
      • 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