US Securities

Search Stocks

This endpoint searches for a stock by a given query phrase or set of phrases, supporting advanced search capabilities with multiple filtering and sorting options.

The search functionality supports complex queries like filtering stocks between specific price ranges, performance thresholds, or market cap sizes, with predefined filters for top gainers, top losers, and user-owned stocks.

Advanced search capabilities include:

Query Options:

  • Text Search: Query by company names, stock symbols, ticker matching
  • Theme Filtering: Filter by investment themes and categories
  • Multi-Parameter: Combine text search with theme filters

Sorting Options:

  • Alphabetical: alphabetical:asc or alphabetical:desc
  • Price-Based: price:asc, percent_change:asc
  • Fundamentals: market_cap:asc, pe_ratio:asc, eps:asc
  • Trading Metrics: volume:asc, div_yield:asc

Advanced Filtering:

  • Price Ranges: price;a:10,price;b:50 (between $10-$50)
  • Performance: percent_change;a:5 (gaining above 5%)
  • Market Cap: market_cap;b:1000000000 (under $1B market cap)
  • Fundamentals: pe_ratio;a:15 (P/E ratio above 15)
  • Predefined Filters: top_gainers, top_losers, my_stocks

Example Usage:

GET /api/stock/search?query=apple&sorting=market_cap:desc&filters=price;a:100,my_stocks
get/api/stock/search

Request

  • Base URL
    https://powered-by-bamboo-sandbox.investbamboo.com
  • Auth
    none declared. Required headers: content-type, accept-language, x-user-id, x-subject-type, x-client-token

Query parameters

querystring required

Query phrase to match stock name or symbol

theme_idstring

Theme id to filter by. This takes only one value

sortingstring

Used to sort the search either by ascending order, descending order, etc. The acceptable values are stated in the description above.

filtersstring

Used to filter the search by providing certain string values separated by a comma. The expected values to be passed for the filters param are stated in the description above.

Headers

content-typestring required

Acceptable content type

accept-languagestring required

Acceptable language; 'en' for English

x-user-idstring required

Required for user authentication

x-subject-typestring required

For user request -> 'tenant'.

x-client-tokenstring required

API consumer token

Response

Stock list

currency_symbolstring

Currency Symbol

Example response

{
  "currency_symbol": "$",
  "result": [
    {
      "symbol": "MDY",
      "name": "S&P MidCap 400 ETF SPDR",
      "logo": "https://d3an3cesqmrf1x.cloudfront.net/images/symbols/mdy.png",
      "background_color": "FFFFFF",
      "avatar": "https://d3an3cesqmrf1x.cloudfront.net/images/symbols/mdy.png"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.