Skip to content
Clear Street Clear Street
Get started
API Reference
V1
Instrument Data

Get Instrument Fundamentals

InstrumentDataGetInstrumentFundamentalsResponse v1().instrumentData().getInstrumentFundamentals(InstrumentDataGetInstrumentFundamentalsParamsparams = InstrumentDataGetInstrumentFundamentalsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/instruments/{instrument_id}/fundamentals

Retrieves supplemental fundamentals and company profile data for an instrument.

ParametersExpand Collapse
InstrumentDataGetInstrumentFundamentalsParams params
Optional<String> instrumentId

OEMS instrument UUID

formatuuid
ReturnsExpand Collapse
class InstrumentDataGetInstrumentFundamentalsResponse:

Supplemental fundamentals and company profile data for an instrument.

Optional<Long> averageVolume

The average daily trading volume over the past 30 days

formatint64
Optional<String> beta

The beta value, measuring the instrument’s volatility relative to the overall market

Optional<String> description

A detailed description of the instrument or company

Optional<String> dividendYield

The trailing twelve months (TTM) dividend yield

Optional<String> earningsPerShare

The trailing twelve months (TTM) earnings per share

Optional<String> fiftyTwoWeekHigh

The highest price over the last 52 weeks

Optional<String> fiftyTwoWeekLow

The lowest price over the last 52 weeks

Optional<String> industry

The specific industry of the instrument’s issuer

Optional<LocalDate> listDate

The date the instrument was first listed

formatdate
Optional<String> logoUrl

URL to a representative logo image for the instrument or issuer

Optional<String> marketCap

The total market capitalization

Optional<String> previousClose

The closing price from the previous trading day

Optional<String> priceToEarnings

The price-to-earnings (P/E) ratio for the trailing twelve months (TTM)

Optional<String> reportingCurrency

The currency used for reporting financial data

Optional<String> sector

The business sector of the instrument’s issuer

Get Instrument Fundamentals

package com.clear_street.api.example;

import com.clear_street.api.client.ClearStreetClient;
import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient;
import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentFundamentalsParams;
import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentFundamentalsResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        InstrumentDataGetInstrumentFundamentalsResponse response = client.v1().instrumentData().getInstrumentFundamentals("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
    }
}
{
  "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"
  }
}