Skip to content
Clear Street Clear Street
Start Trading
API Reference
V1
Instrument Data

Get Instrument Fundamentals

client.V1.InstrumentData.GetInstrumentFundamentals(ctx, instrumentID) (*V1InstrumentDataGetInstrumentFundamentalsResponse, error)
GET/v1/instruments/{instrument_id}/fundamentals

Retrieves supplemental fundamentals and company profile data for an instrument.

ParametersExpand Collapse

Instrument identifier

formatuuid
ReturnsExpand Collapse
type V1InstrumentDataGetInstrumentFundamentalsResponse struct{…}

Supplemental fundamentals and company profile data for an instrument.

AverageVolume int64Optional

The average daily trading volume over the past 30 days When a null/undefined value is observed, it indicates that there is no available data.

formatint64
Beta stringOptional

The beta value, measuring the instrument’s volatility relative to the overall market When a null/undefined value is observed, it indicates that there is no available data.

Description stringOptional

A detailed description of the instrument or company When a null/undefined value is observed, it indicates that there is no available data.

DividendYield stringOptional

The trailing twelve months (TTM) dividend yield When a null/undefined value is observed, it indicates that there is no available data.

EarningsPerShare stringOptional

The trailing twelve months (TTM) earnings per share When a null/undefined value is observed, it indicates that there is no available data.

FiftyTwoWeekHigh stringOptional

The highest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.

FiftyTwoWeekLow stringOptional

The lowest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.

Industry stringOptional

The specific industry of the instrument’s issuer When a null/undefined value is observed, it indicates that there is no available data.

ListDate TimeOptional

The date the instrument was first listed When a null/undefined value is observed, it indicates that there is no available data.

formatdate
LogoURL stringOptional

URL to a representative logo image for the instrument or issuer When a null/undefined value is observed, it indicates that there is no available data.

MarketCap stringOptional

The total market capitalization When a null/undefined value is observed, it indicates that there is no available data.

PreviousClose stringOptional

The closing price from the previous trading day When a null/undefined value is observed, it indicates that there is no available data.

PriceToEarnings stringOptional

The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) When a null/undefined value is observed, it indicates that there is no available data.

ReportingCurrency stringOptional

The currency used for reporting financial data When a null/undefined value is observed, it indicates that there is no available data.

Sector stringOptional

The business sector of the instrument’s issuer When a null/undefined value is observed, it indicates that there is no available data.

Get Instrument Fundamentals

package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.InstrumentData.GetInstrumentFundamentals(context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}

{
  "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",
    "reporting_currency": "USD",
    "sector": "Technology"
  },
  "error": null,
  "metadata": {
    "request_id": "5b6c7d8e-9f0a-1b2c-3d4e-5f6a7b8c9d0e"
  }
}
Returns Examples
{
  "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",
    "reporting_currency": "USD",
    "sector": "Technology"
  },
  "error": null,
  "metadata": {
    "request_id": "5b6c7d8e-9f0a-1b2c-3d4e-5f6a7b8c9d0e"
  }
}