CLclear-street
Instrument Data

Get Instrument Fundamentals

Changed on

Retrieves supplemental fundamentals and company profile data for an instrument.

get/v1/instruments/{instrument_id}/fundamentals

Request

  • Base URL
    https://api.clearstreet.com
  • Auth
    HTTP bearer

Path parameters

instrument_idstring required

Instrument identifier: either an instrument UUID or a symbol (symbol for equities, OSI for options). Non-UUID inputs are resolved server-side.

Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).

Response

Instrument fundamentals

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  },
  "data": {
    "average_volume": 76000000,
    "beta": "1.20",
    "description": "Apple Inc. designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and accessories worldwide.",
    "dividend_yield": "0.005",
    "earnings_per_share": "5.61",
    "fifty_two_week_high": "230.00",
    "fifty_two_week_low": "165.00",
    "industry": "Consumer Electronics",
    "list_date": "1980-12-12",
    "logo_url": "https://example.com/logos/aapl.png",
    "market_cap": "2800000000000",
    "previous_close": "210.87",
    "price_to_earnings": "30.5",
    "sector": "Technology"
  }
}

Changes

  • 1bd9eddeffc8Revision changes
    • breaking

      for the path request parameter instrument_id, the minLength was increased from 0 to 1

    • info

      for the path request parameter instrument_id, the type was generalized from no type to string

  • 9ab37402db94Revision changes
    • info

      added the non-success response with the status