financialmodelingprep

package module
v0.1.57 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 3, 2026 License: MIT Imports: 17 Imported by: 0

README

go-financialmodelingprep

Offer an standardarized Go client for Financial Modeling Prep API.

Install
go get github.com/zhoub/go-financialmodelingprep
Usage
// Create client with API key.
c := MustClient(&ClientOptions{APIKey: apiKey})

// Call API to get data.
c.GetCompanyProfile(context.Background(), &ProfileGetParams{Symbol: "AAPL"})

Documentation

Overview

Package financialmodelingprep provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version b211fc929f1c5f17a2d4cdeb27fabd3c2ca2f0b1 DO NOT EDIT.

Index

Constants

View Source 
const (
	ApiKeyAuthScopes apiKeyAuthContextKey = "ApiKeyAuth.Scopes"
)

Variables

This section is empty.

Functions

func Get added in v0.1.1 

func Get(ctx context.Context, c *ClientWithResponses, path OperationPath, params map[string]interface{}) (resp *http.Response, err error)

Get executes an API operation using the provided client, context, operation path, and parameters.

func GetSpec added in v0.1.43 

func GetSpec() (swagger *openapi3.T, err error)

GetSpec returns the OpenAPI specification corresponding to the generated code in this file. External references in the spec are resolved through PathToRawSpec; externally-referenced files must be embedded in their corresponding Go packages (via the import-mapping feature). URL-based external refs are not supported.

func GetSpecJSON added in v0.1.43 

func GetSpecJSON() ([]byte, error)

GetSpecJSON returns the raw JSON bytes of the embedded OpenAPI specification: decompressed but not unmarshaled. External references are not resolved here; the bytes are the spec exactly as embedded by codegen. The result is cached at package init time, so repeated calls are cheap.

func GetSwagger deprecated 

func GetSwagger() (*openapi3.T, error)

GetSwagger returns the OpenAPI specification corresponding to the generated code in this file.

Deprecated: GetSwagger predates kin-openapi renaming openapi3.Swagger to openapi3.T. Use GetSpec instead. This wrapper is retained for backwards compatibility.

func NewAnalystEstimatesGetRequest 

func NewAnalystEstimatesGetRequest(server string, params *AnalystEstimatesGetParams) (*http.Request, error)

NewAnalystEstimatesGetRequest constructs an http.Request for the AnalystEstimatesGet method

func NewAvailableExchangesGetRequest added in v0.1.4 

func NewAvailableExchangesGetRequest(server string) (*http.Request, error)

NewAvailableExchangesGetRequest constructs an http.Request for the AvailableExchangesGet method

func NewBalanceSheetStatementBulkGetRequest added in v0.1.29 

func NewBalanceSheetStatementBulkGetRequest(server string, params *BalanceSheetStatementBulkGetParams) (*http.Request, error)

NewBalanceSheetStatementBulkGetRequest constructs an http.Request for the BalanceSheetStatementBulkGet method

func NewBalanceSheetStatementGetRequest 

func NewBalanceSheetStatementGetRequest(server string, params *BalanceSheetStatementGetParams) (*http.Request, error)

NewBalanceSheetStatementGetRequest constructs an http.Request for the BalanceSheetStatementGet method

func NewBalanceSheetStatementTTMGetRequest added in v0.1.11 

func NewBalanceSheetStatementTTMGetRequest(server string, params *BalanceSheetStatementTTMGetParams) (*http.Request, error)

NewBalanceSheetStatementTTMGetRequest constructs an http.Request for the BalanceSheetStatementTTMGet method

func NewBatchAfterMarketQuoteGetRequest added in v0.1.45 

func NewBatchAfterMarketQuoteGetRequest(server string, params *BatchAfterMarketQuoteGetParams) (*http.Request, error)

NewBatchAfterMarketQuoteGetRequest constructs an http.Request for the BatchAfterMarketQuoteGet method

func NewBatchIndexQuotesGetRequest added in v0.1.30 

func NewBatchIndexQuotesGetRequest(server string, params *BatchIndexQuotesGetParams) (*http.Request, error)

NewBatchIndexQuotesGetRequest constructs an http.Request for the BatchIndexQuotesGet method

func NewBatchQuoteGetRequest 

func NewBatchQuoteGetRequest(server string, params *BatchQuoteGetParams) (*http.Request, error)

NewBatchQuoteGetRequest constructs an http.Request for the BatchQuoteGet method

func NewBatchQuoteShortGetRequest 

func NewBatchQuoteShortGetRequest(server string, params *BatchQuoteShortGetParams) (*http.Request, error)

NewBatchQuoteShortGetRequest constructs an http.Request for the BatchQuoteShortGet method

func NewBiggestGainersGetRequest added in v0.1.54 

func NewBiggestGainersGetRequest(server string) (*http.Request, error)

NewBiggestGainersGetRequest constructs an http.Request for the BiggestGainersGet method

func NewBiggestLosersGetRequest added in v0.1.54 

func NewBiggestLosersGetRequest(server string) (*http.Request, error)

NewBiggestLosersGetRequest constructs an http.Request for the BiggestLosersGet method

func NewCashFlowStatementBulkGetRequest added in v0.1.29 

func NewCashFlowStatementBulkGetRequest(server string, params *CashFlowStatementBulkGetParams) (*http.Request, error)

NewCashFlowStatementBulkGetRequest constructs an http.Request for the CashFlowStatementBulkGet method

func NewCashFlowStatementGetRequest 

func NewCashFlowStatementGetRequest(server string, params *CashFlowStatementGetParams) (*http.Request, error)

NewCashFlowStatementGetRequest constructs an http.Request for the CashFlowStatementGet method

func NewCashFlowStatementTTMGetRequest added in v0.1.11 

func NewCashFlowStatementTTMGetRequest(server string, params *CashFlowStatementTTMGetParams) (*http.Request, error)

NewCashFlowStatementTTMGetRequest constructs an http.Request for the CashFlowStatementTTMGet method

func NewCommoditiesListGetRequest added in v0.1.42 

func NewCommoditiesListGetRequest(server string) (*http.Request, error)

NewCommoditiesListGetRequest constructs an http.Request for the CommoditiesListGet method

func NewCryptocurrencyListGetRequest added in v0.1.55 

func NewCryptocurrencyListGetRequest(server string) (*http.Request, error)

NewCryptocurrencyListGetRequest constructs an http.Request for the CryptocurrencyListGet method

func NewDcfBulkGetRequest added in v0.1.29 

func NewDcfBulkGetRequest(server string) (*http.Request, error)

NewDcfBulkGetRequest constructs an http.Request for the DcfBulkGet method

func NewDelistedCompaniesRequest added in v0.1.26 

func NewDelistedCompaniesRequest(server string, params *DelistedCompaniesParams) (*http.Request, error)

NewDelistedCompaniesRequest constructs an http.Request for the DelistedCompanies method

func NewDividendsCalendarGetRequest added in v0.1.8 

func NewDividendsCalendarGetRequest(server string, params *DividendsCalendarGetParams) (*http.Request, error)

NewDividendsCalendarGetRequest constructs an http.Request for the DividendsCalendarGet method

func NewDividendsGetRequest added in v0.1.8 

func NewDividendsGetRequest(server string, params *DividendsGetParams) (*http.Request, error)

NewDividendsGetRequest constructs an http.Request for the DividendsGet method

func NewETFCountryWeightingsGetRequest added in v0.1.32 

func NewETFCountryWeightingsGetRequest(server string, params *ETFCountryWeightingsGetParams) (*http.Request, error)

NewETFCountryWeightingsGetRequest constructs an http.Request for the ETFCountryWeightingsGet method

func NewETFHoldingsGetRequest added in v0.1.34 

func NewETFHoldingsGetRequest(server string, params *ETFHoldingsGetParams) (*http.Request, error)

NewETFHoldingsGetRequest constructs an http.Request for the ETFHoldingsGet method

func NewETFInfoGetRequest added in v0.1.32 

func NewETFInfoGetRequest(server string, params *ETFInfoGetParams) (*http.Request, error)

NewETFInfoGetRequest constructs an http.Request for the ETFInfoGet method

func NewETFListGetRequest added in v0.1.32 

func NewETFListGetRequest(server string) (*http.Request, error)

NewETFListGetRequest constructs an http.Request for the ETFListGet method

func NewETFSectorWeightingsGetRequest added in v0.1.32 

func NewETFSectorWeightingsGetRequest(server string, params *ETFSectorWeightingsGetParams) (*http.Request, error)

NewETFSectorWeightingsGetRequest constructs an http.Request for the ETFSectorWeightingsGet method

func NewEarningsCalendarGetRequest added in v0.1.53 

func NewEarningsCalendarGetRequest(server string, params *EarningsCalendarGetParams) (*http.Request, error)

NewEarningsCalendarGetRequest constructs an http.Request for the EarningsCalendarGet method

func NewEarningsGetRequest added in v0.1.8 

func NewEarningsGetRequest(server string, params *EarningsGetParams) (*http.Request, error)

NewEarningsGetRequest constructs an http.Request for the EarningsGet method

func NewEconomicCalendarGetRequest 

func NewEconomicCalendarGetRequest(server string, params *EconomicCalendarGetParams) (*http.Request, error)

NewEconomicCalendarGetRequest constructs an http.Request for the EconomicCalendarGet method

func NewEnterpriseValueGetRequest added in v0.1.10 

func NewEnterpriseValueGetRequest(server string, params *EnterpriseValueGetParams) (*http.Request, error)

NewEnterpriseValueGetRequest constructs an http.Request for the EnterpriseValueGet method

func NewEsgDisclosuresGetRequest 

func NewEsgDisclosuresGetRequest(server string, params *EsgDisclosuresGetParams) (*http.Request, error)

NewEsgDisclosuresGetRequest constructs an http.Request for the EsgDisclosuresGet method

func NewEsgRatingsGetRequest 

func NewEsgRatingsGetRequest(server string, params *EsgRatingsGetParams) (*http.Request, error)

NewEsgRatingsGetRequest constructs an http.Request for the EsgRatingsGet method

func NewForexCurrencyPairsGetRequest added in v0.1.34 

func NewForexCurrencyPairsGetRequest(server string) (*http.Request, error)

NewForexCurrencyPairsGetRequest constructs an http.Request for the ForexCurrencyPairsGet method

func NewGradesLatestNewsGetRequest 

func NewGradesLatestNewsGetRequest(server string, params *GradesLatestNewsGetParams) (*http.Request, error)

NewGradesLatestNewsGetRequest constructs an http.Request for the GradesLatestNewsGet method

func NewHistoricalChart15MinGetRequest added in v0.1.28 

func NewHistoricalChart15MinGetRequest(server string, params *HistoricalChart15MinGetParams) (*http.Request, error)

NewHistoricalChart15MinGetRequest constructs an http.Request for the HistoricalChart15MinGet method

func NewHistoricalPriceEodFullGetRequest 

func NewHistoricalPriceEodFullGetRequest(server string, params *HistoricalPriceEodFullGetParams) (*http.Request, error)

NewHistoricalPriceEodFullGetRequest constructs an http.Request for the HistoricalPriceEodFullGet method

func NewHistoricalPriceEodLightGetRequest 

func NewHistoricalPriceEodLightGetRequest(server string, params *HistoricalPriceEodLightGetParams) (*http.Request, error)

NewHistoricalPriceEodLightGetRequest constructs an http.Request for the HistoricalPriceEodLightGet method

func NewIncomeStatementBulkGetRequest added in v0.1.29 

func NewIncomeStatementBulkGetRequest(server string, params *IncomeStatementBulkGetParams) (*http.Request, error)

NewIncomeStatementBulkGetRequest constructs an http.Request for the IncomeStatementBulkGet method

func NewIncomeStatementGetRequest 

func NewIncomeStatementGetRequest(server string, params *IncomeStatementGetParams) (*http.Request, error)

NewIncomeStatementGetRequest constructs an http.Request for the IncomeStatementGet method

func NewIncomeStatementTTMGetRequest added in v0.1.11 

func NewIncomeStatementTTMGetRequest(server string, params *IncomeStatementTTMGetParams) (*http.Request, error)

NewIncomeStatementTTMGetRequest constructs an http.Request for the IncomeStatementTTMGet method

func NewIndexConstituentListGetRequest added in v0.1.36 

func NewIndexConstituentListGetRequest(server string, params *IndexConstituentListGetParams) (*http.Request, error)

NewIndexConstituentListGetRequest constructs an http.Request for the IndexConstituentListGet method

func NewIndexListGetRequest added in v0.1.30 

func NewIndexListGetRequest(server string) (*http.Request, error)

NewIndexListGetRequest constructs an http.Request for the IndexListGet method

func NewInsiderTradingLatestGetRequest 

func NewInsiderTradingLatestGetRequest(server string, params *InsiderTradingLatestGetParams) (*http.Request, error)

NewInsiderTradingLatestGetRequest constructs an http.Request for the InsiderTradingLatestGet method

func NewInsiderTradingSearchGetRequest added in v0.1.16 

func NewInsiderTradingSearchGetRequest(server string, params *InsiderTradingSearchGetParams) (*http.Request, error)

NewInsiderTradingSearchGetRequest constructs an http.Request for the InsiderTradingSearchGet method

func NewKeyMetricsGetRequest 

func NewKeyMetricsGetRequest(server string, params *KeyMetricsGetParams) (*http.Request, error)

NewKeyMetricsGetRequest constructs an http.Request for the KeyMetricsGet method

func NewKeyMetricsTTMBulkGetRequest added in v0.1.29 

func NewKeyMetricsTTMBulkGetRequest(server string) (*http.Request, error)

NewKeyMetricsTTMBulkGetRequest constructs an http.Request for the KeyMetricsTTMBulkGet method

func NewKeyMetricsTTMGetRequest added in v0.1.11 

func NewKeyMetricsTTMGetRequest(server string, params *KeyMetricsTTMGetParams) (*http.Request, error)

NewKeyMetricsTTMGetRequest constructs an http.Request for the KeyMetricsTTMGet method

func NewMarketCapitalizationBatchGetRequest 

func NewMarketCapitalizationBatchGetRequest(server string, params *MarketCapitalizationBatchGetParams) (*http.Request, error)

NewMarketCapitalizationBatchGetRequest constructs an http.Request for the MarketCapitalizationBatchGet method

func NewMarketCapitalizationGetRequest 

func NewMarketCapitalizationGetRequest(server string, params *MarketCapitalizationGetParams) (*http.Request, error)

NewMarketCapitalizationGetRequest constructs an http.Request for the MarketCapitalizationGet method

func NewMostActivesGetRequest added in v0.1.54 

func NewMostActivesGetRequest(server string) (*http.Request, error)

NewMostActivesGetRequest constructs an http.Request for the MostActivesGet method

func NewNewsGeneralLatestGetRequest 

func NewNewsGeneralLatestGetRequest(server string, params *NewsGeneralLatestGetParams) (*http.Request, error)

NewNewsGeneralLatestGetRequest constructs an http.Request for the NewsGeneralLatestGet method

func NewNewsStockLatestGetRequest added in v0.1.25 

func NewNewsStockLatestGetRequest(server string, params *NewsStockLatestGetParams) (*http.Request, error)

NewNewsStockLatestGetRequest constructs an http.Request for the NewsStockLatestGet method

func NewProfileBulkGetRequest added in v0.1.29 

func NewProfileBulkGetRequest(server string, params *ProfileBulkGetParams) (*http.Request, error)

NewProfileBulkGetRequest constructs an http.Request for the ProfileBulkGet method

func NewProfileGetRequest 

func NewProfileGetRequest(server string, params *ProfileGetParams) (*http.Request, error)

NewProfileGetRequest constructs an http.Request for the ProfileGet method

func NewQuoteGetRequest 

func NewQuoteGetRequest(server string, params *QuoteGetParams) (*http.Request, error)

NewQuoteGetRequest constructs an http.Request for the QuoteGet method

func NewQuoteShortGetRequest 

func NewQuoteShortGetRequest(server string, params *QuoteShortGetParams) (*http.Request, error)

NewQuoteShortGetRequest constructs an http.Request for the QuoteShortGet method

func NewRatingBulkGetRequest added in v0.1.29 

func NewRatingBulkGetRequest(server string) (*http.Request, error)

NewRatingBulkGetRequest constructs an http.Request for the RatingBulkGet method

func NewRatingsSnapshotGetRequest 

func NewRatingsSnapshotGetRequest(server string, params *RatingsSnapshotGetParams) (*http.Request, error)

NewRatingsSnapshotGetRequest constructs an http.Request for the RatingsSnapshotGet method

func NewRatiosGetRequest 

func NewRatiosGetRequest(server string, params *RatiosGetParams) (*http.Request, error)

NewRatiosGetRequest constructs an http.Request for the RatiosGet method

func NewRatiosTTMBulkGetRequest added in v0.1.29 

func NewRatiosTTMBulkGetRequest(server string) (*http.Request, error)

NewRatiosTTMBulkGetRequest constructs an http.Request for the RatiosTTMBulkGet method

func NewRatiosTTMGetRequest added in v0.1.13 

func NewRatiosTTMGetRequest(server string, params *RatiosTTMGetParams) (*http.Request, error)

NewRatiosTTMGetRequest constructs an http.Request for the RatiosTTMGet method

func NewRevenueGeographicSegmentationGetRequest 

func NewRevenueGeographicSegmentationGetRequest(server string, params *RevenueGeographicSegmentationGetParams) (*http.Request, error)

NewRevenueGeographicSegmentationGetRequest constructs an http.Request for the RevenueGeographicSegmentationGet method

func NewRevenueProductSegmentationGetRequest 

func NewRevenueProductSegmentationGetRequest(server string, params *RevenueProductSegmentationGetParams) (*http.Request, error)

NewRevenueProductSegmentationGetRequest constructs an http.Request for the RevenueProductSegmentationGet method

func NewSearchNameGetRequest 

func NewSearchNameGetRequest(server string, params *SearchNameGetParams) (*http.Request, error)

NewSearchNameGetRequest constructs an http.Request for the SearchNameGet method

func NewSearchSymbolGetRequest 

func NewSearchSymbolGetRequest(server string, params *SearchSymbolGetParams) (*http.Request, error)

NewSearchSymbolGetRequest constructs an http.Request for the SearchSymbolGet method

func NewSharesFloatGetRequest 

func NewSharesFloatGetRequest(server string, params *SharesFloatGetParams) (*http.Request, error)

NewSharesFloatGetRequest constructs an http.Request for the SharesFloatGet method

func NewSplitsCalendarGetRequest added in v0.1.53 

func NewSplitsCalendarGetRequest(server string, params *SplitsCalendarGetParams) (*http.Request, error)

NewSplitsCalendarGetRequest constructs an http.Request for the SplitsCalendarGet method

func NewSplitsGetRequest added in v0.1.53 

func NewSplitsGetRequest(server string, params *SplitsGetParams) (*http.Request, error)

NewSplitsGetRequest constructs an http.Request for the SplitsGet method

func NewStockListGetRequest added in v0.1.5 

func NewStockListGetRequest(server string) (*http.Request, error)

NewStockListGetRequest constructs an http.Request for the StockListGet method

func NewTechnicalIndicatorsRsiGetRequest added in v0.1.23 

func NewTechnicalIndicatorsRsiGetRequest(server string, params *TechnicalIndicatorsRsiGetParams) (*http.Request, error)

NewTechnicalIndicatorsRsiGetRequest constructs an http.Request for the TechnicalIndicatorsRsiGet method

func NewTreasuryRatesGetRequest 

func NewTreasuryRatesGetRequest(server string, params *TreasuryRatesGetParams) (*http.Request, error)

NewTreasuryRatesGetRequest constructs an http.Request for the TreasuryRatesGet method

func PathToRawSpec 

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type AfterMarketQuote added in v0.1.45 

type AfterMarketQuote struct {
	// AskPrice Example: 310
	AskPrice float64 `json:"askPrice"`

	// AskSize Example: 1
	AskSize float64 `json:"askSize"`

	// BidPrice Example: 309.5
	BidPrice float64 `json:"bidPrice"`

	// BidSize Example: 23
	BidSize float64 `json:"bidSize"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// Timestamp Example: 1787356802000
	Timestamp int64 `json:"timestamp"`

	// Volume Example: 46876815
	Volume float64 `json:"volume"`
}

AfterMarketQuote defines model for AfterMarketQuote.

type AnalystEstimatesGetClientResponse 

type AnalystEstimatesGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]FinancialEstimates
}

func ParseAnalystEstimatesGetClientResponse 

func ParseAnalystEstimatesGetClientResponse(rsp *http.Response) (*AnalystEstimatesGetClientResponse, error)

ParseAnalystEstimatesGetClientResponse parses an HTTP response from a AnalystEstimatesGetWithResponse call

func (AnalystEstimatesGetClientResponse) ContentType added in v0.1.43 

func (r AnalystEstimatesGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AnalystEstimatesGetClientResponse) GetBody added in v0.1.43 

func (r AnalystEstimatesGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (AnalystEstimatesGetClientResponse) GetJSON200 added in v0.1.43 

func (r AnalystEstimatesGetClientResponse) GetJSON200() *[]FinancialEstimates

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (AnalystEstimatesGetClientResponse) Status 

func (r AnalystEstimatesGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (AnalystEstimatesGetClientResponse) StatusCode 

func (r AnalystEstimatesGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AnalystEstimatesGetParams 

type AnalystEstimatesGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
	Period Period `form:"period" json:"period"`
	Page   *int   `form:"page,omitempty" json:"page,omitempty"`
	Limit  *int   `form:"limit,omitempty" json:"limit,omitempty"`
}

AnalystEstimatesGetParams defines parameters for AnalystEstimatesGet.

type AvailableExchangesGetClientResponse added in v0.1.4 

type AvailableExchangesGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]Exchange
}

func ParseAvailableExchangesGetClientResponse added in v0.1.4 

func ParseAvailableExchangesGetClientResponse(rsp *http.Response) (*AvailableExchangesGetClientResponse, error)

ParseAvailableExchangesGetClientResponse parses an HTTP response from a AvailableExchangesGetWithResponse call

func (AvailableExchangesGetClientResponse) ContentType added in v0.1.43 

func (r AvailableExchangesGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AvailableExchangesGetClientResponse) GetBody added in v0.1.43 

func (r AvailableExchangesGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (AvailableExchangesGetClientResponse) GetJSON200 added in v0.1.43 

func (r AvailableExchangesGetClientResponse) GetJSON200() *[]Exchange

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (AvailableExchangesGetClientResponse) Status added in v0.1.4 

func (r AvailableExchangesGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (AvailableExchangesGetClientResponse) StatusCode added in v0.1.4 

func (r AvailableExchangesGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BalanceSheetStatement 

type BalanceSheetStatement struct {
	// AcceptedDate Example: 2024-11-01 06:01:36
	AcceptedDate string `json:"acceptedDate"`

	// AccountPayables Example: 68960000000
	AccountPayables float64 `json:"accountPayables"`

	// AccountsReceivables Example: 33410000000
	AccountsReceivables float64 `json:"accountsReceivables"`

	// AccruedExpenses Example: 0
	AccruedExpenses float64 `json:"accruedExpenses"`

	// AccumulatedOtherComprehensiveIncomeLoss Example: -7172000000
	AccumulatedOtherComprehensiveIncomeLoss float64 `json:"accumulatedOtherComprehensiveIncomeLoss"`

	// AdditionalPaidInCapital Example: 0
	AdditionalPaidInCapital float64 `json:"additionalPaidInCapital"`

	// CapitalLeaseObligations Example: 12430000000
	CapitalLeaseObligations float64 `json:"capitalLeaseObligations"`

	// CapitalLeaseObligationsCurrent Example: 1632000000
	CapitalLeaseObligationsCurrent float64 `json:"capitalLeaseObligationsCurrent"`

	// CapitalLeaseObligationsNonCurrent Example: 0
	CapitalLeaseObligationsNonCurrent float64 `json:"capitalLeaseObligationsNonCurrent"`

	// CashAndCashEquivalents Example: 29943000000
	CashAndCashEquivalents float64 `json:"cashAndCashEquivalents"`

	// CashAndShortTermInvestments Example: 65171000000
	CashAndShortTermInvestments float64 `json:"cashAndShortTermInvestments"`

	// Cik Example: 0000320193
	Cik string `json:"cik"`

	// CommonStock Example: 83276000000
	CommonStock float64 `json:"commonStock"`

	// Date Example: 2024-09-28
	Date openapi_types.Date `json:"date"`

	// DeferredRevenue Example: 8249000000
	DeferredRevenue float64 `json:"deferredRevenue"`

	// DeferredRevenueNonCurrent Example: 10798000000
	DeferredRevenueNonCurrent float64 `json:"deferredRevenueNonCurrent"`

	// DeferredTaxLiabilitiesNonCurrent Example: 0
	DeferredTaxLiabilitiesNonCurrent float64 `json:"deferredTaxLiabilitiesNonCurrent"`

	// FilingDate Example: 2024-11-01
	FilingDate openapi_types.Date `json:"filingDate"`

	// FiscalYear Example: 2024
	FiscalYear string `json:"fiscalYear"`

	// Goodwill Example: 0
	Goodwill float64 `json:"goodwill"`

	// GoodwillAndIntangibleAssets Example: 0
	GoodwillAndIntangibleAssets float64 `json:"goodwillAndIntangibleAssets"`

	// IntangibleAssets Example: 0
	IntangibleAssets float64 `json:"intangibleAssets"`

	// Inventory Example: 7286000000
	Inventory float64 `json:"inventory"`

	// LongTermDebt Example: 85750000000
	LongTermDebt float64 `json:"longTermDebt"`

	// LongTermInvestments Example: 91479000000
	LongTermInvestments float64 `json:"longTermInvestments"`

	// MinorityInterest Example: 0
	MinorityInterest float64 `json:"minorityInterest"`

	// NetDebt Example: 76686000000
	NetDebt float64 `json:"netDebt"`

	// NetReceivables Example: 66243000000
	NetReceivables float64 `json:"netReceivables"`

	// OtherAssets Example: 0
	OtherAssets float64 `json:"otherAssets"`

	// OtherCurrentAssets Example: 14287000000
	OtherCurrentAssets float64 `json:"otherCurrentAssets"`

	// OtherCurrentLiabilities Example: 50071000000
	OtherCurrentLiabilities float64 `json:"otherCurrentLiabilities"`

	// OtherLiabilities Example: 0
	OtherLiabilities float64 `json:"otherLiabilities"`

	// OtherNonCurrentAssets Example: 55335000000
	OtherNonCurrentAssets float64 `json:"otherNonCurrentAssets"`

	// OtherNonCurrentLiabilities Example: 35090000000
	OtherNonCurrentLiabilities float64 `json:"otherNonCurrentLiabilities"`

	// OtherPayables Example: 26601000000
	OtherPayables float64 `json:"otherPayables"`

	// OtherReceivables Example: 32833000000
	OtherReceivables float64 `json:"otherReceivables"`

	// OtherTotalStockholdersEquity Example: 0
	OtherTotalStockholdersEquity float64 `json:"otherTotalStockholdersEquity"`

	// Period Example: FY
	Period string `json:"period"`

	// PreferredStock Example: 0
	PreferredStock float64 `json:"preferredStock"`

	// Prepaids Example: 0
	Prepaids float64 `json:"prepaids"`

	// PropertyPlantEquipmentNet Example: 45680000000
	PropertyPlantEquipmentNet float64 `json:"propertyPlantEquipmentNet"`

	// ReportedCurrency Example: USD
	ReportedCurrency string `json:"reportedCurrency"`

	// RetainedEarnings Example: -19154000000
	RetainedEarnings float64 `json:"retainedEarnings"`

	// ShortTermDebt Example: 20879000000
	ShortTermDebt float64 `json:"shortTermDebt"`

	// ShortTermInvestments Example: 35228000000
	ShortTermInvestments float64 `json:"shortTermInvestments"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// TaxAssets Example: 19499000000
	TaxAssets float64 `json:"taxAssets"`

	// TaxPayables Example: 26601000000
	TaxPayables float64 `json:"taxPayables"`

	// TotalAssets Example: 364980000000
	TotalAssets float64 `json:"totalAssets"`

	// TotalCurrentAssets Example: 152987000000
	TotalCurrentAssets float64 `json:"totalCurrentAssets"`

	// TotalCurrentLiabilities Example: 176392000000
	TotalCurrentLiabilities float64 `json:"totalCurrentLiabilities"`

	// TotalDebt Example: 106629000000
	TotalDebt float64 `json:"totalDebt"`

	// TotalEquity Example: 56950000000
	TotalEquity float64 `json:"totalEquity"`

	// TotalInvestments Example: 126707000000
	TotalInvestments float64 `json:"totalInvestments"`

	// TotalLiabilities Example: 308030000000
	TotalLiabilities float64 `json:"totalLiabilities"`

	// TotalLiabilitiesAndTotalEquity Example: 364980000000
	TotalLiabilitiesAndTotalEquity float64 `json:"totalLiabilitiesAndTotalEquity"`

	// TotalNonCurrentAssets Example: 211993000000
	TotalNonCurrentAssets float64 `json:"totalNonCurrentAssets"`

	// TotalNonCurrentLiabilities Example: 131638000000
	TotalNonCurrentLiabilities float64 `json:"totalNonCurrentLiabilities"`

	// TotalPayables Example: 95561000000
	TotalPayables float64 `json:"totalPayables"`

	// TotalStockholdersEquity Example: 56950000000
	TotalStockholdersEquity float64 `json:"totalStockholdersEquity"`

	// TreasuryStock Example: 0
	TreasuryStock float64 `json:"treasuryStock"`
}

BalanceSheetStatement defines model for BalanceSheetStatement.

type BalanceSheetStatementBulkGetClientResponse added in v0.1.29 

type BalanceSheetStatementBulkGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseBalanceSheetStatementBulkGetClientResponse added in v0.1.29 

func ParseBalanceSheetStatementBulkGetClientResponse(rsp *http.Response) (*BalanceSheetStatementBulkGetClientResponse, error)

ParseBalanceSheetStatementBulkGetClientResponse parses an HTTP response from a BalanceSheetStatementBulkGetWithResponse call

func (BalanceSheetStatementBulkGetClientResponse) ContentType added in v0.1.43 

func (r BalanceSheetStatementBulkGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BalanceSheetStatementBulkGetClientResponse) GetBody added in v0.1.43 

func (r BalanceSheetStatementBulkGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (BalanceSheetStatementBulkGetClientResponse) Status added in v0.1.29 

func (r BalanceSheetStatementBulkGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (BalanceSheetStatementBulkGetClientResponse) StatusCode added in v0.1.29 

func (r BalanceSheetStatementBulkGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BalanceSheetStatementBulkGetParams added in v0.1.29 

type BalanceSheetStatementBulkGetParams struct {
	Period Period `form:"period" json:"period"`
	Year   int    `form:"year" json:"year"`
}

BalanceSheetStatementBulkGetParams defines parameters for BalanceSheetStatementBulkGet.

type BalanceSheetStatementGetClientResponse 

type BalanceSheetStatementGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]BalanceSheetStatement
}

func ParseBalanceSheetStatementGetClientResponse 

func ParseBalanceSheetStatementGetClientResponse(rsp *http.Response) (*BalanceSheetStatementGetClientResponse, error)

ParseBalanceSheetStatementGetClientResponse parses an HTTP response from a BalanceSheetStatementGetWithResponse call

func (BalanceSheetStatementGetClientResponse) ContentType added in v0.1.43 

func (r BalanceSheetStatementGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BalanceSheetStatementGetClientResponse) GetBody added in v0.1.43 

func (r BalanceSheetStatementGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (BalanceSheetStatementGetClientResponse) GetJSON200 added in v0.1.43 

func (r BalanceSheetStatementGetClientResponse) GetJSON200() *[]BalanceSheetStatement

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (BalanceSheetStatementGetClientResponse) Status 

func (r BalanceSheetStatementGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (BalanceSheetStatementGetClientResponse) StatusCode 

func (r BalanceSheetStatementGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BalanceSheetStatementGetParams 

type BalanceSheetStatementGetParams struct {
	Symbol string  `form:"symbol" json:"symbol"`
	Limit  *int    `form:"limit,omitempty" json:"limit,omitempty"`
	Period *Period `form:"period,omitempty" json:"period,omitempty"`
}

BalanceSheetStatementGetParams defines parameters for BalanceSheetStatementGet.

type BalanceSheetStatementTTM added in v0.1.11 

type BalanceSheetStatementTTM struct {
	// AcceptedDate Example: 2025-01-31 06:01:27
	AcceptedDate string `json:"acceptedDate"`

	// AccountPayables Example: 61910000000
	AccountPayables float64 `json:"accountPayables"`

	// AccountsReceivables Example: 29639000000
	AccountsReceivables float64 `json:"accountsReceivables"`

	// AccruedExpenses Example: 0
	AccruedExpenses float64 `json:"accruedExpenses"`

	// AccumulatedOtherComprehensiveIncomeLoss Example: -6789000000
	AccumulatedOtherComprehensiveIncomeLoss float64 `json:"accumulatedOtherComprehensiveIncomeLoss"`

	// AdditionalPaidInCapital Example: 0
	AdditionalPaidInCapital float64 `json:"additionalPaidInCapital"`

	// CapitalLeaseObligations Example: 0
	CapitalLeaseObligations float64 `json:"capitalLeaseObligations"`

	// CapitalLeaseObligationsCurrent Example: 0
	CapitalLeaseObligationsCurrent float64 `json:"capitalLeaseObligationsCurrent"`

	// CashAndCashEquivalents Example: 30299000000
	CashAndCashEquivalents float64 `json:"cashAndCashEquivalents"`

	// CashAndShortTermInvestments Example: 53775000000
	CashAndShortTermInvestments float64 `json:"cashAndShortTermInvestments"`

	// Cik Example: 0000320193
	Cik string `json:"cik"`

	// CommonStock Example: 84768000000
	CommonStock float64 `json:"commonStock"`

	// Date Example: 2024-12-28
	Date openapi_types.Date `json:"date"`

	// DeferredRevenue Example: 8461000000
	DeferredRevenue float64 `json:"deferredRevenue"`

	// DeferredRevenueNonCurrent Example: 0
	DeferredRevenueNonCurrent float64 `json:"deferredRevenueNonCurrent"`

	// DeferredTaxLiabilitiesNonCurrent Example: 0
	DeferredTaxLiabilitiesNonCurrent float32 `json:"deferredTaxLiabilitiesNonCurrent"`

	// FilingDate Example: 2025-01-31
	FilingDate openapi_types.Date `json:"filingDate"`

	// FiscalYear Example: 2025
	FiscalYear int `json:"fiscalYear"`

	// Goodwill Example: 0
	Goodwill float64 `json:"goodwill"`

	// GoodwillAndIntangibleAssets Example: 0
	GoodwillAndIntangibleAssets float64 `json:"goodwillAndIntangibleAssets"`

	// IntangibleAssets Example: 0
	IntangibleAssets float64 `json:"intangibleAssets"`

	// Inventory Example: 6911000000
	Inventory float64 `json:"inventory"`

	// LongTermDebt Example: 83956000000
	LongTermDebt float64 `json:"longTermDebt"`

	// LongTermInvestments Example: 87593000000
	LongTermInvestments float64 `json:"longTermInvestments"`

	// MinorityInterest Example: 0
	MinorityInterest float64 `json:"minorityInterest"`

	// NetDebt Example: 66500000000
	NetDebt float64 `json:"netDebt"`

	// NetReceivables Example: 59306000000
	NetReceivables float64 `json:"netReceivables"`

	// OtherAssets Example: 0
	OtherAssets float64 `json:"otherAssets"`

	// OtherCurrentAssets Example: 13248000000
	OtherCurrentAssets float64 `json:"otherCurrentAssets"`

	// OtherCurrentLiabilities Example: 61151000000
	OtherCurrentLiabilities float64 `json:"otherCurrentLiabilities"`

	// OtherLiabilities Example: 0
	OtherLiabilities float32 `json:"otherLiabilities"`

	// OtherNonCurrentAssets Example: 77183000000
	OtherNonCurrentAssets float64 `json:"otherNonCurrentAssets"`

	// OtherNonCurrentLiabilities Example: 49006000000
	OtherNonCurrentLiabilities float32 `json:"otherNonCurrentLiabilities"`

	// OtherPayables Example: 0
	OtherPayables float64 `json:"otherPayables"`

	// OtherReceivables Example: 29667000000
	OtherReceivables float64 `json:"otherReceivables"`

	// OtherTotalStockholdersEquity Example: 0
	OtherTotalStockholdersEquity float64 `json:"otherTotalStockholdersEquity"`

	// Period Example: Q1
	Period string `json:"period"`

	// PreferredStock Example: 0
	PreferredStock float64 `json:"preferredStock"`

	// Prepaids Example: 0
	Prepaids float64 `json:"prepaids"`

	// PropertyPlantEquipmentNet Example: 46069000000
	PropertyPlantEquipmentNet float64 `json:"propertyPlantEquipmentNet"`

	// ReportedCurrency Example: USD
	ReportedCurrency string `json:"reportedCurrency"`

	// RetainedEarnings Example: -11221000000
	RetainedEarnings float64 `json:"retainedEarnings"`

	// ShortTermDebt Example: 12843000000
	ShortTermDebt float32 `json:"shortTermDebt"`

	// ShortTermInvestments Example: 23476000000
	ShortTermInvestments float64 `json:"shortTermInvestments"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// TaxAssets Example: 0
	TaxAssets float64 `json:"taxAssets"`

	// TaxPayables Example: 0
	TaxPayables float64 `json:"taxPayables"`

	// TotalAssets Example: 344085000000
	TotalAssets float64 `json:"totalAssets"`

	// TotalCurrentAssets Example: 133240000000
	TotalCurrentAssets float64 `json:"totalCurrentAssets"`

	// TotalCurrentLiabilities Example: 144365000000
	TotalCurrentLiabilities float64 `json:"totalCurrentLiabilities"`

	// TotalDebt Example: 96799000000
	TotalDebt float64 `json:"totalDebt"`

	// TotalEquity Example: 66758000000
	TotalEquity float64 `json:"totalEquity"`

	// TotalInvestments Example: 111069000000
	TotalInvestments float64 `json:"totalInvestments"`

	// TotalLiabilities Example: 277327000000
	TotalLiabilities float64 `json:"totalLiabilities"`

	// TotalLiabilitiesAndTotalEquity Example: 344085000000
	TotalLiabilitiesAndTotalEquity float64 `json:"totalLiabilitiesAndTotalEquity"`

	// TotalNonCurrentAssets Example: 210845000000
	TotalNonCurrentAssets float64 `json:"totalNonCurrentAssets"`

	// TotalNonCurrentLiabilities Example: 132962000000
	TotalNonCurrentLiabilities float32 `json:"totalNonCurrentLiabilities"`

	// TotalPayables Example: 61910000000
	TotalPayables float64 `json:"totalPayables"`

	// TotalStockholdersEquity Example: 66758000000
	TotalStockholdersEquity float64 `json:"totalStockholdersEquity"`

	// TreasuryStock Example: 0
	TreasuryStock float64 `json:"treasuryStock"`
}

BalanceSheetStatementTTM defines model for BalanceSheetStatementTTM.

type BalanceSheetStatementTTMGetClientResponse added in v0.1.11 

type BalanceSheetStatementTTMGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]BalanceSheetStatementTTM
}

func ParseBalanceSheetStatementTTMGetClientResponse added in v0.1.11 

func ParseBalanceSheetStatementTTMGetClientResponse(rsp *http.Response) (*BalanceSheetStatementTTMGetClientResponse, error)

ParseBalanceSheetStatementTTMGetClientResponse parses an HTTP response from a BalanceSheetStatementTTMGetWithResponse call

func (BalanceSheetStatementTTMGetClientResponse) ContentType added in v0.1.43 

func (r BalanceSheetStatementTTMGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BalanceSheetStatementTTMGetClientResponse) GetBody added in v0.1.43 

func (r BalanceSheetStatementTTMGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (BalanceSheetStatementTTMGetClientResponse) GetJSON200 added in v0.1.43 

func (r BalanceSheetStatementTTMGetClientResponse) GetJSON200() *[]BalanceSheetStatementTTM

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (BalanceSheetStatementTTMGetClientResponse) Status added in v0.1.11 

func (r BalanceSheetStatementTTMGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (BalanceSheetStatementTTMGetClientResponse) StatusCode added in v0.1.11 

func (r BalanceSheetStatementTTMGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BalanceSheetStatementTTMGetParams added in v0.1.11 

type BalanceSheetStatementTTMGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
	Limit  *int   `form:"limit,omitempty" json:"limit,omitempty"`
}

BalanceSheetStatementTTMGetParams defines parameters for BalanceSheetStatementTTMGet.

type BatchAfterMarketQuoteGetClientResponse added in v0.1.45 

type BatchAfterMarketQuoteGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]AfterMarketQuote
}

func ParseBatchAfterMarketQuoteGetClientResponse added in v0.1.45 

func ParseBatchAfterMarketQuoteGetClientResponse(rsp *http.Response) (*BatchAfterMarketQuoteGetClientResponse, error)

ParseBatchAfterMarketQuoteGetClientResponse parses an HTTP response from a BatchAfterMarketQuoteGetWithResponse call

func (BatchAfterMarketQuoteGetClientResponse) ContentType added in v0.1.45 

func (r BatchAfterMarketQuoteGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BatchAfterMarketQuoteGetClientResponse) GetBody added in v0.1.45 

func (r BatchAfterMarketQuoteGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (BatchAfterMarketQuoteGetClientResponse) GetJSON200 added in v0.1.45 

func (r BatchAfterMarketQuoteGetClientResponse) GetJSON200() *[]AfterMarketQuote

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (BatchAfterMarketQuoteGetClientResponse) Status added in v0.1.45 

func (r BatchAfterMarketQuoteGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (BatchAfterMarketQuoteGetClientResponse) StatusCode added in v0.1.45 

func (r BatchAfterMarketQuoteGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BatchAfterMarketQuoteGetParams added in v0.1.45 

type BatchAfterMarketQuoteGetParams struct {
	Symbols string `form:"symbols" json:"symbols"`
}

BatchAfterMarketQuoteGetParams defines parameters for BatchAfterMarketQuoteGet.

type BatchIndexQuotesGetClientResponse added in v0.1.30 

type BatchIndexQuotesGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]ShortQuote
}

func ParseBatchIndexQuotesGetClientResponse added in v0.1.30 

func ParseBatchIndexQuotesGetClientResponse(rsp *http.Response) (*BatchIndexQuotesGetClientResponse, error)

ParseBatchIndexQuotesGetClientResponse parses an HTTP response from a BatchIndexQuotesGetWithResponse call

func (BatchIndexQuotesGetClientResponse) ContentType added in v0.1.43 

func (r BatchIndexQuotesGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BatchIndexQuotesGetClientResponse) GetBody added in v0.1.43 

func (r BatchIndexQuotesGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (BatchIndexQuotesGetClientResponse) GetJSON200 added in v0.1.43 

func (r BatchIndexQuotesGetClientResponse) GetJSON200() *[]ShortQuote

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (BatchIndexQuotesGetClientResponse) Status added in v0.1.30 

func (r BatchIndexQuotesGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (BatchIndexQuotesGetClientResponse) StatusCode added in v0.1.30 

func (r BatchIndexQuotesGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BatchIndexQuotesGetParams added in v0.1.30 

type BatchIndexQuotesGetParams struct {
	Short *bool `form:"short,omitempty" json:"short,omitempty"`
}

BatchIndexQuotesGetParams defines parameters for BatchIndexQuotesGet.

type BatchQuoteGetClientResponse 

type BatchQuoteGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]FullQuote
}

func ParseBatchQuoteGetClientResponse 

func ParseBatchQuoteGetClientResponse(rsp *http.Response) (*BatchQuoteGetClientResponse, error)

ParseBatchQuoteGetClientResponse parses an HTTP response from a BatchQuoteGetWithResponse call

func (BatchQuoteGetClientResponse) ContentType added in v0.1.43 

func (r BatchQuoteGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BatchQuoteGetClientResponse) GetBody added in v0.1.43 

func (r BatchQuoteGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (BatchQuoteGetClientResponse) GetJSON200 added in v0.1.43 

func (r BatchQuoteGetClientResponse) GetJSON200() *[]FullQuote

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (BatchQuoteGetClientResponse) Status 

func (r BatchQuoteGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (BatchQuoteGetClientResponse) StatusCode 

func (r BatchQuoteGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BatchQuoteGetParams 

type BatchQuoteGetParams struct {
	Symbols string `form:"symbols" json:"symbols"`
}

BatchQuoteGetParams defines parameters for BatchQuoteGet.

type BatchQuoteShortGetClientResponse 

type BatchQuoteShortGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]ShortQuote
}

func ParseBatchQuoteShortGetClientResponse 

func ParseBatchQuoteShortGetClientResponse(rsp *http.Response) (*BatchQuoteShortGetClientResponse, error)

ParseBatchQuoteShortGetClientResponse parses an HTTP response from a BatchQuoteShortGetWithResponse call

func (BatchQuoteShortGetClientResponse) ContentType added in v0.1.43 

func (r BatchQuoteShortGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BatchQuoteShortGetClientResponse) GetBody added in v0.1.43 

func (r BatchQuoteShortGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (BatchQuoteShortGetClientResponse) GetJSON200 added in v0.1.43 

func (r BatchQuoteShortGetClientResponse) GetJSON200() *[]ShortQuote

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (BatchQuoteShortGetClientResponse) Status 

func (r BatchQuoteShortGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (BatchQuoteShortGetClientResponse) StatusCode 

func (r BatchQuoteShortGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BatchQuoteShortGetParams 

type BatchQuoteShortGetParams struct {
	Symbols string `form:"symbols" json:"symbols"`
}

BatchQuoteShortGetParams defines parameters for BatchQuoteShortGet.

type BiggestGainersGetClientResponse added in v0.1.54 

type BiggestGainersGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]StockActivity
}

func ParseBiggestGainersGetClientResponse added in v0.1.54 

func ParseBiggestGainersGetClientResponse(rsp *http.Response) (*BiggestGainersGetClientResponse, error)

ParseBiggestGainersGetClientResponse parses an HTTP response from a BiggestGainersGetWithResponse call

func (BiggestGainersGetClientResponse) ContentType added in v0.1.54 

func (r BiggestGainersGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BiggestGainersGetClientResponse) GetBody added in v0.1.54 

func (r BiggestGainersGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (BiggestGainersGetClientResponse) GetJSON200 added in v0.1.54 

func (r BiggestGainersGetClientResponse) GetJSON200() *[]StockActivity

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (BiggestGainersGetClientResponse) Status added in v0.1.54 

func (r BiggestGainersGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (BiggestGainersGetClientResponse) StatusCode added in v0.1.54 

func (r BiggestGainersGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BiggestLosersGetClientResponse added in v0.1.54 

type BiggestLosersGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]StockActivity
}

func ParseBiggestLosersGetClientResponse added in v0.1.54 

func ParseBiggestLosersGetClientResponse(rsp *http.Response) (*BiggestLosersGetClientResponse, error)

ParseBiggestLosersGetClientResponse parses an HTTP response from a BiggestLosersGetWithResponse call

func (BiggestLosersGetClientResponse) ContentType added in v0.1.54 

func (r BiggestLosersGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BiggestLosersGetClientResponse) GetBody added in v0.1.54 

func (r BiggestLosersGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (BiggestLosersGetClientResponse) GetJSON200 added in v0.1.54 

func (r BiggestLosersGetClientResponse) GetJSON200() *[]StockActivity

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (BiggestLosersGetClientResponse) Status added in v0.1.54 

func (r BiggestLosersGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (BiggestLosersGetClientResponse) StatusCode added in v0.1.54 

func (r BiggestLosersGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CashFlowStatement 

type CashFlowStatement struct {
	// AcceptedDate Example: 2024-11-01 06:01:36
	AcceptedDate string `json:"acceptedDate"`

	// AccountsPayables Example: 6020000000
	AccountsPayables float64 `json:"accountsPayables"`

	// AccountsReceivables Example: -5144000000
	AccountsReceivables float64 `json:"accountsReceivables"`

	// AcquisitionsNet Example: 0
	AcquisitionsNet float64 `json:"acquisitionsNet"`

	// CapitalExpenditure Example: -9447000000
	CapitalExpenditure float64 `json:"capitalExpenditure"`

	// CashAtBeginningOfPeriod Example: 30737000000
	CashAtBeginningOfPeriod float64 `json:"cashAtBeginningOfPeriod"`

	// CashAtEndOfPeriod Example: 29943000000
	CashAtEndOfPeriod float64 `json:"cashAtEndOfPeriod"`

	// ChangeInWorkingCapital Example: 3651000000
	ChangeInWorkingCapital float64 `json:"changeInWorkingCapital"`

	// Cik Example: 0000320193
	Cik string `json:"cik"`

	// CommonDividendsPaid Example: -15234000000
	CommonDividendsPaid float64 `json:"commonDividendsPaid"`

	// CommonStockIssuance Example: 0
	CommonStockIssuance float64 `json:"commonStockIssuance"`

	// CommonStockRepurchased Example: -94949000000
	CommonStockRepurchased float64 `json:"commonStockRepurchased"`

	// Date Example: 2024-09-28
	Date openapi_types.Date `json:"date"`

	// DeferredIncomeTax Example: 0
	DeferredIncomeTax float64 `json:"deferredIncomeTax"`

	// DepreciationAndAmortization Example: 11445000000
	DepreciationAndAmortization float64 `json:"depreciationAndAmortization"`

	// EffectOfForexChangesOnCash Example: 0
	EffectOfForexChangesOnCash float64 `json:"effectOfForexChangesOnCash"`

	// FilingDate Example: 2024-11-01
	FilingDate openapi_types.Date `json:"filingDate"`

	// FiscalYear Example: 2024
	FiscalYear string `json:"fiscalYear"`

	// FreeCashFlow Example: 108807000000
	FreeCashFlow float64 `json:"freeCashFlow"`

	// IncomeTaxesPaid Example: 26102000000
	IncomeTaxesPaid float64 `json:"incomeTaxesPaid"`

	// InterestPaid Example: 0
	InterestPaid float64 `json:"interestPaid"`

	// Inventory Example: -1046000000
	Inventory float64 `json:"inventory"`

	// InvestmentsInPropertyPlantAndEquipment Example: -9447000000
	InvestmentsInPropertyPlantAndEquipment float64 `json:"investmentsInPropertyPlantAndEquipment"`

	// LongTermNetDebtIssuance Example: -9958000000
	LongTermNetDebtIssuance float64 `json:"longTermNetDebtIssuance"`

	// NetCashProvidedByFinancingActivities Example: -121983000000
	NetCashProvidedByFinancingActivities float64 `json:"netCashProvidedByFinancingActivities"`

	// NetCashProvidedByInvestingActivities Example: 2935000000
	NetCashProvidedByInvestingActivities float64 `json:"netCashProvidedByInvestingActivities"`

	// NetCashProvidedByOperatingActivities Example: 118254000000
	NetCashProvidedByOperatingActivities float64 `json:"netCashProvidedByOperatingActivities"`

	// NetChangeInCash Example: -794000000
	NetChangeInCash float64 `json:"netChangeInCash"`

	// NetCommonStockIssuance Example: -94949000000
	NetCommonStockIssuance float64 `json:"netCommonStockIssuance"`

	// NetDebtIssuance Example: -5998000000
	NetDebtIssuance float64 `json:"netDebtIssuance"`

	// NetDividendsPaid Example: -15234000000
	NetDividendsPaid float64 `json:"netDividendsPaid"`

	// NetIncome Example: 93736000000
	NetIncome float64 `json:"netIncome"`

	// NetPreferredStockIssuance Example: 0
	NetPreferredStockIssuance float64 `json:"netPreferredStockIssuance"`

	// NetStockIssuance Example: -94949000000
	NetStockIssuance float64 `json:"netStockIssuance"`

	// OperatingCashFlow Example: 118254000000
	OperatingCashFlow float64 `json:"operatingCashFlow"`

	// OtherFinancingActivities Example: -5802000000
	OtherFinancingActivities float64 `json:"otherFinancingActivities"`

	// OtherInvestingActivities Example: -1308000000
	OtherInvestingActivities float64 `json:"otherInvestingActivities"`

	// OtherNonCashItems Example: -2266000000
	OtherNonCashItems float64 `json:"otherNonCashItems"`

	// OtherWorkingCapital Example: 3821000000
	OtherWorkingCapital float64 `json:"otherWorkingCapital"`

	// Period Example: FY
	Period string `json:"period"`

	// PreferredDividendsPaid Example: 0
	PreferredDividendsPaid float64 `json:"preferredDividendsPaid"`

	// PurchasesOfInvestments Example: -48656000000
	PurchasesOfInvestments float64 `json:"purchasesOfInvestments"`

	// ReportedCurrency Example: USD
	ReportedCurrency string `json:"reportedCurrency"`

	// SalesMaturitiesOfInvestments Example: 62346000000
	SalesMaturitiesOfInvestments float64 `json:"salesMaturitiesOfInvestments"`

	// ShortTermNetDebtIssuance Example: 3960000000
	ShortTermNetDebtIssuance float64 `json:"shortTermNetDebtIssuance"`

	// StockBasedCompensation Example: 11688000000
	StockBasedCompensation float64 `json:"stockBasedCompensation"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`
}

CashFlowStatement defines model for CashFlowStatement.

type CashFlowStatementBulkGetClientResponse added in v0.1.29 

type CashFlowStatementBulkGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseCashFlowStatementBulkGetClientResponse added in v0.1.29 

func ParseCashFlowStatementBulkGetClientResponse(rsp *http.Response) (*CashFlowStatementBulkGetClientResponse, error)

ParseCashFlowStatementBulkGetClientResponse parses an HTTP response from a CashFlowStatementBulkGetWithResponse call

func (CashFlowStatementBulkGetClientResponse) ContentType added in v0.1.43 

func (r CashFlowStatementBulkGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CashFlowStatementBulkGetClientResponse) GetBody added in v0.1.43 

func (r CashFlowStatementBulkGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CashFlowStatementBulkGetClientResponse) Status added in v0.1.29 

func (r CashFlowStatementBulkGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (CashFlowStatementBulkGetClientResponse) StatusCode added in v0.1.29 

func (r CashFlowStatementBulkGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CashFlowStatementBulkGetParams added in v0.1.29 

type CashFlowStatementBulkGetParams struct {
	Period Period `form:"period" json:"period"`
	Year   int    `form:"year" json:"year"`
}

CashFlowStatementBulkGetParams defines parameters for CashFlowStatementBulkGet.

type CashFlowStatementGetClientResponse 

type CashFlowStatementGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]CashFlowStatement
}

func ParseCashFlowStatementGetClientResponse 

func ParseCashFlowStatementGetClientResponse(rsp *http.Response) (*CashFlowStatementGetClientResponse, error)

ParseCashFlowStatementGetClientResponse parses an HTTP response from a CashFlowStatementGetWithResponse call

func (CashFlowStatementGetClientResponse) ContentType added in v0.1.43 

func (r CashFlowStatementGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CashFlowStatementGetClientResponse) GetBody added in v0.1.43 

func (r CashFlowStatementGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CashFlowStatementGetClientResponse) GetJSON200 added in v0.1.43 

func (r CashFlowStatementGetClientResponse) GetJSON200() *[]CashFlowStatement

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (CashFlowStatementGetClientResponse) Status 

func (r CashFlowStatementGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (CashFlowStatementGetClientResponse) StatusCode 

func (r CashFlowStatementGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CashFlowStatementGetParams 

type CashFlowStatementGetParams struct {
	Symbol string  `form:"symbol" json:"symbol"`
	Limit  *int    `form:"limit,omitempty" json:"limit,omitempty"`
	Period *Period `form:"period,omitempty" json:"period,omitempty"`
}

CashFlowStatementGetParams defines parameters for CashFlowStatementGet.

type CashFlowStatementTTM added in v0.1.11 

type CashFlowStatementTTM struct {
	// AcceptedDate Example: 2025-01-31 06:01:27
	AcceptedDate string `json:"acceptedDate"`

	// AccountsPayables Example: 3891000000
	AccountsPayables float64 `json:"accountsPayables"`

	// AccountsReceivables Example: -9505000000
	AccountsReceivables float64 `json:"accountsReceivables"`

	// AcquisitionsNet Example: 0
	AcquisitionsNet float64 `json:"acquisitionsNet"`

	// CapitalExpenditure Example: -9995000000
	CapitalExpenditure float64 `json:"capitalExpenditure"`

	// CashAtBeginningOfPeriod Example: 41974000000
	CashAtBeginningOfPeriod float64 `json:"cashAtBeginningOfPeriod"`

	// CashAtEndOfPeriod Example: 30299000000
	CashAtEndOfPeriod float64 `json:"cashAtEndOfPeriod"`

	// ChangeInWorkingCapital Example: -8224000000
	ChangeInWorkingCapital float64 `json:"changeInWorkingCapital"`

	// Cik Example: 0000320193
	Cik string `json:"cik"`

	// CommonDividendsPaid Example: -15265000000
	CommonDividendsPaid float64 `json:"commonDividendsPaid"`

	// CommonStockIssuance Example: 0
	CommonStockIssuance float64 `json:"commonStockIssuance"`

	// CommonStockRepurchased Example: -98416000000
	CommonStockRepurchased float64 `json:"commonStockRepurchased"`

	// Date Example: 2024-12-28
	Date openapi_types.Date `json:"date"`

	// DeferredIncomeTax Example: 0
	DeferredIncomeTax float64 `json:"deferredIncomeTax"`

	// DepreciationAndAmortization Example: 11677000000
	DepreciationAndAmortization float64 `json:"depreciationAndAmortization"`

	// EffectOfForexChangesOnCash Example: 0
	EffectOfForexChangesOnCash float64 `json:"effectOfForexChangesOnCash"`

	// FilingDate Example: 2025-01-31
	FilingDate openapi_types.Date `json:"filingDate"`

	// FiscalYear Example: 2025
	FiscalYear string `json:"fiscalYear"`

	// FreeCashFlow Example: 98299000000
	FreeCashFlow float64 `json:"freeCashFlow"`

	// IncomeTaxesPaid Example: 37498000000
	IncomeTaxesPaid float64 `json:"incomeTaxesPaid"`

	// InterestPaid Example: 0
	InterestPaid float64 `json:"interestPaid"`

	// Inventory Example: -694000000
	Inventory float64 `json:"inventory"`

	// InvestmentsInPropertyPlantAndEquipment Example: -9995000000
	InvestmentsInPropertyPlantAndEquipment float64 `json:"investmentsInPropertyPlantAndEquipment"`

	// LongTermNetDebtIssuance Example: -10967000000
	LongTermNetDebtIssuance float64 `json:"longTermNetDebtIssuance"`

	// NetCashProvidedByFinancingActivities Example: -130769000000
	NetCashProvidedByFinancingActivities float64 `json:"netCashProvidedByFinancingActivities"`

	// NetCashProvidedByInvestingActivities Example: 10800000000
	NetCashProvidedByInvestingActivities float64 `json:"netCashProvidedByInvestingActivities"`

	// NetCashProvidedByOperatingActivities Example: 108294000000
	NetCashProvidedByOperatingActivities float64 `json:"netCashProvidedByOperatingActivities"`

	// NetChangeInCash Example: -11675000000
	NetChangeInCash float64 `json:"netChangeInCash"`

	// NetCommonStockIssuance Example: -98416000000
	NetCommonStockIssuance float64 `json:"netCommonStockIssuance"`

	// NetDebtIssuance Example: -10967000000
	NetDebtIssuance float64 `json:"netDebtIssuance"`

	// NetDividendsPaid Example: -15265000000
	NetDividendsPaid float64 `json:"netDividendsPaid"`

	// NetIncome Example: 96150000000
	NetIncome float64 `json:"netIncome"`

	// NetPreferredStockIssuance Example: 0
	NetPreferredStockIssuance float64 `json:"netPreferredStockIssuance"`

	// NetStockIssuance Example: -98416000000
	NetStockIssuance float64 `json:"netStockIssuance"`

	// OperatingCashFlow Example: 108294000000
	OperatingCashFlow float64 `json:"operatingCashFlow"`

	// OtherFinancingActivities Example: -6121000000
	OtherFinancingActivities float64 `json:"otherFinancingActivities"`

	// OtherInvestingActivities Example: -1627000000
	OtherInvestingActivities float64 `json:"otherInvestingActivities"`

	// OtherNonCashItems Example: -3286000000
	OtherNonCashItems float64 `json:"otherNonCashItems"`

	// OtherWorkingCapital Example: -1916000000
	OtherWorkingCapital float64 `json:"otherWorkingCapital"`

	// Period Example: Q1
	Period string `json:"period"`

	// PreferredDividendsPaid Example: 0
	PreferredDividendsPaid float64 `json:"preferredDividendsPaid"`

	// PurchasesOfInvestments Example: -45000000000
	PurchasesOfInvestments float64 `json:"purchasesOfInvestments"`

	// ReportedCurrency Example: USD
	ReportedCurrency string `json:"reportedCurrency"`

	// SalesMaturitiesOfInvestments Example: 67422000000
	SalesMaturitiesOfInvestments float64 `json:"salesMaturitiesOfInvestments"`

	// ShortTermNetDebtIssuance Example: 0
	ShortTermNetDebtIssuance float64 `json:"shortTermNetDebtIssuance"`

	// StockBasedCompensation Example: 11977000000
	StockBasedCompensation float64 `json:"stockBasedCompensation"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`
}

CashFlowStatementTTM defines model for CashFlowStatementTTM.

type CashFlowStatementTTMGetClientResponse added in v0.1.11 

type CashFlowStatementTTMGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]CashFlowStatementTTM
}

func ParseCashFlowStatementTTMGetClientResponse added in v0.1.11 

func ParseCashFlowStatementTTMGetClientResponse(rsp *http.Response) (*CashFlowStatementTTMGetClientResponse, error)

ParseCashFlowStatementTTMGetClientResponse parses an HTTP response from a CashFlowStatementTTMGetWithResponse call

func (CashFlowStatementTTMGetClientResponse) ContentType added in v0.1.43 

func (r CashFlowStatementTTMGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CashFlowStatementTTMGetClientResponse) GetBody added in v0.1.43 

func (r CashFlowStatementTTMGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CashFlowStatementTTMGetClientResponse) GetJSON200 added in v0.1.43 

func (r CashFlowStatementTTMGetClientResponse) GetJSON200() *[]CashFlowStatementTTM

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (CashFlowStatementTTMGetClientResponse) Status added in v0.1.11 

func (r CashFlowStatementTTMGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (CashFlowStatementTTMGetClientResponse) StatusCode added in v0.1.11 

func (r CashFlowStatementTTMGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CashFlowStatementTTMGetParams added in v0.1.11 

type CashFlowStatementTTMGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
	Limit  *int   `form:"limit,omitempty" json:"limit,omitempty"`
}

CashFlowStatementTTMGetParams defines parameters for CashFlowStatementTTMGet.

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) AnalystEstimatesGet 

func (c *Client) AnalystEstimatesGet(ctx context.Context, params *AnalystEstimatesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

AnalystEstimatesGet Retrieve analyst financial estimates for stock symbols with the FMP Financial Estimates API. Access projected figures like revenue, earnings per share (EPS), and other key financial metrics as forecasted by industry analysts to inform your investment decisions.

Corresponds with GET /analyst-estimates (the `AnalystEstimatesGet` operationId).

func (*Client) AvailableExchangesGet added in v0.1.4 

func (c *Client) AvailableExchangesGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

AvailableExchangesGet Access a complete list of supported stock exchanges using the FMP Available Exchanges API. This API provides a comprehensive overview of global stock exchanges, allowing users to identify where securities are traded and filter data by specific exchanges for further analysis.

Corresponds with GET /available-exchanges (the `AvailableExchangesGet` operationId).

func (*Client) BalanceSheetStatementBulkGet added in v0.1.29 

func (c *Client) BalanceSheetStatementBulkGet(ctx context.Context, params *BalanceSheetStatementBulkGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

BalanceSheetStatementBulkGet The Bulk Balance Sheet Statement API provides comprehensive access to balance sheet data across multiple companies. It enables users to analyze financial positions by retrieving key figures such as total assets, liabilities, and equity. Ideal for comparing the financial health and stability of different companies on a large scale.

Corresponds with GET /balance-sheet-statement-bulk (the `BalanceSheetStatementBulkGet` operationId).

func (*Client) BalanceSheetStatementGet 

func (c *Client) BalanceSheetStatementGet(ctx context.Context, params *BalanceSheetStatementGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

BalanceSheetStatementGet Access detailed balance sheet statements for publicly traded companies with the Balance Sheet Data API. Analyze assets, liabilities, and shareholder equity to gain insights into a company's financial health.

Corresponds with GET /balance-sheet-statement (the `BalanceSheetStatementGet` operationId).

func (*Client) BalanceSheetStatementTTMGet added in v0.1.11 

func (c *Client) BalanceSheetStatementTTMGet(ctx context.Context, params *BalanceSheetStatementTTMGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

BalanceSheetStatementTTMGet Get the trailing twelve months (TTM) balance sheet statement.

Corresponds with GET /balance-sheet-statement-ttm (the `BalanceSheetStatementTTMGet` operationId).

func (*Client) BatchAfterMarketQuoteGet added in v0.1.45 

func (c *Client) BatchAfterMarketQuoteGet(ctx context.Context, params *BatchAfterMarketQuoteGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

BatchAfterMarketQuoteGet Retrieve real-time aftermarket quotes for multiple stocks with the FMP Batch Aftermarket Quote API. Access bid and ask prices, volume, and other relevant data for several companies during post-market trading.

Corresponds with GET /batch-aftermarket-quote (the `BatchAfterMarketQuoteGet` operationId).

func (*Client) BatchIndexQuotesGet added in v0.1.30 

func (c *Client) BatchIndexQuotesGet(ctx context.Context, params *BatchIndexQuotesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

BatchIndexQuotesGet The All Index Quotes API provides real-time quotes for a wide range of stock indexes, from major market benchmarks to niche indexes. This API allows users to track market performance across multiple indexes in a single request, giving them a broad view of the financial markets.

Corresponds with GET /batch-index-quotes (the `BatchIndexQuotesGet` operationId).

func (*Client) BatchQuoteGet 

func (c *Client) BatchQuoteGet(ctx context.Context, params *BatchQuoteGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

BatchQuoteGet Access real-time stock quotes with the FMP Stock Quote API. Get up-to-the-minute prices, changes, and volume data for individual stocks.

Corresponds with GET /batch-quote (the `BatchQuoteGet` operationId).

func (*Client) BatchQuoteShortGet 

func (c *Client) BatchQuoteShortGet(ctx context.Context, params *BatchQuoteShortGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

BatchQuoteShortGet Access real-time, short-form quotes for multiple stocks with the FMP Stock Batch Quote Short API. Get a quick snapshot of key stock data such as current price, change, and volume for several companies in one streamlined request.

Corresponds with GET /batch-quote-short (the `BatchQuoteShortGet` operationId).

func (*Client) BiggestGainersGet added in v0.1.54 

func (c *Client) BiggestGainersGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

BiggestGainersGet performs a GET /biggest-gainers (the `BiggestGainersGet` operationId) request.

Track the stocks with the largest price increases using the Top Stock Gainers API. Identify the companies that are leading the market with significant price surges, offering potential growth opportunities.

func (*Client) BiggestLosersGet added in v0.1.54 

func (c *Client) BiggestLosersGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

BiggestLosersGet performs a GET /biggest-losers (the `BiggestLosersGet` operationId) request.

Access data on the stocks with the largest price drops using the Biggest Stock Losers API. Identify companies experiencing significant declines and track the stocks that are falling the fastest in the market.

func (*Client) CashFlowStatementBulkGet added in v0.1.29 

func (c *Client) CashFlowStatementBulkGet(ctx context.Context, params *CashFlowStatementBulkGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

CashFlowStatementBulkGet The Cash Flow Statement Bulk API provides access to detailed cash flow reports for a wide range of companies. This API enables users to retrieve bulk cash flow statement data, helping to analyze companies’ operating, investing, and financing activities over time.

Corresponds with GET /cash-flow-statement-bulk (the `CashFlowStatementBulkGet` operationId).

func (*Client) CashFlowStatementGet 

func (c *Client) CashFlowStatementGet(ctx context.Context, params *CashFlowStatementGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

CashFlowStatementGet Gain insights into a company's cash flow activities with the Cash Flow Statements API. Analyze cash generated and used from operations, investments, and financing activities to evaluate the financial health and sustainability of a business.

Corresponds with GET /cash-flow-statement (the `CashFlowStatementGet` operationId).

func (*Client) CashFlowStatementTTMGet added in v0.1.11 

func (c *Client) CashFlowStatementTTMGet(ctx context.Context, params *CashFlowStatementTTMGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

CashFlowStatementTTMGet Get the trailing twelve months (TTM) cash flow statement.

Corresponds with GET /cash-flow-statement-ttm (the `CashFlowStatementTTMGet` operationId).

func (*Client) CommoditiesListGet added in v0.1.42 

func (c *Client) CommoditiesListGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

CommoditiesListGet Access an extensive list of tracked commodities across various sectors, including energy, metals, and agricultural products. The FMP Commodities List API provides essential data on tradable commodities, giving investors the ability to explore market options.

Corresponds with GET /commodities-list (the `CommoditiesListGet` operationId).

func (*Client) CryptocurrencyListGet added in v0.1.55 

func (c *Client) CryptocurrencyListGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

CryptocurrencyListGet Access a comprehensive list of all cryptocurrencies traded on exchanges worldwide with the FMP Cryptocurrencies Overview API. Get detailed information on each cryptocurrency to inform your investment strategies.

Corresponds with GET /cryptocurrency-list (the `CryptocurrencyListGet` operationId).

func (*Client) DcfBulkGet added in v0.1.29 

func (c *Client) DcfBulkGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

DcfBulkGet The FMP DCF Bulk API enables users to quickly retrieve discounted cash flow (DCF) valuations for multiple symbols in one request. Access the implied price movement and percentage differences for all listed companies.

Corresponds with GET /dcf-bulk (the `DcfBulkGet` operationId).

func (*Client) DelistedCompanies added in v0.1.26 

func (c *Client) DelistedCompanies(ctx context.Context, params *DelistedCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

DelistedCompanies Stay informed with the FMP Delisted Companies API. Access a comprehensive list of companies that have been delisted from US exchanges to avoid trading in risky stocks and identify potential financial troubles.

Corresponds with GET /delisted-companies (the `DelistedCompanies` operationId).

func (*Client) DividendsCalendarGet added in v0.1.8 

func (c *Client) DividendsCalendarGet(ctx context.Context, params *DividendsCalendarGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

DividendsCalendarGet Stay informed on upcoming dividend events with the Dividend Events Calendar API. Access a comprehensive schedule of dividend-related dates for all stocks, including record dates, payment dates, declaration dates, and dividend yields.

Corresponds with GET /dividends-calendar (the `DividendsCalendarGet` operationId).

func (*Client) DividendsGet added in v0.1.8 

func (c *Client) DividendsGet(ctx context.Context, params *DividendsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

DividendsGet Stay informed on upcoming dividend events with the Dividend Events Calendar API. Access a comprehensive schedule of dividend-related dates for all stocks, including record dates, payment dates, declaration dates, and dividend yields.

Corresponds with GET /dividends (the `DividendsGet` operationId).

func (*Client) ETFCountryWeightingsGet added in v0.1.32 

func (c *Client) ETFCountryWeightingsGet(ctx context.Context, params *ETFCountryWeightingsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ETFCountryWeightingsGet Gain insight into how ETFs and mutual funds distribute assets across different countries with the FMP ETF & Fund Country Allocation API. This tool provides detailed information on the percentage of assets allocated to various regions, helping you make informed investment decisions.

Corresponds with GET /etf/country-weightings (the `ETFCountryWeightingsGet` operationId).

func (*Client) ETFHoldingsGet added in v0.1.34 

func (c *Client) ETFHoldingsGet(ctx context.Context, params *ETFHoldingsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ETFHoldingsGet Get a detailed breakdown of the assets held within ETFs and mutual funds using the FMP ETF & Fund Holdings API. Access real-time data on the specific securities and their weights in the portfolio, providing insights into asset composition and fund strategies.

Corresponds with GET /etf/holdings (the `ETFHoldingsGet` operationId).

func (*Client) ETFInfoGet added in v0.1.32 

func (c *Client) ETFInfoGet(ctx context.Context, params *ETFInfoGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ETFInfoGet Access comprehensive data on ETFs and mutual funds with the FMP ETF & Mutual Fund Information API. Retrieve essential details such as ticker symbol, fund name, expense ratio, assets under management, and more.

Corresponds with GET /etf/info (the `ETFInfoGet` operationId).

func (*Client) ETFListGet added in v0.1.32 

func (c *Client) ETFListGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

ETFListGet Quickly find ticker symbols and company names for Exchange Traded Funds (ETFs) using the FMP ETF Symbol Search API. This tool simplifies identifying specific ETFs by their name or ticker.

Corresponds with GET /etf-list (the `ETFListGet` operationId).

func (*Client) ETFSectorWeightingsGet added in v0.1.32 

func (c *Client) ETFSectorWeightingsGet(ctx context.Context, params *ETFSectorWeightingsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ETFSectorWeightingsGet performs a GET /etf/sector-weightings (the `ETFSectorWeightingsGet` operationId) request.

The FMP ETF Sector Weighting API provides a breakdown of the percentage of an ETF's assets that are invested in each sector. For example, an investor may want to invest in an ETF that has a high exposure to the technology sector if they believe that the technology sector is poised for growth.

func (*Client) EarningsCalendarGet added in v0.1.53 

func (c *Client) EarningsCalendarGet(ctx context.Context, params *EarningsCalendarGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

EarningsCalendarGet Stay informed on upcoming and past earnings announcements with the FMP Earnings Calendar API. Access key data, including announcement dates, estimated earnings per share (EPS), and actual EPS for publicly traded companies.

Corresponds with GET /earnings-calendar (the `EarningsCalendarGet` operationId).

func (*Client) EarningsGet added in v0.1.8 

func (c *Client) EarningsGet(ctx context.Context, params *EarningsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

EarningsGet Retrieve in-depth earnings information with the FMP Earnings Report API. Gain access to key financial data for a specific stock symbol, including earnings report dates, EPS estimates, and revenue projections to help you stay on top of company performance.

Corresponds with GET /earnings (the `EarningsGet` operationId).

func (*Client) EconomicCalendarGet 

func (c *Client) EconomicCalendarGet(ctx context.Context, params *EconomicCalendarGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

EconomicCalendarGet Stay informed with the FMP Economic Data Releases Calendar API. Access a comprehensive calendar of upcoming economic data releases to prepare for market impacts and make informed investment decisions.

Corresponds with GET /economic-calendar (the `EconomicCalendarGet` operationId).

func (*Client) EnterpriseValueGet added in v0.1.10 

func (c *Client) EnterpriseValueGet(ctx context.Context, params *EnterpriseValueGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

EnterpriseValueGet Access a company's enterprise value using the Enterprise Values API. This metric offers a comprehensive view of a company's total market value by combining both its equity (market capitalization) and debt, providing a better understanding of its worth.

Corresponds with GET /enterprise-values (the `EnterpriseValueGet` operationId).

func (*Client) EsgDisclosuresGet 

func (c *Client) EsgDisclosuresGet(ctx context.Context, params *EsgDisclosuresGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

EsgDisclosuresGet Align your investments with your values using the FMP ESG Investment Search API. Discover companies and funds based on Environmental, Social, and Governance (ESG) scores, performance, controversies, and business involvement criteria.

Corresponds with GET /esg-disclosures (the `EsgDisclosuresGet` operationId).

func (*Client) EsgRatingsGet 

func (c *Client) EsgRatingsGet(ctx context.Context, params *EsgRatingsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

EsgRatingsGet Access comprehensive ESG ratings for companies and funds with the FMP ESG Ratings API. Make informed investment decisions based on environmental, social, and governance (ESG) performance data.

Corresponds with GET /esg-ratings (the `EsgRatingsGet` operationId).

func (*Client) ForexCurrencyPairsGet added in v0.1.34 

func (c *Client) ForexCurrencyPairsGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

ForexCurrencyPairsGet performs a GET /forex-list (the `ForexCurrencyPairsGet` operationId) request.

Access a comprehensive list of all currency pairs traded on the forex market with the FMP Forex Currency Pairs API. Analyze and track the performance of currency pairs to make informed investment decisions.

func (*Client) GradesLatestNewsGet 

func (c *Client) GradesLatestNewsGet(ctx context.Context, params *GradesLatestNewsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GradesLatestNewsGet Stay informed on the latest stock rating changes with the FMP Grade Latest News API. This API provides the most recent updates on analyst ratings for all stock symbols, including links to the original news sources. Track stock price movements, grading firm actions, and market sentiment shifts in real time, sourced from trusted publishers.

Corresponds with GET /grades-latest-news (the `GradesLatestNewsGet` operationId).

func (*Client) HistoricalChart15MinGet added in v0.1.28 

func (c *Client) HistoricalChart15MinGet(ctx context.Context, params *HistoricalChart15MinGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

HistoricalChart15MinGet Access stock price and volume data with the FMP 15-Minute Interval Stock Chart API. Retrieve detailed stock data in 15-minute intervals, including open, high, low, close prices, and trading volume. This API is ideal for creating intraday charts and analyzing medium-term price trends during the trading day.

Corresponds with GET /historical-chart/15min (the `HistoricalChart15MinGet` operationId).

func (*Client) HistoricalPriceEodFullGet 

func (c *Client) HistoricalPriceEodFullGet(ctx context.Context, params *HistoricalPriceEodFullGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

HistoricalPriceEodFullGet Access full price and volume data for any stock symbol using the FMP Comprehensive Stock Price and Volume Data API. Get detailed insights, including open, high, low, close prices, trading volume, price changes, percentage changes, and volume-weighted average price (VWAP).

Corresponds with GET /historical-price-eod/full (the `HistoricalPriceEodFullGet` operationId).

func (*Client) HistoricalPriceEodLightGet 

func (c *Client) HistoricalPriceEodLightGet(ctx context.Context, params *HistoricalPriceEodLightGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

HistoricalPriceEodLightGet Access simplified stock chart data using the FMP Basic Stock Chart API. This API provides essential charting information, including date, price, and trading volume, making it ideal for tracking stock performance with minimal data and creating basic price and volume charts.

Corresponds with GET /historical-price-eod/light (the `HistoricalPriceEodLightGet` operationId).

func (*Client) IncomeStatementBulkGet added in v0.1.29 

func (c *Client) IncomeStatementBulkGet(ctx context.Context, params *IncomeStatementBulkGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

IncomeStatementBulkGet The Bulk Income Statement API allows users to retrieve detailed income statement data in bulk. This API is designed for large-scale data analysis, providing comprehensive insights into a company's financial performance, including revenue, gross profit, expenses, and net income.

Corresponds with GET /income-statement-bulk (the `IncomeStatementBulkGet` operationId).

func (*Client) IncomeStatementGet 

func (c *Client) IncomeStatementGet(ctx context.Context, params *IncomeStatementGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

IncomeStatementGet Access real-time income statement data for public companies, private companies, and ETFs with the FMP Real-Time Income Statements API. Track profitability, compare competitors, and identify business trends with up-to-date financial data.

Corresponds with GET /income-statement (the `IncomeStatementGet` operationId).

func (*Client) IncomeStatementTTMGet added in v0.1.11 

func (c *Client) IncomeStatementTTMGet(ctx context.Context, params *IncomeStatementTTMGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

IncomeStatementTTMGet Get the trailing twelve months (TTM) income statement.

Corresponds with GET /income-statement-ttm (the `IncomeStatementTTMGet` operationId).

func (*Client) IndexConstituentListGet added in v0.1.36 

func (c *Client) IndexConstituentListGet(ctx context.Context, params *IndexConstituentListGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

IndexConstituentListGet Retrieve a comprehensive list of stock market indexes across global exchanges using the FMP Stock Market Indexes List API. This API provides essential information such as the symbol, name, exchange, and currency for each index, helping analysts and investors keep track of various market benchmarks.

Corresponds with GET /index-constituent-list (the `IndexConstituentListGet` operationId).

func (*Client) IndexListGet added in v0.1.30 

func (c *Client) IndexListGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

IndexListGet Retrieve a comprehensive list of stock market indexes across global exchanges using the FMP Stock Market Indexes List API. This API provides essential information such as the symbol, name, exchange, and currency for each index, helping analysts and investors keep track of various market benchmarks.

Corresponds with GET /index-list (the `IndexListGet` operationId).

func (*Client) InsiderTradingLatestGet 

func (c *Client) InsiderTradingLatestGet(ctx context.Context, params *InsiderTradingLatestGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

InsiderTradingLatestGet Access the latest insider trading activity using the Latest Insider Trading API. Track which company insiders are buying or selling stocks and analyze their transactions.

Corresponds with GET /insider-trading/latest (the `InsiderTradingLatestGet` operationId).

func (*Client) InsiderTradingSearchGet added in v0.1.16 

func (c *Client) InsiderTradingSearchGet(ctx context.Context, params *InsiderTradingSearchGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

InsiderTradingSearchGet Search insider trading activity by company or symbol using the Search Insider Trades API. Find specific trades made by corporate insiders, including executives and directors.

Corresponds with GET /insider-trading/search (the `InsiderTradingSearchGet` operationId).

func (*Client) KeyMetricsGet 

func (c *Client) KeyMetricsGet(ctx context.Context, params *KeyMetricsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

KeyMetricsGet Access essential financial metrics for a company with the FMP Financial Key Metrics API. Evaluate revenue, net income, P/E ratio, and more to assess performance and compare it to competitors.

Corresponds with GET /key-metrics (the `KeyMetricsGet` operationId).

func (*Client) KeyMetricsTTMBulkGet added in v0.1.29 

func (c *Client) KeyMetricsTTMBulkGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

KeyMetricsTTMBulkGet The Key Metrics TTM Bulk API allows users to retrieve trailing twelve months (TTM) data for all companies available in the database. The API provides critical financial ratios and metrics based on each company’s latest financial report, offering insights into company performance and financial health.

Corresponds with GET /key-metrics-ttm-bulk (the `KeyMetricsTTMBulkGet` operationId).

func (*Client) KeyMetricsTTMGet added in v0.1.11 

func (c *Client) KeyMetricsTTMGet(ctx context.Context, params *KeyMetricsTTMGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

KeyMetricsTTMGet Retrieve a comprehensive set of trailing twelve-month (TTM) key performance metrics with the TTM Key Metrics API. Access data related to a company's profitability, capital efficiency, and liquidity, allowing for detailed analysis of its financial health over the past year.

Corresponds with GET /key-metrics-ttm (the `KeyMetricsTTMGet` operationId).

func (*Client) MarketCapitalizationBatchGet 

func (c *Client) MarketCapitalizationBatchGet(ctx context.Context, params *MarketCapitalizationBatchGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

MarketCapitalizationBatchGet Retrieve market capitalization data for multiple companies in a single request with the FMP Batch Market Capitalization API. This API allows users to compare the market size of various companies simultaneously, streamlining the analysis of company valuations.

Corresponds with GET /market-capitalization-batch (the `MarketCapitalizationBatchGet` operationId).

func (*Client) MarketCapitalizationGet 

func (c *Client) MarketCapitalizationGet(ctx context.Context, params *MarketCapitalizationGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

MarketCapitalizationGet Retrieve the market capitalization for a specific company on any given date using the FMP Company Market Capitalization API. This API provides essential data to assess the size and value of a company in the stock market, helping users gauge its overall market standing.

Corresponds with GET /market-capitalization (the `MarketCapitalizationGet` operationId).

func (*Client) MostActivesGet added in v0.1.54 

func (c *Client) MostActivesGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

MostActivesGet performs a GET /most-actives (the `MostActivesGet` operationId) request.

View the most actively traded stocks using the Top Traded Stocks API. Identify the companies experiencing the highest trading volumes in the market and track where the most trading activity is happening.

func (*Client) NewsGeneralLatestGet 

func (c *Client) NewsGeneralLatestGet(ctx context.Context, params *NewsGeneralLatestGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

NewsGeneralLatestGet Access the latest general news articles from a variety of sources with the FMP General News API. Obtain headlines, snippets, and publication URLs for comprehensive news coverage.

Corresponds with GET /news/general-latest (the `NewsGeneralLatestGet` operationId).

func (*Client) NewsStockLatestGet added in v0.1.25 

func (c *Client) NewsStockLatestGet(ctx context.Context, params *NewsStockLatestGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

NewsStockLatestGet Stay informed with the latest stock market news using the FMP Stock News Feed API. Access headlines, snippets, publication URLs, and ticker symbols for the most recent articles from a variety of sources.

Corresponds with GET /news/stock-latest (the `NewsStockLatestGet` operationId).

func (*Client) ProfileBulkGet added in v0.1.29 

func (c *Client) ProfileBulkGet(ctx context.Context, params *ProfileBulkGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ProfileBulkGet The FMP Profile Bulk API allows users to retrieve comprehensive company profile data in bulk. Access essential information, such as company details, stock price, market cap, sector, industry, and more for multiple companies in a single request.

Corresponds with GET /profile-bulk (the `ProfileBulkGet` operationId).

func (*Client) ProfileGet 

func (c *Client) ProfileGet(ctx context.Context, params *ProfileGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ProfileGet Access detailed company profile data with the FMP Company Profile Data API. This API provides key financial and operational information for a specific stock symbol, including the company's market capitalization, stock price, industry, and much more.

Corresponds with GET /profile (the `ProfileGet` operationId).

func (*Client) QuoteGet 

func (c *Client) QuoteGet(ctx context.Context, params *QuoteGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

QuoteGet Access real-time stock quotes with the FMP Stock Quote API. Get up-to-the-minute prices, changes, and volume data for individual stocks.

Corresponds with GET /quote (the `QuoteGet` operationId).

func (*Client) QuoteShortGet 

func (c *Client) QuoteShortGet(ctx context.Context, params *QuoteShortGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

QuoteShortGet Get quick snapshots of real-time stock quotes with the FMP Stock Quote Short API. Access key stock data like current price, volume, and price changes for instant market insights.

Corresponds with GET /quote-short (the `QuoteShortGet` operationId).

func (*Client) RatingBulkGet added in v0.1.29 

func (c *Client) RatingBulkGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

RatingBulkGet The FMP Rating Bulk API provides users with comprehensive rating data for multiple stocks in a single request. Retrieve key financial ratings and recommendations such as overall ratings, DCF recommendations, and more for multiple companies at once.

Corresponds with GET /rating-bulk (the `RatingBulkGet` operationId).

func (*Client) RatingsSnapshotGet 

func (c *Client) RatingsSnapshotGet(ctx context.Context, params *RatingsSnapshotGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

RatingsSnapshotGet Quickly assess the financial health and performance of companies with the FMP Ratings Snapshot API. This API provides a comprehensive snapshot of financial ratings for stock symbols in our database, based on various key financial ratios.

Corresponds with GET /ratings-snapshot (the `RatingsSnapshotGet` operationId).

func (*Client) RatiosGet 

func (c *Client) RatiosGet(ctx context.Context, params *RatiosGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

RatiosGet Analyze a company's financial performance using the Financial Ratios API. This API provides detailed profitability, liquidity, and efficiency ratios, enabling users to assess a company's operational and financial health across various metrics.

Corresponds with GET /ratios (the `RatiosGet` operationId).

func (*Client) RatiosTTMBulkGet added in v0.1.29 

func (c *Client) RatiosTTMBulkGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

RatiosTTMBulkGet The Ratios TTM Bulk API offers an efficient way to retrieve trailing twelve months (TTM) financial ratios for stocks. It provides users with detailed insights into a company’s profitability, liquidity, efficiency, leverage, and valuation ratios, all based on the most recent financial report.

Corresponds with GET /ratios-ttm-bulk (the `RatiosTTMBulkGet` operationId).

func (*Client) RatiosTTMGet added in v0.1.13 

func (c *Client) RatiosTTMGet(ctx context.Context, params *RatiosTTMGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

RatiosTTMGet Gain access to trailing twelve-month (TTM) financial ratios with the TTM Ratios API. This API provides key performance metrics over the past year, including profitability, liquidity, and efficiency ratios.

Corresponds with GET /ratios-ttm (the `RatiosTTMGet` operationId).

func (*Client) RevenueGeographicSegmentationGet 

func (c *Client) RevenueGeographicSegmentationGet(ctx context.Context, params *RevenueGeographicSegmentationGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

RevenueGeographicSegmentationGet Access detailed revenue breakdowns by geographic region with the Revenue Geographic Segments API. Analyze how different regions contribute to a company's total revenue and identify key markets for growth.

Corresponds with GET /revenue-geographic-segmentation (the `RevenueGeographicSegmentationGet` operationId).

func (*Client) RevenueProductSegmentationGet 

func (c *Client) RevenueProductSegmentationGet(ctx context.Context, params *RevenueProductSegmentationGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

RevenueProductSegmentationGet Access detailed revenue breakdowns by product line with the Revenue Product Segmentation API. Understand which products drive a company's earnings and get insights into the performance of individual product segments.

Corresponds with GET /revenue-product-segmentation (the `RevenueProductSegmentationGet` operationId).

func (*Client) SearchNameGet 

func (c *Client) SearchNameGet(ctx context.Context, params *SearchNameGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchNameGet Search for ticker symbols, company names, and exchange details for equity securities and ETFs listed on various exchanges with the FMP Name Search API. This endpoint is useful for retrieving ticker symbols when you know the full or partial company or asset name but not the symbol identifier.

Corresponds with GET /search-name (the `SearchNameGet` operationId).

func (*Client) SearchSymbolGet 

func (c *Client) SearchSymbolGet(ctx context.Context, params *SearchSymbolGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchSymbolGet Easily find the ticker symbol of any stock with the FMP Stock Symbol Search API. Search by company name or symbol across multiple global markets.

Corresponds with GET /search-symbol (the `SearchSymbolGet` operationId).

func (*Client) SharesFloatGet 

func (c *Client) SharesFloatGet(ctx context.Context, params *SharesFloatGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

SharesFloatGet Understand the liquidity and volatility of a stock with the FMP Company Share Float and Liquidity API. Access the total number of publicly traded shares for any company to make informed investment decisions.

Corresponds with GET /shares-float (the `SharesFloatGet` operationId).

func (*Client) SplitsCalendarGet added in v0.1.53 

func (c *Client) SplitsCalendarGet(ctx context.Context, params *SplitsCalendarGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

SplitsCalendarGet Stay informed about upcoming stock splits with the FMP Stock Splits Calendar API. This API provides essential data on upcoming stock splits across multiple companies, including the split date and ratio, helping you track changes in share structures before they occur.

Corresponds with GET /splits-calendar (the `SplitsCalendarGet` operationId).

func (*Client) SplitsGet added in v0.1.53 

func (c *Client) SplitsGet(ctx context.Context, params *SplitsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

SplitsGet Access detailed information on stock splits for a specific company using the FMP Stock Split Details API. This API provides essential data, including the split date and the split ratio, helping users understand changes in a company's share structure after a stock split.

Corresponds with GET /splits (the `SplitsGet` operationId).

func (*Client) StockListGet added in v0.1.5 

func (c *Client) StockListGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

StockListGet Easily retrieve a comprehensive list of financial symbols with the FMP Company Symbols List API. Access a broad range of stock symbols and other tradable financial instruments from various global exchanges, helping you explore the full range of available securities.

Corresponds with GET /stock-list (the `StockListGet` operationId).

func (*Client) TechnicalIndicatorsRsiGet added in v0.1.23 

func (c *Client) TechnicalIndicatorsRsiGet(ctx context.Context, params *TechnicalIndicatorsRsiGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

TechnicalIndicatorsRsiGet Get the Relative Strength Index(RSI) technical indicator for a given symbol and time period.

Corresponds with GET /technical-indicators/rsi (the `TechnicalIndicatorsRsiGet` operationId).

func (*Client) TreasuryRatesGet 

func (c *Client) TreasuryRatesGet(ctx context.Context, params *TreasuryRatesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

TreasuryRatesGet Access real-time and historical Treasury rates for all maturities with the FMP Treasury Rates API. Track key benchmarks for interest rates across the economy.

Corresponds with GET /treasury-rates (the `TreasuryRatesGet` operationId).

type ClientConfig added in v0.1.1 

type ClientConfig struct {
	APIKey string

	Endpoint string

	Debug bool
}

type ClientInterface 

type ClientInterface interface {

	// AnalystEstimatesGet Retrieve analyst financial estimates for stock symbols with the FMP Financial Estimates API. Access projected figures like revenue, earnings per share (EPS), and other key financial metrics as forecasted by industry analysts to inform your investment decisions.
	//
	// Corresponds with GET /analyst-estimates (the `AnalystEstimatesGet` operationId).
	AnalystEstimatesGet(ctx context.Context, params *AnalystEstimatesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AvailableExchangesGet Access a complete list of supported stock exchanges using the FMP Available Exchanges API. This API provides a comprehensive overview of global stock exchanges, allowing users to identify where securities are traded and filter data by specific exchanges for further analysis.
	//
	// Corresponds with GET /available-exchanges (the `AvailableExchangesGet` operationId).
	AvailableExchangesGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BalanceSheetStatementGet Access detailed balance sheet statements for publicly traded companies with the Balance Sheet Data API. Analyze assets, liabilities, and shareholder equity to gain insights into a company's financial health.
	//
	// Corresponds with GET /balance-sheet-statement (the `BalanceSheetStatementGet` operationId).
	BalanceSheetStatementGet(ctx context.Context, params *BalanceSheetStatementGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BalanceSheetStatementBulkGet The Bulk Balance Sheet Statement API provides comprehensive access to balance sheet data across multiple companies. It enables users to analyze financial positions by retrieving key figures such as total assets, liabilities, and equity. Ideal for comparing the financial health and stability of different companies on a large scale.
	//
	// Corresponds with GET /balance-sheet-statement-bulk (the `BalanceSheetStatementBulkGet` operationId).
	BalanceSheetStatementBulkGet(ctx context.Context, params *BalanceSheetStatementBulkGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BalanceSheetStatementTTMGet Get the trailing twelve months (TTM) balance sheet statement.
	//
	// Corresponds with GET /balance-sheet-statement-ttm (the `BalanceSheetStatementTTMGet` operationId).
	BalanceSheetStatementTTMGet(ctx context.Context, params *BalanceSheetStatementTTMGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BatchAfterMarketQuoteGet Retrieve real-time aftermarket quotes for multiple stocks with the FMP Batch Aftermarket Quote API. Access bid and ask prices, volume, and other relevant data for several companies during post-market trading.
	//
	// Corresponds with GET /batch-aftermarket-quote (the `BatchAfterMarketQuoteGet` operationId).
	BatchAfterMarketQuoteGet(ctx context.Context, params *BatchAfterMarketQuoteGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BatchIndexQuotesGet The All Index Quotes API provides real-time quotes for a wide range of stock indexes, from major market benchmarks to niche indexes. This API allows users to track market performance across multiple indexes in a single request, giving them a broad view of the financial markets.
	//
	// Corresponds with GET /batch-index-quotes (the `BatchIndexQuotesGet` operationId).
	BatchIndexQuotesGet(ctx context.Context, params *BatchIndexQuotesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BatchQuoteGet Access real-time stock quotes with the FMP Stock Quote API. Get up-to-the-minute prices, changes, and volume data for individual stocks.
	//
	// Corresponds with GET /batch-quote (the `BatchQuoteGet` operationId).
	BatchQuoteGet(ctx context.Context, params *BatchQuoteGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BatchQuoteShortGet Access real-time, short-form quotes for multiple stocks with the FMP Stock Batch Quote Short API. Get a quick snapshot of key stock data such as current price, change, and volume for several companies in one streamlined request.
	//
	// Corresponds with GET /batch-quote-short (the `BatchQuoteShortGet` operationId).
	BatchQuoteShortGet(ctx context.Context, params *BatchQuoteShortGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BiggestGainersGet performs a GET /biggest-gainers (the `BiggestGainersGet` operationId) request.
	//
	// Track the stocks with the largest price increases using the Top Stock Gainers API. Identify the companies that are leading the market with significant price surges, offering potential growth opportunities.
	BiggestGainersGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BiggestLosersGet performs a GET /biggest-losers (the `BiggestLosersGet` operationId) request.
	//
	// Access data on the stocks with the largest price drops using the Biggest Stock Losers API. Identify companies experiencing significant declines and track the stocks that are falling the fastest in the market.
	BiggestLosersGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CashFlowStatementGet Gain insights into a company's cash flow activities with the Cash Flow Statements API. Analyze cash generated and used from operations, investments, and financing activities to evaluate the financial health and sustainability of a business.
	//
	// Corresponds with GET /cash-flow-statement (the `CashFlowStatementGet` operationId).
	CashFlowStatementGet(ctx context.Context, params *CashFlowStatementGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CashFlowStatementBulkGet The Cash Flow Statement Bulk API provides access to detailed cash flow reports for a wide range of companies. This API enables users to retrieve bulk cash flow statement data, helping to analyze companies’ operating, investing, and financing activities over time.
	//
	// Corresponds with GET /cash-flow-statement-bulk (the `CashFlowStatementBulkGet` operationId).
	CashFlowStatementBulkGet(ctx context.Context, params *CashFlowStatementBulkGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CashFlowStatementTTMGet Get the trailing twelve months (TTM) cash flow statement.
	//
	// Corresponds with GET /cash-flow-statement-ttm (the `CashFlowStatementTTMGet` operationId).
	CashFlowStatementTTMGet(ctx context.Context, params *CashFlowStatementTTMGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CommoditiesListGet Access an extensive list of tracked commodities across various sectors, including energy, metals, and agricultural products. The FMP Commodities List API provides essential data on tradable commodities, giving investors the ability to explore market options.
	//
	// Corresponds with GET /commodities-list (the `CommoditiesListGet` operationId).
	CommoditiesListGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CryptocurrencyListGet Access a comprehensive list of all cryptocurrencies traded on exchanges worldwide with the FMP Cryptocurrencies Overview API. Get detailed information on each cryptocurrency to inform your investment strategies.
	//
	// Corresponds with GET /cryptocurrency-list (the `CryptocurrencyListGet` operationId).
	CryptocurrencyListGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DcfBulkGet The FMP DCF Bulk API enables users to quickly retrieve discounted cash flow (DCF) valuations for multiple symbols in one request. Access the implied price movement and percentage differences for all listed companies.
	//
	// Corresponds with GET /dcf-bulk (the `DcfBulkGet` operationId).
	DcfBulkGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DelistedCompanies Stay informed with the FMP Delisted Companies API. Access a comprehensive list of companies that have been delisted from US exchanges to avoid trading in risky stocks and identify potential financial troubles.
	//
	// Corresponds with GET /delisted-companies (the `DelistedCompanies` operationId).
	DelistedCompanies(ctx context.Context, params *DelistedCompaniesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DividendsGet Stay informed on upcoming dividend events with the Dividend Events Calendar API. Access a comprehensive schedule of dividend-related dates for all stocks, including record dates, payment dates, declaration dates, and dividend yields.
	//
	// Corresponds with GET /dividends (the `DividendsGet` operationId).
	DividendsGet(ctx context.Context, params *DividendsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DividendsCalendarGet Stay informed on upcoming dividend events with the Dividend Events Calendar API. Access a comprehensive schedule of dividend-related dates for all stocks, including record dates, payment dates, declaration dates, and dividend yields.
	//
	// Corresponds with GET /dividends-calendar (the `DividendsCalendarGet` operationId).
	DividendsCalendarGet(ctx context.Context, params *DividendsCalendarGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EarningsGet Retrieve in-depth earnings information with the FMP Earnings Report API. Gain access to key financial data for a specific stock symbol, including earnings report dates, EPS estimates, and revenue projections to help you stay on top of company performance.
	//
	// Corresponds with GET /earnings (the `EarningsGet` operationId).
	EarningsGet(ctx context.Context, params *EarningsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EarningsCalendarGet Stay informed on upcoming and past earnings announcements with the FMP Earnings Calendar API. Access key data, including announcement dates, estimated earnings per share (EPS), and actual EPS for publicly traded companies.
	//
	// Corresponds with GET /earnings-calendar (the `EarningsCalendarGet` operationId).
	EarningsCalendarGet(ctx context.Context, params *EarningsCalendarGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EconomicCalendarGet Stay informed with the FMP Economic Data Releases Calendar API. Access a comprehensive calendar of upcoming economic data releases to prepare for market impacts and make informed investment decisions.
	//
	// Corresponds with GET /economic-calendar (the `EconomicCalendarGet` operationId).
	EconomicCalendarGet(ctx context.Context, params *EconomicCalendarGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EnterpriseValueGet Access a company's enterprise value using the Enterprise Values API. This metric offers a comprehensive view of a company's total market value by combining both its equity (market capitalization) and debt, providing a better understanding of its worth.
	//
	// Corresponds with GET /enterprise-values (the `EnterpriseValueGet` operationId).
	EnterpriseValueGet(ctx context.Context, params *EnterpriseValueGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EsgDisclosuresGet Align your investments with your values using the FMP ESG Investment Search API. Discover companies and funds based on Environmental, Social, and Governance (ESG) scores, performance, controversies, and business involvement criteria.
	//
	// Corresponds with GET /esg-disclosures (the `EsgDisclosuresGet` operationId).
	EsgDisclosuresGet(ctx context.Context, params *EsgDisclosuresGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EsgRatingsGet Access comprehensive ESG ratings for companies and funds with the FMP ESG Ratings API. Make informed investment decisions based on environmental, social, and governance (ESG) performance data.
	//
	// Corresponds with GET /esg-ratings (the `EsgRatingsGet` operationId).
	EsgRatingsGet(ctx context.Context, params *EsgRatingsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ETFListGet Quickly find ticker symbols and company names for Exchange Traded Funds (ETFs) using the FMP ETF Symbol Search API. This tool simplifies identifying specific ETFs by their name or ticker.
	//
	// Corresponds with GET /etf-list (the `ETFListGet` operationId).
	ETFListGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ETFCountryWeightingsGet Gain insight into how ETFs and mutual funds distribute assets across different countries with the FMP ETF & Fund Country Allocation API. This tool provides detailed information on the percentage of assets allocated to various regions, helping you make informed investment decisions.
	//
	// Corresponds with GET /etf/country-weightings (the `ETFCountryWeightingsGet` operationId).
	ETFCountryWeightingsGet(ctx context.Context, params *ETFCountryWeightingsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ETFHoldingsGet Get a detailed breakdown of the assets held within ETFs and mutual funds using the FMP ETF & Fund Holdings API. Access real-time data on the specific securities and their weights in the portfolio, providing insights into asset composition and fund strategies.
	//
	// Corresponds with GET /etf/holdings (the `ETFHoldingsGet` operationId).
	ETFHoldingsGet(ctx context.Context, params *ETFHoldingsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ETFInfoGet Access comprehensive data on ETFs and mutual funds with the FMP ETF & Mutual Fund Information API. Retrieve essential details such as ticker symbol, fund name, expense ratio, assets under management, and more.
	//
	// Corresponds with GET /etf/info (the `ETFInfoGet` operationId).
	ETFInfoGet(ctx context.Context, params *ETFInfoGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ETFSectorWeightingsGet performs a GET /etf/sector-weightings (the `ETFSectorWeightingsGet` operationId) request.
	//
	// The FMP ETF Sector Weighting API provides a breakdown of the percentage of an ETF's assets that are invested in each sector. For example, an investor may want to invest in an ETF that has a high exposure to the technology sector if they believe that the technology sector is poised for growth.
	ETFSectorWeightingsGet(ctx context.Context, params *ETFSectorWeightingsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ForexCurrencyPairsGet performs a GET /forex-list (the `ForexCurrencyPairsGet` operationId) request.
	//
	// Access a comprehensive list of all currency pairs traded on the forex market with the FMP Forex Currency Pairs API. Analyze and track the performance of currency pairs to make informed investment decisions.
	ForexCurrencyPairsGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GradesLatestNewsGet Stay informed on the latest stock rating changes with the FMP Grade Latest News API. This API provides the most recent updates on analyst ratings for all stock symbols, including links to the original news sources. Track stock price movements, grading firm actions, and market sentiment shifts in real time, sourced from trusted publishers.
	//
	// Corresponds with GET /grades-latest-news (the `GradesLatestNewsGet` operationId).
	GradesLatestNewsGet(ctx context.Context, params *GradesLatestNewsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// HistoricalChart15MinGet Access stock price and volume data with the FMP 15-Minute Interval Stock Chart API. Retrieve detailed stock data in 15-minute intervals, including open, high, low, close prices, and trading volume. This API is ideal for creating intraday charts and analyzing medium-term price trends during the trading day.
	//
	// Corresponds with GET /historical-chart/15min (the `HistoricalChart15MinGet` operationId).
	HistoricalChart15MinGet(ctx context.Context, params *HistoricalChart15MinGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// HistoricalPriceEodFullGet Access full price and volume data for any stock symbol using the FMP Comprehensive Stock Price and Volume Data API. Get detailed insights, including open, high, low, close prices, trading volume, price changes, percentage changes, and volume-weighted average price (VWAP).
	//
	// Corresponds with GET /historical-price-eod/full (the `HistoricalPriceEodFullGet` operationId).
	HistoricalPriceEodFullGet(ctx context.Context, params *HistoricalPriceEodFullGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// HistoricalPriceEodLightGet Access simplified stock chart data using the FMP Basic Stock Chart API. This API provides essential charting information, including date, price, and trading volume, making it ideal for tracking stock performance with minimal data and creating basic price and volume charts.
	//
	// Corresponds with GET /historical-price-eod/light (the `HistoricalPriceEodLightGet` operationId).
	HistoricalPriceEodLightGet(ctx context.Context, params *HistoricalPriceEodLightGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// IncomeStatementGet Access real-time income statement data for public companies, private companies, and ETFs with the FMP Real-Time Income Statements API. Track profitability, compare competitors, and identify business trends with up-to-date financial data.
	//
	// Corresponds with GET /income-statement (the `IncomeStatementGet` operationId).
	IncomeStatementGet(ctx context.Context, params *IncomeStatementGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// IncomeStatementBulkGet The Bulk Income Statement API allows users to retrieve detailed income statement data in bulk. This API is designed for large-scale data analysis, providing comprehensive insights into a company's financial performance, including revenue, gross profit, expenses, and net income.
	//
	// Corresponds with GET /income-statement-bulk (the `IncomeStatementBulkGet` operationId).
	IncomeStatementBulkGet(ctx context.Context, params *IncomeStatementBulkGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// IncomeStatementTTMGet Get the trailing twelve months (TTM) income statement.
	//
	// Corresponds with GET /income-statement-ttm (the `IncomeStatementTTMGet` operationId).
	IncomeStatementTTMGet(ctx context.Context, params *IncomeStatementTTMGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// IndexConstituentListGet Retrieve a comprehensive list of stock market indexes across global exchanges using the FMP Stock Market Indexes List API. This API provides essential information such as the symbol, name, exchange, and currency for each index, helping analysts and investors keep track of various market benchmarks.
	//
	// Corresponds with GET /index-constituent-list (the `IndexConstituentListGet` operationId).
	IndexConstituentListGet(ctx context.Context, params *IndexConstituentListGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// IndexListGet Retrieve a comprehensive list of stock market indexes across global exchanges using the FMP Stock Market Indexes List API. This API provides essential information such as the symbol, name, exchange, and currency for each index, helping analysts and investors keep track of various market benchmarks.
	//
	// Corresponds with GET /index-list (the `IndexListGet` operationId).
	IndexListGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InsiderTradingLatestGet Access the latest insider trading activity using the Latest Insider Trading API. Track which company insiders are buying or selling stocks and analyze their transactions.
	//
	// Corresponds with GET /insider-trading/latest (the `InsiderTradingLatestGet` operationId).
	InsiderTradingLatestGet(ctx context.Context, params *InsiderTradingLatestGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InsiderTradingSearchGet Search insider trading activity by company or symbol using the Search Insider Trades API. Find specific trades made by corporate insiders, including executives and directors.
	//
	// Corresponds with GET /insider-trading/search (the `InsiderTradingSearchGet` operationId).
	InsiderTradingSearchGet(ctx context.Context, params *InsiderTradingSearchGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// KeyMetricsGet Access essential financial metrics for a company with the FMP Financial Key Metrics API. Evaluate revenue, net income, P/E ratio, and more to assess performance and compare it to competitors.
	//
	// Corresponds with GET /key-metrics (the `KeyMetricsGet` operationId).
	KeyMetricsGet(ctx context.Context, params *KeyMetricsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// KeyMetricsTTMGet Retrieve a comprehensive set of trailing twelve-month (TTM) key performance metrics with the TTM Key Metrics API. Access data related to a company's profitability, capital efficiency, and liquidity, allowing for detailed analysis of its financial health over the past year.
	//
	// Corresponds with GET /key-metrics-ttm (the `KeyMetricsTTMGet` operationId).
	KeyMetricsTTMGet(ctx context.Context, params *KeyMetricsTTMGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// KeyMetricsTTMBulkGet The Key Metrics TTM Bulk API allows users to retrieve trailing twelve months (TTM) data for all companies available in the database. The API provides critical financial ratios and metrics based on each company’s latest financial report, offering insights into company performance and financial health.
	//
	// Corresponds with GET /key-metrics-ttm-bulk (the `KeyMetricsTTMBulkGet` operationId).
	KeyMetricsTTMBulkGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MarketCapitalizationGet Retrieve the market capitalization for a specific company on any given date using the FMP Company Market Capitalization API. This API provides essential data to assess the size and value of a company in the stock market, helping users gauge its overall market standing.
	//
	// Corresponds with GET /market-capitalization (the `MarketCapitalizationGet` operationId).
	MarketCapitalizationGet(ctx context.Context, params *MarketCapitalizationGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MarketCapitalizationBatchGet Retrieve market capitalization data for multiple companies in a single request with the FMP Batch Market Capitalization API. This API allows users to compare the market size of various companies simultaneously, streamlining the analysis of company valuations.
	//
	// Corresponds with GET /market-capitalization-batch (the `MarketCapitalizationBatchGet` operationId).
	MarketCapitalizationBatchGet(ctx context.Context, params *MarketCapitalizationBatchGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MostActivesGet performs a GET /most-actives (the `MostActivesGet` operationId) request.
	//
	// View the most actively traded stocks using the Top Traded Stocks API. Identify the companies experiencing the highest trading volumes in the market and track where the most trading activity is happening.
	MostActivesGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// NewsGeneralLatestGet Access the latest general news articles from a variety of sources with the FMP General News API. Obtain headlines, snippets, and publication URLs for comprehensive news coverage.
	//
	// Corresponds with GET /news/general-latest (the `NewsGeneralLatestGet` operationId).
	NewsGeneralLatestGet(ctx context.Context, params *NewsGeneralLatestGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// NewsStockLatestGet Stay informed with the latest stock market news using the FMP Stock News Feed API. Access headlines, snippets, publication URLs, and ticker symbols for the most recent articles from a variety of sources.
	//
	// Corresponds with GET /news/stock-latest (the `NewsStockLatestGet` operationId).
	NewsStockLatestGet(ctx context.Context, params *NewsStockLatestGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ProfileGet Access detailed company profile data with the FMP Company Profile Data API. This API provides key financial and operational information for a specific stock symbol, including the company's market capitalization, stock price, industry, and much more.
	//
	// Corresponds with GET /profile (the `ProfileGet` operationId).
	ProfileGet(ctx context.Context, params *ProfileGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ProfileBulkGet The FMP Profile Bulk API allows users to retrieve comprehensive company profile data in bulk. Access essential information, such as company details, stock price, market cap, sector, industry, and more for multiple companies in a single request.
	//
	// Corresponds with GET /profile-bulk (the `ProfileBulkGet` operationId).
	ProfileBulkGet(ctx context.Context, params *ProfileBulkGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// QuoteGet Access real-time stock quotes with the FMP Stock Quote API. Get up-to-the-minute prices, changes, and volume data for individual stocks.
	//
	// Corresponds with GET /quote (the `QuoteGet` operationId).
	QuoteGet(ctx context.Context, params *QuoteGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// QuoteShortGet Get quick snapshots of real-time stock quotes with the FMP Stock Quote Short API. Access key stock data like current price, volume, and price changes for instant market insights.
	//
	// Corresponds with GET /quote-short (the `QuoteShortGet` operationId).
	QuoteShortGet(ctx context.Context, params *QuoteShortGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RatingBulkGet The FMP Rating Bulk API provides users with comprehensive rating data for multiple stocks in a single request. Retrieve key financial ratings and recommendations such as overall ratings, DCF recommendations, and more for multiple companies at once.
	//
	// Corresponds with GET /rating-bulk (the `RatingBulkGet` operationId).
	RatingBulkGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RatingsSnapshotGet Quickly assess the financial health and performance of companies with the FMP Ratings Snapshot API. This API provides a comprehensive snapshot of financial ratings for stock symbols in our database, based on various key financial ratios.
	//
	// Corresponds with GET /ratings-snapshot (the `RatingsSnapshotGet` operationId).
	RatingsSnapshotGet(ctx context.Context, params *RatingsSnapshotGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RatiosGet Analyze a company's financial performance using the Financial Ratios API. This API provides detailed profitability, liquidity, and efficiency ratios, enabling users to assess a company's operational and financial health across various metrics.
	//
	// Corresponds with GET /ratios (the `RatiosGet` operationId).
	RatiosGet(ctx context.Context, params *RatiosGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RatiosTTMGet Gain access to trailing twelve-month (TTM) financial ratios with the TTM Ratios API. This API provides key performance metrics over the past year, including profitability, liquidity, and efficiency ratios.
	//
	// Corresponds with GET /ratios-ttm (the `RatiosTTMGet` operationId).
	RatiosTTMGet(ctx context.Context, params *RatiosTTMGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RatiosTTMBulkGet The Ratios TTM Bulk API offers an efficient way to retrieve trailing twelve months (TTM) financial ratios for stocks. It provides users with detailed insights into a company’s profitability, liquidity, efficiency, leverage, and valuation ratios, all based on the most recent financial report.
	//
	// Corresponds with GET /ratios-ttm-bulk (the `RatiosTTMBulkGet` operationId).
	RatiosTTMBulkGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RevenueGeographicSegmentationGet Access detailed revenue breakdowns by geographic region with the Revenue Geographic Segments API. Analyze how different regions contribute to a company's total revenue and identify key markets for growth.
	//
	// Corresponds with GET /revenue-geographic-segmentation (the `RevenueGeographicSegmentationGet` operationId).
	RevenueGeographicSegmentationGet(ctx context.Context, params *RevenueGeographicSegmentationGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RevenueProductSegmentationGet Access detailed revenue breakdowns by product line with the Revenue Product Segmentation API. Understand which products drive a company's earnings and get insights into the performance of individual product segments.
	//
	// Corresponds with GET /revenue-product-segmentation (the `RevenueProductSegmentationGet` operationId).
	RevenueProductSegmentationGet(ctx context.Context, params *RevenueProductSegmentationGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchNameGet Search for ticker symbols, company names, and exchange details for equity securities and ETFs listed on various exchanges with the FMP Name Search API. This endpoint is useful for retrieving ticker symbols when you know the full or partial company or asset name but not the symbol identifier.
	//
	// Corresponds with GET /search-name (the `SearchNameGet` operationId).
	SearchNameGet(ctx context.Context, params *SearchNameGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchSymbolGet Easily find the ticker symbol of any stock with the FMP Stock Symbol Search API. Search by company name or symbol across multiple global markets.
	//
	// Corresponds with GET /search-symbol (the `SearchSymbolGet` operationId).
	SearchSymbolGet(ctx context.Context, params *SearchSymbolGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SharesFloatGet Understand the liquidity and volatility of a stock with the FMP Company Share Float and Liquidity API. Access the total number of publicly traded shares for any company to make informed investment decisions.
	//
	// Corresponds with GET /shares-float (the `SharesFloatGet` operationId).
	SharesFloatGet(ctx context.Context, params *SharesFloatGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SplitsGet Access detailed information on stock splits for a specific company using the FMP Stock Split Details API. This API provides essential data, including the split date and the split ratio, helping users understand changes in a company's share structure after a stock split.
	//
	// Corresponds with GET /splits (the `SplitsGet` operationId).
	SplitsGet(ctx context.Context, params *SplitsGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SplitsCalendarGet Stay informed about upcoming stock splits with the FMP Stock Splits Calendar API. This API provides essential data on upcoming stock splits across multiple companies, including the split date and ratio, helping you track changes in share structures before they occur.
	//
	// Corresponds with GET /splits-calendar (the `SplitsCalendarGet` operationId).
	SplitsCalendarGet(ctx context.Context, params *SplitsCalendarGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// StockListGet Easily retrieve a comprehensive list of financial symbols with the FMP Company Symbols List API. Access a broad range of stock symbols and other tradable financial instruments from various global exchanges, helping you explore the full range of available securities.
	//
	// Corresponds with GET /stock-list (the `StockListGet` operationId).
	StockListGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TechnicalIndicatorsRsiGet Get the Relative Strength Index(RSI) technical indicator for a given symbol and time period.
	//
	// Corresponds with GET /technical-indicators/rsi (the `TechnicalIndicatorsRsiGet` operationId).
	TechnicalIndicatorsRsiGet(ctx context.Context, params *TechnicalIndicatorsRsiGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TreasuryRatesGet Access real-time and historical Treasury rates for all maturities with the FMP Treasury Rates API. Track key benchmarks for interest rates across the economy.
	//
	// Corresponds with GET /treasury-rates (the `TreasuryRatesGet` operationId).
	TreasuryRatesGet(ctx context.Context, params *TreasuryRatesGetParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func MustClient 

func MustClient(cfg *ClientConfig) *ClientWithResponses

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) AnalystEstimatesGetWithResponse 

func (c *ClientWithResponses) AnalystEstimatesGetWithResponse(ctx context.Context, params *AnalystEstimatesGetParams, reqEditors ...RequestEditorFn) (*AnalystEstimatesGetClientResponse, error)

AnalystEstimatesGetWithResponse Retrieve analyst financial estimates for stock symbols with the FMP Financial Estimates API. Access projected figures like revenue, earnings per share (EPS), and other key financial metrics as forecasted by industry analysts to inform your investment decisions.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /analyst-estimates (the `AnalystEstimatesGet` operationId).

func (*ClientWithResponses) AvailableExchangesGetWithResponse added in v0.1.4 

func (c *ClientWithResponses) AvailableExchangesGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*AvailableExchangesGetClientResponse, error)

AvailableExchangesGetWithResponse Access a complete list of supported stock exchanges using the FMP Available Exchanges API. This API provides a comprehensive overview of global stock exchanges, allowing users to identify where securities are traded and filter data by specific exchanges for further analysis.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /available-exchanges (the `AvailableExchangesGet` operationId).

func (*ClientWithResponses) BalanceSheetStatementBulkGetWithResponse added in v0.1.29 

func (c *ClientWithResponses) BalanceSheetStatementBulkGetWithResponse(ctx context.Context, params *BalanceSheetStatementBulkGetParams, reqEditors ...RequestEditorFn) (*BalanceSheetStatementBulkGetClientResponse, error)

BalanceSheetStatementBulkGetWithResponse The Bulk Balance Sheet Statement API provides comprehensive access to balance sheet data across multiple companies. It enables users to analyze financial positions by retrieving key figures such as total assets, liabilities, and equity. Ideal for comparing the financial health and stability of different companies on a large scale.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /balance-sheet-statement-bulk (the `BalanceSheetStatementBulkGet` operationId).

func (*ClientWithResponses) BalanceSheetStatementGetWithResponse 

func (c *ClientWithResponses) BalanceSheetStatementGetWithResponse(ctx context.Context, params *BalanceSheetStatementGetParams, reqEditors ...RequestEditorFn) (*BalanceSheetStatementGetClientResponse, error)

BalanceSheetStatementGetWithResponse Access detailed balance sheet statements for publicly traded companies with the Balance Sheet Data API. Analyze assets, liabilities, and shareholder equity to gain insights into a company's financial health.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /balance-sheet-statement (the `BalanceSheetStatementGet` operationId).

func (*ClientWithResponses) BalanceSheetStatementTTMGetWithResponse added in v0.1.11 

func (c *ClientWithResponses) BalanceSheetStatementTTMGetWithResponse(ctx context.Context, params *BalanceSheetStatementTTMGetParams, reqEditors ...RequestEditorFn) (*BalanceSheetStatementTTMGetClientResponse, error)

BalanceSheetStatementTTMGetWithResponse Get the trailing twelve months (TTM) balance sheet statement.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /balance-sheet-statement-ttm (the `BalanceSheetStatementTTMGet` operationId).

func (*ClientWithResponses) BatchAfterMarketQuoteGetWithResponse added in v0.1.45 

func (c *ClientWithResponses) BatchAfterMarketQuoteGetWithResponse(ctx context.Context, params *BatchAfterMarketQuoteGetParams, reqEditors ...RequestEditorFn) (*BatchAfterMarketQuoteGetClientResponse, error)

BatchAfterMarketQuoteGetWithResponse Retrieve real-time aftermarket quotes for multiple stocks with the FMP Batch Aftermarket Quote API. Access bid and ask prices, volume, and other relevant data for several companies during post-market trading.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /batch-aftermarket-quote (the `BatchAfterMarketQuoteGet` operationId).

func (*ClientWithResponses) BatchIndexQuotesGetWithResponse added in v0.1.30 

func (c *ClientWithResponses) BatchIndexQuotesGetWithResponse(ctx context.Context, params *BatchIndexQuotesGetParams, reqEditors ...RequestEditorFn) (*BatchIndexQuotesGetClientResponse, error)

BatchIndexQuotesGetWithResponse The All Index Quotes API provides real-time quotes for a wide range of stock indexes, from major market benchmarks to niche indexes. This API allows users to track market performance across multiple indexes in a single request, giving them a broad view of the financial markets.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /batch-index-quotes (the `BatchIndexQuotesGet` operationId).

func (*ClientWithResponses) BatchQuoteGetWithResponse 

func (c *ClientWithResponses) BatchQuoteGetWithResponse(ctx context.Context, params *BatchQuoteGetParams, reqEditors ...RequestEditorFn) (*BatchQuoteGetClientResponse, error)

BatchQuoteGetWithResponse Access real-time stock quotes with the FMP Stock Quote API. Get up-to-the-minute prices, changes, and volume data for individual stocks.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /batch-quote (the `BatchQuoteGet` operationId).

func (*ClientWithResponses) BatchQuoteShortGetWithResponse 

func (c *ClientWithResponses) BatchQuoteShortGetWithResponse(ctx context.Context, params *BatchQuoteShortGetParams, reqEditors ...RequestEditorFn) (*BatchQuoteShortGetClientResponse, error)

BatchQuoteShortGetWithResponse Access real-time, short-form quotes for multiple stocks with the FMP Stock Batch Quote Short API. Get a quick snapshot of key stock data such as current price, change, and volume for several companies in one streamlined request.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /batch-quote-short (the `BatchQuoteShortGet` operationId).

func (*ClientWithResponses) BiggestGainersGetWithResponse added in v0.1.54 

func (c *ClientWithResponses) BiggestGainersGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*BiggestGainersGetClientResponse, error)

BiggestGainersGetWithResponse performs a GET /biggest-gainers (the `BiggestGainersGet` operationId) request.

Track the stocks with the largest price increases using the Top Stock Gainers API. Identify the companies that are leading the market with significant price surges, offering potential growth opportunities.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) BiggestLosersGetWithResponse added in v0.1.54 

func (c *ClientWithResponses) BiggestLosersGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*BiggestLosersGetClientResponse, error)

BiggestLosersGetWithResponse performs a GET /biggest-losers (the `BiggestLosersGet` operationId) request.

Access data on the stocks with the largest price drops using the Biggest Stock Losers API. Identify companies experiencing significant declines and track the stocks that are falling the fastest in the market.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) CashFlowStatementBulkGetWithResponse added in v0.1.29 

func (c *ClientWithResponses) CashFlowStatementBulkGetWithResponse(ctx context.Context, params *CashFlowStatementBulkGetParams, reqEditors ...RequestEditorFn) (*CashFlowStatementBulkGetClientResponse, error)

CashFlowStatementBulkGetWithResponse The Cash Flow Statement Bulk API provides access to detailed cash flow reports for a wide range of companies. This API enables users to retrieve bulk cash flow statement data, helping to analyze companies’ operating, investing, and financing activities over time.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /cash-flow-statement-bulk (the `CashFlowStatementBulkGet` operationId).

func (*ClientWithResponses) CashFlowStatementGetWithResponse 

func (c *ClientWithResponses) CashFlowStatementGetWithResponse(ctx context.Context, params *CashFlowStatementGetParams, reqEditors ...RequestEditorFn) (*CashFlowStatementGetClientResponse, error)

CashFlowStatementGetWithResponse Gain insights into a company's cash flow activities with the Cash Flow Statements API. Analyze cash generated and used from operations, investments, and financing activities to evaluate the financial health and sustainability of a business.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /cash-flow-statement (the `CashFlowStatementGet` operationId).

func (*ClientWithResponses) CashFlowStatementTTMGetWithResponse added in v0.1.11 

func (c *ClientWithResponses) CashFlowStatementTTMGetWithResponse(ctx context.Context, params *CashFlowStatementTTMGetParams, reqEditors ...RequestEditorFn) (*CashFlowStatementTTMGetClientResponse, error)

CashFlowStatementTTMGetWithResponse Get the trailing twelve months (TTM) cash flow statement.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /cash-flow-statement-ttm (the `CashFlowStatementTTMGet` operationId).

func (*ClientWithResponses) CommoditiesListGetWithResponse added in v0.1.42 

func (c *ClientWithResponses) CommoditiesListGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*CommoditiesListGetClientResponse, error)

CommoditiesListGetWithResponse Access an extensive list of tracked commodities across various sectors, including energy, metals, and agricultural products. The FMP Commodities List API provides essential data on tradable commodities, giving investors the ability to explore market options.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /commodities-list (the `CommoditiesListGet` operationId).

func (*ClientWithResponses) CryptocurrencyListGetWithResponse added in v0.1.55 

func (c *ClientWithResponses) CryptocurrencyListGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*CryptocurrencyListGetClientResponse, error)

CryptocurrencyListGetWithResponse Access a comprehensive list of all cryptocurrencies traded on exchanges worldwide with the FMP Cryptocurrencies Overview API. Get detailed information on each cryptocurrency to inform your investment strategies.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /cryptocurrency-list (the `CryptocurrencyListGet` operationId).

func (*ClientWithResponses) DcfBulkGetWithResponse added in v0.1.29 

func (c *ClientWithResponses) DcfBulkGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*DcfBulkGetClientResponse, error)

DcfBulkGetWithResponse The FMP DCF Bulk API enables users to quickly retrieve discounted cash flow (DCF) valuations for multiple symbols in one request. Access the implied price movement and percentage differences for all listed companies.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /dcf-bulk (the `DcfBulkGet` operationId).

func (*ClientWithResponses) DelistedCompaniesWithResponse added in v0.1.26 

func (c *ClientWithResponses) DelistedCompaniesWithResponse(ctx context.Context, params *DelistedCompaniesParams, reqEditors ...RequestEditorFn) (*DelistedCompaniesClientResponse, error)

DelistedCompaniesWithResponse Stay informed with the FMP Delisted Companies API. Access a comprehensive list of companies that have been delisted from US exchanges to avoid trading in risky stocks and identify potential financial troubles.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /delisted-companies (the `DelistedCompanies` operationId).

func (*ClientWithResponses) DividendsCalendarGetWithResponse added in v0.1.8 

func (c *ClientWithResponses) DividendsCalendarGetWithResponse(ctx context.Context, params *DividendsCalendarGetParams, reqEditors ...RequestEditorFn) (*DividendsCalendarGetClientResponse, error)

DividendsCalendarGetWithResponse Stay informed on upcoming dividend events with the Dividend Events Calendar API. Access a comprehensive schedule of dividend-related dates for all stocks, including record dates, payment dates, declaration dates, and dividend yields.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /dividends-calendar (the `DividendsCalendarGet` operationId).

func (*ClientWithResponses) DividendsGetWithResponse added in v0.1.8 

func (c *ClientWithResponses) DividendsGetWithResponse(ctx context.Context, params *DividendsGetParams, reqEditors ...RequestEditorFn) (*DividendsGetClientResponse, error)

DividendsGetWithResponse Stay informed on upcoming dividend events with the Dividend Events Calendar API. Access a comprehensive schedule of dividend-related dates for all stocks, including record dates, payment dates, declaration dates, and dividend yields.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /dividends (the `DividendsGet` operationId).

func (*ClientWithResponses) ETFCountryWeightingsGetWithResponse added in v0.1.32 

func (c *ClientWithResponses) ETFCountryWeightingsGetWithResponse(ctx context.Context, params *ETFCountryWeightingsGetParams, reqEditors ...RequestEditorFn) (*ETFCountryWeightingsGetClientResponse, error)

ETFCountryWeightingsGetWithResponse Gain insight into how ETFs and mutual funds distribute assets across different countries with the FMP ETF & Fund Country Allocation API. This tool provides detailed information on the percentage of assets allocated to various regions, helping you make informed investment decisions.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /etf/country-weightings (the `ETFCountryWeightingsGet` operationId).

func (*ClientWithResponses) ETFHoldingsGetWithResponse added in v0.1.34 

func (c *ClientWithResponses) ETFHoldingsGetWithResponse(ctx context.Context, params *ETFHoldingsGetParams, reqEditors ...RequestEditorFn) (*ETFHoldingsGetClientResponse, error)

ETFHoldingsGetWithResponse Get a detailed breakdown of the assets held within ETFs and mutual funds using the FMP ETF & Fund Holdings API. Access real-time data on the specific securities and their weights in the portfolio, providing insights into asset composition and fund strategies.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /etf/holdings (the `ETFHoldingsGet` operationId).

func (*ClientWithResponses) ETFInfoGetWithResponse added in v0.1.32 

func (c *ClientWithResponses) ETFInfoGetWithResponse(ctx context.Context, params *ETFInfoGetParams, reqEditors ...RequestEditorFn) (*ETFInfoGetClientResponse, error)

ETFInfoGetWithResponse Access comprehensive data on ETFs and mutual funds with the FMP ETF & Mutual Fund Information API. Retrieve essential details such as ticker symbol, fund name, expense ratio, assets under management, and more.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /etf/info (the `ETFInfoGet` operationId).

func (*ClientWithResponses) ETFListGetWithResponse added in v0.1.32 

func (c *ClientWithResponses) ETFListGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ETFListGetClientResponse, error)

ETFListGetWithResponse Quickly find ticker symbols and company names for Exchange Traded Funds (ETFs) using the FMP ETF Symbol Search API. This tool simplifies identifying specific ETFs by their name or ticker.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /etf-list (the `ETFListGet` operationId).

func (*ClientWithResponses) ETFSectorWeightingsGetWithResponse added in v0.1.32 

func (c *ClientWithResponses) ETFSectorWeightingsGetWithResponse(ctx context.Context, params *ETFSectorWeightingsGetParams, reqEditors ...RequestEditorFn) (*ETFSectorWeightingsGetClientResponse, error)

ETFSectorWeightingsGetWithResponse performs a GET /etf/sector-weightings (the `ETFSectorWeightingsGet` operationId) request.

The FMP ETF Sector Weighting API provides a breakdown of the percentage of an ETF's assets that are invested in each sector. For example, an investor may want to invest in an ETF that has a high exposure to the technology sector if they believe that the technology sector is poised for growth.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) EarningsCalendarGetWithResponse added in v0.1.53 

func (c *ClientWithResponses) EarningsCalendarGetWithResponse(ctx context.Context, params *EarningsCalendarGetParams, reqEditors ...RequestEditorFn) (*EarningsCalendarGetClientResponse, error)

EarningsCalendarGetWithResponse Stay informed on upcoming and past earnings announcements with the FMP Earnings Calendar API. Access key data, including announcement dates, estimated earnings per share (EPS), and actual EPS for publicly traded companies.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /earnings-calendar (the `EarningsCalendarGet` operationId).

func (*ClientWithResponses) EarningsGetWithResponse added in v0.1.8 

func (c *ClientWithResponses) EarningsGetWithResponse(ctx context.Context, params *EarningsGetParams, reqEditors ...RequestEditorFn) (*EarningsGetClientResponse, error)

EarningsGetWithResponse Retrieve in-depth earnings information with the FMP Earnings Report API. Gain access to key financial data for a specific stock symbol, including earnings report dates, EPS estimates, and revenue projections to help you stay on top of company performance.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /earnings (the `EarningsGet` operationId).

func (*ClientWithResponses) EconomicCalendarGetWithResponse 

func (c *ClientWithResponses) EconomicCalendarGetWithResponse(ctx context.Context, params *EconomicCalendarGetParams, reqEditors ...RequestEditorFn) (*EconomicCalendarGetClientResponse, error)

EconomicCalendarGetWithResponse Stay informed with the FMP Economic Data Releases Calendar API. Access a comprehensive calendar of upcoming economic data releases to prepare for market impacts and make informed investment decisions.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /economic-calendar (the `EconomicCalendarGet` operationId).

func (*ClientWithResponses) EnterpriseValueGetWithResponse added in v0.1.10 

func (c *ClientWithResponses) EnterpriseValueGetWithResponse(ctx context.Context, params *EnterpriseValueGetParams, reqEditors ...RequestEditorFn) (*EnterpriseValueGetClientResponse, error)

EnterpriseValueGetWithResponse Access a company's enterprise value using the Enterprise Values API. This metric offers a comprehensive view of a company's total market value by combining both its equity (market capitalization) and debt, providing a better understanding of its worth.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /enterprise-values (the `EnterpriseValueGet` operationId).

func (*ClientWithResponses) EsgDisclosuresGetWithResponse 

func (c *ClientWithResponses) EsgDisclosuresGetWithResponse(ctx context.Context, params *EsgDisclosuresGetParams, reqEditors ...RequestEditorFn) (*EsgDisclosuresGetClientResponse, error)

EsgDisclosuresGetWithResponse Align your investments with your values using the FMP ESG Investment Search API. Discover companies and funds based on Environmental, Social, and Governance (ESG) scores, performance, controversies, and business involvement criteria.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /esg-disclosures (the `EsgDisclosuresGet` operationId).

func (*ClientWithResponses) EsgRatingsGetWithResponse 

func (c *ClientWithResponses) EsgRatingsGetWithResponse(ctx context.Context, params *EsgRatingsGetParams, reqEditors ...RequestEditorFn) (*EsgRatingsGetClientResponse, error)

EsgRatingsGetWithResponse Access comprehensive ESG ratings for companies and funds with the FMP ESG Ratings API. Make informed investment decisions based on environmental, social, and governance (ESG) performance data.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /esg-ratings (the `EsgRatingsGet` operationId).

func (*ClientWithResponses) ForexCurrencyPairsGetWithResponse added in v0.1.34 

func (c *ClientWithResponses) ForexCurrencyPairsGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ForexCurrencyPairsGetClientResponse, error)

ForexCurrencyPairsGetWithResponse performs a GET /forex-list (the `ForexCurrencyPairsGet` operationId) request.

Access a comprehensive list of all currency pairs traded on the forex market with the FMP Forex Currency Pairs API. Analyze and track the performance of currency pairs to make informed investment decisions.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) GradesLatestNewsGetWithResponse 

func (c *ClientWithResponses) GradesLatestNewsGetWithResponse(ctx context.Context, params *GradesLatestNewsGetParams, reqEditors ...RequestEditorFn) (*GradesLatestNewsGetClientResponse, error)

GradesLatestNewsGetWithResponse Stay informed on the latest stock rating changes with the FMP Grade Latest News API. This API provides the most recent updates on analyst ratings for all stock symbols, including links to the original news sources. Track stock price movements, grading firm actions, and market sentiment shifts in real time, sourced from trusted publishers.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /grades-latest-news (the `GradesLatestNewsGet` operationId).

func (*ClientWithResponses) HistoricalChart15MinGetWithResponse added in v0.1.28 

func (c *ClientWithResponses) HistoricalChart15MinGetWithResponse(ctx context.Context, params *HistoricalChart15MinGetParams, reqEditors ...RequestEditorFn) (*HistoricalChart15MinGetClientResponse, error)

HistoricalChart15MinGetWithResponse Access stock price and volume data with the FMP 15-Minute Interval Stock Chart API. Retrieve detailed stock data in 15-minute intervals, including open, high, low, close prices, and trading volume. This API is ideal for creating intraday charts and analyzing medium-term price trends during the trading day.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /historical-chart/15min (the `HistoricalChart15MinGet` operationId).

func (*ClientWithResponses) HistoricalPriceEodFullGetWithResponse 

func (c *ClientWithResponses) HistoricalPriceEodFullGetWithResponse(ctx context.Context, params *HistoricalPriceEodFullGetParams, reqEditors ...RequestEditorFn) (*HistoricalPriceEodFullGetClientResponse, error)

HistoricalPriceEodFullGetWithResponse Access full price and volume data for any stock symbol using the FMP Comprehensive Stock Price and Volume Data API. Get detailed insights, including open, high, low, close prices, trading volume, price changes, percentage changes, and volume-weighted average price (VWAP).

Returns a wrapper object for the known response body format(s).

Corresponds with GET /historical-price-eod/full (the `HistoricalPriceEodFullGet` operationId).

func (*ClientWithResponses) HistoricalPriceEodLightGetWithResponse 

func (c *ClientWithResponses) HistoricalPriceEodLightGetWithResponse(ctx context.Context, params *HistoricalPriceEodLightGetParams, reqEditors ...RequestEditorFn) (*HistoricalPriceEodLightGetClientResponse, error)

HistoricalPriceEodLightGetWithResponse Access simplified stock chart data using the FMP Basic Stock Chart API. This API provides essential charting information, including date, price, and trading volume, making it ideal for tracking stock performance with minimal data and creating basic price and volume charts.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /historical-price-eod/light (the `HistoricalPriceEodLightGet` operationId).

func (*ClientWithResponses) IncomeStatementBulkGetWithResponse added in v0.1.29 

func (c *ClientWithResponses) IncomeStatementBulkGetWithResponse(ctx context.Context, params *IncomeStatementBulkGetParams, reqEditors ...RequestEditorFn) (*IncomeStatementBulkGetClientResponse, error)

IncomeStatementBulkGetWithResponse The Bulk Income Statement API allows users to retrieve detailed income statement data in bulk. This API is designed for large-scale data analysis, providing comprehensive insights into a company's financial performance, including revenue, gross profit, expenses, and net income.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /income-statement-bulk (the `IncomeStatementBulkGet` operationId).

func (*ClientWithResponses) IncomeStatementGetWithResponse 

func (c *ClientWithResponses) IncomeStatementGetWithResponse(ctx context.Context, params *IncomeStatementGetParams, reqEditors ...RequestEditorFn) (*IncomeStatementGetClientResponse, error)

IncomeStatementGetWithResponse Access real-time income statement data for public companies, private companies, and ETFs with the FMP Real-Time Income Statements API. Track profitability, compare competitors, and identify business trends with up-to-date financial data.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /income-statement (the `IncomeStatementGet` operationId).

func (*ClientWithResponses) IncomeStatementTTMGetWithResponse added in v0.1.11 

func (c *ClientWithResponses) IncomeStatementTTMGetWithResponse(ctx context.Context, params *IncomeStatementTTMGetParams, reqEditors ...RequestEditorFn) (*IncomeStatementTTMGetClientResponse, error)

IncomeStatementTTMGetWithResponse Get the trailing twelve months (TTM) income statement.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /income-statement-ttm (the `IncomeStatementTTMGet` operationId).

func (*ClientWithResponses) IndexConstituentListGetWithResponse added in v0.1.36 

func (c *ClientWithResponses) IndexConstituentListGetWithResponse(ctx context.Context, params *IndexConstituentListGetParams, reqEditors ...RequestEditorFn) (*IndexConstituentListGetClientResponse, error)

IndexConstituentListGetWithResponse Retrieve a comprehensive list of stock market indexes across global exchanges using the FMP Stock Market Indexes List API. This API provides essential information such as the symbol, name, exchange, and currency for each index, helping analysts and investors keep track of various market benchmarks.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /index-constituent-list (the `IndexConstituentListGet` operationId).

func (*ClientWithResponses) IndexListGetWithResponse added in v0.1.30 

func (c *ClientWithResponses) IndexListGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*IndexListGetClientResponse, error)

IndexListGetWithResponse Retrieve a comprehensive list of stock market indexes across global exchanges using the FMP Stock Market Indexes List API. This API provides essential information such as the symbol, name, exchange, and currency for each index, helping analysts and investors keep track of various market benchmarks.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /index-list (the `IndexListGet` operationId).

func (*ClientWithResponses) InsiderTradingLatestGetWithResponse 

func (c *ClientWithResponses) InsiderTradingLatestGetWithResponse(ctx context.Context, params *InsiderTradingLatestGetParams, reqEditors ...RequestEditorFn) (*InsiderTradingLatestGetClientResponse, error)

InsiderTradingLatestGetWithResponse Access the latest insider trading activity using the Latest Insider Trading API. Track which company insiders are buying or selling stocks and analyze their transactions.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /insider-trading/latest (the `InsiderTradingLatestGet` operationId).

func (*ClientWithResponses) InsiderTradingSearchGetWithResponse added in v0.1.16 

func (c *ClientWithResponses) InsiderTradingSearchGetWithResponse(ctx context.Context, params *InsiderTradingSearchGetParams, reqEditors ...RequestEditorFn) (*InsiderTradingSearchGetClientResponse, error)

InsiderTradingSearchGetWithResponse Search insider trading activity by company or symbol using the Search Insider Trades API. Find specific trades made by corporate insiders, including executives and directors.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /insider-trading/search (the `InsiderTradingSearchGet` operationId).

func (*ClientWithResponses) KeyMetricsGetWithResponse 

func (c *ClientWithResponses) KeyMetricsGetWithResponse(ctx context.Context, params *KeyMetricsGetParams, reqEditors ...RequestEditorFn) (*KeyMetricsGetClientResponse, error)

KeyMetricsGetWithResponse Access essential financial metrics for a company with the FMP Financial Key Metrics API. Evaluate revenue, net income, P/E ratio, and more to assess performance and compare it to competitors.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /key-metrics (the `KeyMetricsGet` operationId).

func (*ClientWithResponses) KeyMetricsTTMBulkGetWithResponse added in v0.1.29 

func (c *ClientWithResponses) KeyMetricsTTMBulkGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*KeyMetricsTTMBulkGetClientResponse, error)

KeyMetricsTTMBulkGetWithResponse The Key Metrics TTM Bulk API allows users to retrieve trailing twelve months (TTM) data for all companies available in the database. The API provides critical financial ratios and metrics based on each company’s latest financial report, offering insights into company performance and financial health.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /key-metrics-ttm-bulk (the `KeyMetricsTTMBulkGet` operationId).

func (*ClientWithResponses) KeyMetricsTTMGetWithResponse added in v0.1.11 

func (c *ClientWithResponses) KeyMetricsTTMGetWithResponse(ctx context.Context, params *KeyMetricsTTMGetParams, reqEditors ...RequestEditorFn) (*KeyMetricsTTMGetClientResponse, error)

KeyMetricsTTMGetWithResponse Retrieve a comprehensive set of trailing twelve-month (TTM) key performance metrics with the TTM Key Metrics API. Access data related to a company's profitability, capital efficiency, and liquidity, allowing for detailed analysis of its financial health over the past year.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /key-metrics-ttm (the `KeyMetricsTTMGet` operationId).

func (*ClientWithResponses) MarketCapitalizationBatchGetWithResponse 

func (c *ClientWithResponses) MarketCapitalizationBatchGetWithResponse(ctx context.Context, params *MarketCapitalizationBatchGetParams, reqEditors ...RequestEditorFn) (*MarketCapitalizationBatchGetClientResponse, error)

MarketCapitalizationBatchGetWithResponse Retrieve market capitalization data for multiple companies in a single request with the FMP Batch Market Capitalization API. This API allows users to compare the market size of various companies simultaneously, streamlining the analysis of company valuations.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /market-capitalization-batch (the `MarketCapitalizationBatchGet` operationId).

func (*ClientWithResponses) MarketCapitalizationGetWithResponse 

func (c *ClientWithResponses) MarketCapitalizationGetWithResponse(ctx context.Context, params *MarketCapitalizationGetParams, reqEditors ...RequestEditorFn) (*MarketCapitalizationGetClientResponse, error)

MarketCapitalizationGetWithResponse Retrieve the market capitalization for a specific company on any given date using the FMP Company Market Capitalization API. This API provides essential data to assess the size and value of a company in the stock market, helping users gauge its overall market standing.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /market-capitalization (the `MarketCapitalizationGet` operationId).

func (*ClientWithResponses) MostActivesGetWithResponse added in v0.1.54 

func (c *ClientWithResponses) MostActivesGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*MostActivesGetClientResponse, error)

MostActivesGetWithResponse performs a GET /most-actives (the `MostActivesGet` operationId) request.

View the most actively traded stocks using the Top Traded Stocks API. Identify the companies experiencing the highest trading volumes in the market and track where the most trading activity is happening.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) NewsGeneralLatestGetWithResponse 

func (c *ClientWithResponses) NewsGeneralLatestGetWithResponse(ctx context.Context, params *NewsGeneralLatestGetParams, reqEditors ...RequestEditorFn) (*NewsGeneralLatestGetClientResponse, error)

NewsGeneralLatestGetWithResponse Access the latest general news articles from a variety of sources with the FMP General News API. Obtain headlines, snippets, and publication URLs for comprehensive news coverage.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /news/general-latest (the `NewsGeneralLatestGet` operationId).

func (*ClientWithResponses) NewsStockLatestGetWithResponse added in v0.1.25 

func (c *ClientWithResponses) NewsStockLatestGetWithResponse(ctx context.Context, params *NewsStockLatestGetParams, reqEditors ...RequestEditorFn) (*NewsStockLatestGetClientResponse, error)

NewsStockLatestGetWithResponse Stay informed with the latest stock market news using the FMP Stock News Feed API. Access headlines, snippets, publication URLs, and ticker symbols for the most recent articles from a variety of sources.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /news/stock-latest (the `NewsStockLatestGet` operationId).

func (*ClientWithResponses) ProfileBulkGetWithResponse added in v0.1.29 

func (c *ClientWithResponses) ProfileBulkGetWithResponse(ctx context.Context, params *ProfileBulkGetParams, reqEditors ...RequestEditorFn) (*ProfileBulkGetClientResponse, error)

ProfileBulkGetWithResponse The FMP Profile Bulk API allows users to retrieve comprehensive company profile data in bulk. Access essential information, such as company details, stock price, market cap, sector, industry, and more for multiple companies in a single request.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /profile-bulk (the `ProfileBulkGet` operationId).

func (*ClientWithResponses) ProfileGetWithResponse 

func (c *ClientWithResponses) ProfileGetWithResponse(ctx context.Context, params *ProfileGetParams, reqEditors ...RequestEditorFn) (*ProfileGetClientResponse, error)

ProfileGetWithResponse Access detailed company profile data with the FMP Company Profile Data API. This API provides key financial and operational information for a specific stock symbol, including the company's market capitalization, stock price, industry, and much more.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /profile (the `ProfileGet` operationId).

func (*ClientWithResponses) QuoteGetWithResponse 

func (c *ClientWithResponses) QuoteGetWithResponse(ctx context.Context, params *QuoteGetParams, reqEditors ...RequestEditorFn) (*QuoteGetClientResponse, error)

QuoteGetWithResponse Access real-time stock quotes with the FMP Stock Quote API. Get up-to-the-minute prices, changes, and volume data for individual stocks.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /quote (the `QuoteGet` operationId).

func (*ClientWithResponses) QuoteShortGetWithResponse 

func (c *ClientWithResponses) QuoteShortGetWithResponse(ctx context.Context, params *QuoteShortGetParams, reqEditors ...RequestEditorFn) (*QuoteShortGetClientResponse, error)

QuoteShortGetWithResponse Get quick snapshots of real-time stock quotes with the FMP Stock Quote Short API. Access key stock data like current price, volume, and price changes for instant market insights.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /quote-short (the `QuoteShortGet` operationId).

func (*ClientWithResponses) RatingBulkGetWithResponse added in v0.1.29 

func (c *ClientWithResponses) RatingBulkGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RatingBulkGetClientResponse, error)

RatingBulkGetWithResponse The FMP Rating Bulk API provides users with comprehensive rating data for multiple stocks in a single request. Retrieve key financial ratings and recommendations such as overall ratings, DCF recommendations, and more for multiple companies at once.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /rating-bulk (the `RatingBulkGet` operationId).

func (*ClientWithResponses) RatingsSnapshotGetWithResponse 

func (c *ClientWithResponses) RatingsSnapshotGetWithResponse(ctx context.Context, params *RatingsSnapshotGetParams, reqEditors ...RequestEditorFn) (*RatingsSnapshotGetClientResponse, error)

RatingsSnapshotGetWithResponse Quickly assess the financial health and performance of companies with the FMP Ratings Snapshot API. This API provides a comprehensive snapshot of financial ratings for stock symbols in our database, based on various key financial ratios.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /ratings-snapshot (the `RatingsSnapshotGet` operationId).

func (*ClientWithResponses) RatiosGetWithResponse 

func (c *ClientWithResponses) RatiosGetWithResponse(ctx context.Context, params *RatiosGetParams, reqEditors ...RequestEditorFn) (*RatiosGetClientResponse, error)

RatiosGetWithResponse Analyze a company's financial performance using the Financial Ratios API. This API provides detailed profitability, liquidity, and efficiency ratios, enabling users to assess a company's operational and financial health across various metrics.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /ratios (the `RatiosGet` operationId).

func (*ClientWithResponses) RatiosTTMBulkGetWithResponse added in v0.1.29 

func (c *ClientWithResponses) RatiosTTMBulkGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RatiosTTMBulkGetClientResponse, error)

RatiosTTMBulkGetWithResponse The Ratios TTM Bulk API offers an efficient way to retrieve trailing twelve months (TTM) financial ratios for stocks. It provides users with detailed insights into a company’s profitability, liquidity, efficiency, leverage, and valuation ratios, all based on the most recent financial report.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /ratios-ttm-bulk (the `RatiosTTMBulkGet` operationId).

func (*ClientWithResponses) RatiosTTMGetWithResponse added in v0.1.13 

func (c *ClientWithResponses) RatiosTTMGetWithResponse(ctx context.Context, params *RatiosTTMGetParams, reqEditors ...RequestEditorFn) (*RatiosTTMGetClientResponse, error)

RatiosTTMGetWithResponse Gain access to trailing twelve-month (TTM) financial ratios with the TTM Ratios API. This API provides key performance metrics over the past year, including profitability, liquidity, and efficiency ratios.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /ratios-ttm (the `RatiosTTMGet` operationId).

func (*ClientWithResponses) RevenueGeographicSegmentationGetWithResponse 

func (c *ClientWithResponses) RevenueGeographicSegmentationGetWithResponse(ctx context.Context, params *RevenueGeographicSegmentationGetParams, reqEditors ...RequestEditorFn) (*RevenueGeographicSegmentationGetClientResponse, error)

RevenueGeographicSegmentationGetWithResponse Access detailed revenue breakdowns by geographic region with the Revenue Geographic Segments API. Analyze how different regions contribute to a company's total revenue and identify key markets for growth.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /revenue-geographic-segmentation (the `RevenueGeographicSegmentationGet` operationId).

func (*ClientWithResponses) RevenueProductSegmentationGetWithResponse 

func (c *ClientWithResponses) RevenueProductSegmentationGetWithResponse(ctx context.Context, params *RevenueProductSegmentationGetParams, reqEditors ...RequestEditorFn) (*RevenueProductSegmentationGetClientResponse, error)

RevenueProductSegmentationGetWithResponse Access detailed revenue breakdowns by product line with the Revenue Product Segmentation API. Understand which products drive a company's earnings and get insights into the performance of individual product segments.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /revenue-product-segmentation (the `RevenueProductSegmentationGet` operationId).

func (*ClientWithResponses) SearchNameGetWithResponse 

func (c *ClientWithResponses) SearchNameGetWithResponse(ctx context.Context, params *SearchNameGetParams, reqEditors ...RequestEditorFn) (*SearchNameGetClientResponse, error)

SearchNameGetWithResponse Search for ticker symbols, company names, and exchange details for equity securities and ETFs listed on various exchanges with the FMP Name Search API. This endpoint is useful for retrieving ticker symbols when you know the full or partial company or asset name but not the symbol identifier.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /search-name (the `SearchNameGet` operationId).

func (*ClientWithResponses) SearchSymbolGetWithResponse 

func (c *ClientWithResponses) SearchSymbolGetWithResponse(ctx context.Context, params *SearchSymbolGetParams, reqEditors ...RequestEditorFn) (*SearchSymbolGetClientResponse, error)

SearchSymbolGetWithResponse Easily find the ticker symbol of any stock with the FMP Stock Symbol Search API. Search by company name or symbol across multiple global markets.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /search-symbol (the `SearchSymbolGet` operationId).

func (*ClientWithResponses) SharesFloatGetWithResponse 

func (c *ClientWithResponses) SharesFloatGetWithResponse(ctx context.Context, params *SharesFloatGetParams, reqEditors ...RequestEditorFn) (*SharesFloatGetClientResponse, error)

SharesFloatGetWithResponse Understand the liquidity and volatility of a stock with the FMP Company Share Float and Liquidity API. Access the total number of publicly traded shares for any company to make informed investment decisions.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /shares-float (the `SharesFloatGet` operationId).

func (*ClientWithResponses) SplitsCalendarGetWithResponse added in v0.1.53 

func (c *ClientWithResponses) SplitsCalendarGetWithResponse(ctx context.Context, params *SplitsCalendarGetParams, reqEditors ...RequestEditorFn) (*SplitsCalendarGetClientResponse, error)

SplitsCalendarGetWithResponse Stay informed about upcoming stock splits with the FMP Stock Splits Calendar API. This API provides essential data on upcoming stock splits across multiple companies, including the split date and ratio, helping you track changes in share structures before they occur.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /splits-calendar (the `SplitsCalendarGet` operationId).

func (*ClientWithResponses) SplitsGetWithResponse added in v0.1.53 

func (c *ClientWithResponses) SplitsGetWithResponse(ctx context.Context, params *SplitsGetParams, reqEditors ...RequestEditorFn) (*SplitsGetClientResponse, error)

SplitsGetWithResponse Access detailed information on stock splits for a specific company using the FMP Stock Split Details API. This API provides essential data, including the split date and the split ratio, helping users understand changes in a company's share structure after a stock split.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /splits (the `SplitsGet` operationId).

func (*ClientWithResponses) StockListGetWithResponse added in v0.1.5 

func (c *ClientWithResponses) StockListGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*StockListGetClientResponse, error)

StockListGetWithResponse Easily retrieve a comprehensive list of financial symbols with the FMP Company Symbols List API. Access a broad range of stock symbols and other tradable financial instruments from various global exchanges, helping you explore the full range of available securities.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /stock-list (the `StockListGet` operationId).

func (*ClientWithResponses) TechnicalIndicatorsRsiGetWithResponse added in v0.1.23 

func (c *ClientWithResponses) TechnicalIndicatorsRsiGetWithResponse(ctx context.Context, params *TechnicalIndicatorsRsiGetParams, reqEditors ...RequestEditorFn) (*TechnicalIndicatorsRsiGetClientResponse, error)

TechnicalIndicatorsRsiGetWithResponse Get the Relative Strength Index(RSI) technical indicator for a given symbol and time period.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /technical-indicators/rsi (the `TechnicalIndicatorsRsiGet` operationId).

func (*ClientWithResponses) TreasuryRatesGetWithResponse 

func (c *ClientWithResponses) TreasuryRatesGetWithResponse(ctx context.Context, params *TreasuryRatesGetParams, reqEditors ...RequestEditorFn) (*TreasuryRatesGetClientResponse, error)

TreasuryRatesGetWithResponse Access real-time and historical Treasury rates for all maturities with the FMP Treasury Rates API. Track key benchmarks for interest rates across the economy.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /treasury-rates (the `TreasuryRatesGet` operationId).

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {

	// AnalystEstimatesGetWithResponse Retrieve analyst financial estimates for stock symbols with the FMP Financial Estimates API. Access projected figures like revenue, earnings per share (EPS), and other key financial metrics as forecasted by industry analysts to inform your investment decisions.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /analyst-estimates (the `AnalystEstimatesGet` operationId).
	AnalystEstimatesGetWithResponse(ctx context.Context, params *AnalystEstimatesGetParams, reqEditors ...RequestEditorFn) (*AnalystEstimatesGetClientResponse, error)

	// AvailableExchangesGetWithResponse Access a complete list of supported stock exchanges using the FMP Available Exchanges API. This API provides a comprehensive overview of global stock exchanges, allowing users to identify where securities are traded and filter data by specific exchanges for further analysis.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /available-exchanges (the `AvailableExchangesGet` operationId).
	AvailableExchangesGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*AvailableExchangesGetClientResponse, error)

	// BalanceSheetStatementGetWithResponse Access detailed balance sheet statements for publicly traded companies with the Balance Sheet Data API. Analyze assets, liabilities, and shareholder equity to gain insights into a company's financial health.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /balance-sheet-statement (the `BalanceSheetStatementGet` operationId).
	BalanceSheetStatementGetWithResponse(ctx context.Context, params *BalanceSheetStatementGetParams, reqEditors ...RequestEditorFn) (*BalanceSheetStatementGetClientResponse, error)

	// BalanceSheetStatementBulkGetWithResponse The Bulk Balance Sheet Statement API provides comprehensive access to balance sheet data across multiple companies. It enables users to analyze financial positions by retrieving key figures such as total assets, liabilities, and equity. Ideal for comparing the financial health and stability of different companies on a large scale.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /balance-sheet-statement-bulk (the `BalanceSheetStatementBulkGet` operationId).
	BalanceSheetStatementBulkGetWithResponse(ctx context.Context, params *BalanceSheetStatementBulkGetParams, reqEditors ...RequestEditorFn) (*BalanceSheetStatementBulkGetClientResponse, error)

	// BalanceSheetStatementTTMGetWithResponse Get the trailing twelve months (TTM) balance sheet statement.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /balance-sheet-statement-ttm (the `BalanceSheetStatementTTMGet` operationId).
	BalanceSheetStatementTTMGetWithResponse(ctx context.Context, params *BalanceSheetStatementTTMGetParams, reqEditors ...RequestEditorFn) (*BalanceSheetStatementTTMGetClientResponse, error)

	// BatchAfterMarketQuoteGetWithResponse Retrieve real-time aftermarket quotes for multiple stocks with the FMP Batch Aftermarket Quote API. Access bid and ask prices, volume, and other relevant data for several companies during post-market trading.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /batch-aftermarket-quote (the `BatchAfterMarketQuoteGet` operationId).
	BatchAfterMarketQuoteGetWithResponse(ctx context.Context, params *BatchAfterMarketQuoteGetParams, reqEditors ...RequestEditorFn) (*BatchAfterMarketQuoteGetClientResponse, error)

	// BatchIndexQuotesGetWithResponse The All Index Quotes API provides real-time quotes for a wide range of stock indexes, from major market benchmarks to niche indexes. This API allows users to track market performance across multiple indexes in a single request, giving them a broad view of the financial markets.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /batch-index-quotes (the `BatchIndexQuotesGet` operationId).
	BatchIndexQuotesGetWithResponse(ctx context.Context, params *BatchIndexQuotesGetParams, reqEditors ...RequestEditorFn) (*BatchIndexQuotesGetClientResponse, error)

	// BatchQuoteGetWithResponse Access real-time stock quotes with the FMP Stock Quote API. Get up-to-the-minute prices, changes, and volume data for individual stocks.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /batch-quote (the `BatchQuoteGet` operationId).
	BatchQuoteGetWithResponse(ctx context.Context, params *BatchQuoteGetParams, reqEditors ...RequestEditorFn) (*BatchQuoteGetClientResponse, error)

	// BatchQuoteShortGetWithResponse Access real-time, short-form quotes for multiple stocks with the FMP Stock Batch Quote Short API. Get a quick snapshot of key stock data such as current price, change, and volume for several companies in one streamlined request.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /batch-quote-short (the `BatchQuoteShortGet` operationId).
	BatchQuoteShortGetWithResponse(ctx context.Context, params *BatchQuoteShortGetParams, reqEditors ...RequestEditorFn) (*BatchQuoteShortGetClientResponse, error)

	// BiggestGainersGetWithResponse performs a GET /biggest-gainers (the `BiggestGainersGet` operationId) request.
	//
	// Track the stocks with the largest price increases using the Top Stock Gainers API. Identify the companies that are leading the market with significant price surges, offering potential growth opportunities.
	//
	// Returns a wrapper object for the known response body format(s).
	BiggestGainersGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*BiggestGainersGetClientResponse, error)

	// BiggestLosersGetWithResponse performs a GET /biggest-losers (the `BiggestLosersGet` operationId) request.
	//
	// Access data on the stocks with the largest price drops using the Biggest Stock Losers API. Identify companies experiencing significant declines and track the stocks that are falling the fastest in the market.
	//
	// Returns a wrapper object for the known response body format(s).
	BiggestLosersGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*BiggestLosersGetClientResponse, error)

	// CashFlowStatementGetWithResponse Gain insights into a company's cash flow activities with the Cash Flow Statements API. Analyze cash generated and used from operations, investments, and financing activities to evaluate the financial health and sustainability of a business.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /cash-flow-statement (the `CashFlowStatementGet` operationId).
	CashFlowStatementGetWithResponse(ctx context.Context, params *CashFlowStatementGetParams, reqEditors ...RequestEditorFn) (*CashFlowStatementGetClientResponse, error)

	// CashFlowStatementBulkGetWithResponse The Cash Flow Statement Bulk API provides access to detailed cash flow reports for a wide range of companies. This API enables users to retrieve bulk cash flow statement data, helping to analyze companies’ operating, investing, and financing activities over time.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /cash-flow-statement-bulk (the `CashFlowStatementBulkGet` operationId).
	CashFlowStatementBulkGetWithResponse(ctx context.Context, params *CashFlowStatementBulkGetParams, reqEditors ...RequestEditorFn) (*CashFlowStatementBulkGetClientResponse, error)

	// CashFlowStatementTTMGetWithResponse Get the trailing twelve months (TTM) cash flow statement.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /cash-flow-statement-ttm (the `CashFlowStatementTTMGet` operationId).
	CashFlowStatementTTMGetWithResponse(ctx context.Context, params *CashFlowStatementTTMGetParams, reqEditors ...RequestEditorFn) (*CashFlowStatementTTMGetClientResponse, error)

	// CommoditiesListGetWithResponse Access an extensive list of tracked commodities across various sectors, including energy, metals, and agricultural products. The FMP Commodities List API provides essential data on tradable commodities, giving investors the ability to explore market options.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /commodities-list (the `CommoditiesListGet` operationId).
	CommoditiesListGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*CommoditiesListGetClientResponse, error)

	// CryptocurrencyListGetWithResponse Access a comprehensive list of all cryptocurrencies traded on exchanges worldwide with the FMP Cryptocurrencies Overview API. Get detailed information on each cryptocurrency to inform your investment strategies.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /cryptocurrency-list (the `CryptocurrencyListGet` operationId).
	CryptocurrencyListGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*CryptocurrencyListGetClientResponse, error)

	// DcfBulkGetWithResponse The FMP DCF Bulk API enables users to quickly retrieve discounted cash flow (DCF) valuations for multiple symbols in one request. Access the implied price movement and percentage differences for all listed companies.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /dcf-bulk (the `DcfBulkGet` operationId).
	DcfBulkGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*DcfBulkGetClientResponse, error)

	// DelistedCompaniesWithResponse Stay informed with the FMP Delisted Companies API. Access a comprehensive list of companies that have been delisted from US exchanges to avoid trading in risky stocks and identify potential financial troubles.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /delisted-companies (the `DelistedCompanies` operationId).
	DelistedCompaniesWithResponse(ctx context.Context, params *DelistedCompaniesParams, reqEditors ...RequestEditorFn) (*DelistedCompaniesClientResponse, error)

	// DividendsGetWithResponse Stay informed on upcoming dividend events with the Dividend Events Calendar API. Access a comprehensive schedule of dividend-related dates for all stocks, including record dates, payment dates, declaration dates, and dividend yields.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /dividends (the `DividendsGet` operationId).
	DividendsGetWithResponse(ctx context.Context, params *DividendsGetParams, reqEditors ...RequestEditorFn) (*DividendsGetClientResponse, error)

	// DividendsCalendarGetWithResponse Stay informed on upcoming dividend events with the Dividend Events Calendar API. Access a comprehensive schedule of dividend-related dates for all stocks, including record dates, payment dates, declaration dates, and dividend yields.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /dividends-calendar (the `DividendsCalendarGet` operationId).
	DividendsCalendarGetWithResponse(ctx context.Context, params *DividendsCalendarGetParams, reqEditors ...RequestEditorFn) (*DividendsCalendarGetClientResponse, error)

	// EarningsGetWithResponse Retrieve in-depth earnings information with the FMP Earnings Report API. Gain access to key financial data for a specific stock symbol, including earnings report dates, EPS estimates, and revenue projections to help you stay on top of company performance.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /earnings (the `EarningsGet` operationId).
	EarningsGetWithResponse(ctx context.Context, params *EarningsGetParams, reqEditors ...RequestEditorFn) (*EarningsGetClientResponse, error)

	// EarningsCalendarGetWithResponse Stay informed on upcoming and past earnings announcements with the FMP Earnings Calendar API. Access key data, including announcement dates, estimated earnings per share (EPS), and actual EPS for publicly traded companies.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /earnings-calendar (the `EarningsCalendarGet` operationId).
	EarningsCalendarGetWithResponse(ctx context.Context, params *EarningsCalendarGetParams, reqEditors ...RequestEditorFn) (*EarningsCalendarGetClientResponse, error)

	// EconomicCalendarGetWithResponse Stay informed with the FMP Economic Data Releases Calendar API. Access a comprehensive calendar of upcoming economic data releases to prepare for market impacts and make informed investment decisions.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /economic-calendar (the `EconomicCalendarGet` operationId).
	EconomicCalendarGetWithResponse(ctx context.Context, params *EconomicCalendarGetParams, reqEditors ...RequestEditorFn) (*EconomicCalendarGetClientResponse, error)

	// EnterpriseValueGetWithResponse Access a company's enterprise value using the Enterprise Values API. This metric offers a comprehensive view of a company's total market value by combining both its equity (market capitalization) and debt, providing a better understanding of its worth.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /enterprise-values (the `EnterpriseValueGet` operationId).
	EnterpriseValueGetWithResponse(ctx context.Context, params *EnterpriseValueGetParams, reqEditors ...RequestEditorFn) (*EnterpriseValueGetClientResponse, error)

	// EsgDisclosuresGetWithResponse Align your investments with your values using the FMP ESG Investment Search API. Discover companies and funds based on Environmental, Social, and Governance (ESG) scores, performance, controversies, and business involvement criteria.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /esg-disclosures (the `EsgDisclosuresGet` operationId).
	EsgDisclosuresGetWithResponse(ctx context.Context, params *EsgDisclosuresGetParams, reqEditors ...RequestEditorFn) (*EsgDisclosuresGetClientResponse, error)

	// EsgRatingsGetWithResponse Access comprehensive ESG ratings for companies and funds with the FMP ESG Ratings API. Make informed investment decisions based on environmental, social, and governance (ESG) performance data.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /esg-ratings (the `EsgRatingsGet` operationId).
	EsgRatingsGetWithResponse(ctx context.Context, params *EsgRatingsGetParams, reqEditors ...RequestEditorFn) (*EsgRatingsGetClientResponse, error)

	// ETFListGetWithResponse Quickly find ticker symbols and company names for Exchange Traded Funds (ETFs) using the FMP ETF Symbol Search API. This tool simplifies identifying specific ETFs by their name or ticker.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /etf-list (the `ETFListGet` operationId).
	ETFListGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ETFListGetClientResponse, error)

	// ETFCountryWeightingsGetWithResponse Gain insight into how ETFs and mutual funds distribute assets across different countries with the FMP ETF & Fund Country Allocation API. This tool provides detailed information on the percentage of assets allocated to various regions, helping you make informed investment decisions.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /etf/country-weightings (the `ETFCountryWeightingsGet` operationId).
	ETFCountryWeightingsGetWithResponse(ctx context.Context, params *ETFCountryWeightingsGetParams, reqEditors ...RequestEditorFn) (*ETFCountryWeightingsGetClientResponse, error)

	// ETFHoldingsGetWithResponse Get a detailed breakdown of the assets held within ETFs and mutual funds using the FMP ETF & Fund Holdings API. Access real-time data on the specific securities and their weights in the portfolio, providing insights into asset composition and fund strategies.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /etf/holdings (the `ETFHoldingsGet` operationId).
	ETFHoldingsGetWithResponse(ctx context.Context, params *ETFHoldingsGetParams, reqEditors ...RequestEditorFn) (*ETFHoldingsGetClientResponse, error)

	// ETFInfoGetWithResponse Access comprehensive data on ETFs and mutual funds with the FMP ETF & Mutual Fund Information API. Retrieve essential details such as ticker symbol, fund name, expense ratio, assets under management, and more.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /etf/info (the `ETFInfoGet` operationId).
	ETFInfoGetWithResponse(ctx context.Context, params *ETFInfoGetParams, reqEditors ...RequestEditorFn) (*ETFInfoGetClientResponse, error)

	// ETFSectorWeightingsGetWithResponse performs a GET /etf/sector-weightings (the `ETFSectorWeightingsGet` operationId) request.
	//
	// The FMP ETF Sector Weighting API provides a breakdown of the percentage of an ETF's assets that are invested in each sector. For example, an investor may want to invest in an ETF that has a high exposure to the technology sector if they believe that the technology sector is poised for growth.
	//
	// Returns a wrapper object for the known response body format(s).
	ETFSectorWeightingsGetWithResponse(ctx context.Context, params *ETFSectorWeightingsGetParams, reqEditors ...RequestEditorFn) (*ETFSectorWeightingsGetClientResponse, error)

	// ForexCurrencyPairsGetWithResponse performs a GET /forex-list (the `ForexCurrencyPairsGet` operationId) request.
	//
	// Access a comprehensive list of all currency pairs traded on the forex market with the FMP Forex Currency Pairs API. Analyze and track the performance of currency pairs to make informed investment decisions.
	//
	// Returns a wrapper object for the known response body format(s).
	ForexCurrencyPairsGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ForexCurrencyPairsGetClientResponse, error)

	// GradesLatestNewsGetWithResponse Stay informed on the latest stock rating changes with the FMP Grade Latest News API. This API provides the most recent updates on analyst ratings for all stock symbols, including links to the original news sources. Track stock price movements, grading firm actions, and market sentiment shifts in real time, sourced from trusted publishers.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /grades-latest-news (the `GradesLatestNewsGet` operationId).
	GradesLatestNewsGetWithResponse(ctx context.Context, params *GradesLatestNewsGetParams, reqEditors ...RequestEditorFn) (*GradesLatestNewsGetClientResponse, error)

	// HistoricalChart15MinGetWithResponse Access stock price and volume data with the FMP 15-Minute Interval Stock Chart API. Retrieve detailed stock data in 15-minute intervals, including open, high, low, close prices, and trading volume. This API is ideal for creating intraday charts and analyzing medium-term price trends during the trading day.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /historical-chart/15min (the `HistoricalChart15MinGet` operationId).
	HistoricalChart15MinGetWithResponse(ctx context.Context, params *HistoricalChart15MinGetParams, reqEditors ...RequestEditorFn) (*HistoricalChart15MinGetClientResponse, error)

	// HistoricalPriceEodFullGetWithResponse Access full price and volume data for any stock symbol using the FMP Comprehensive Stock Price and Volume Data API. Get detailed insights, including open, high, low, close prices, trading volume, price changes, percentage changes, and volume-weighted average price (VWAP).
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /historical-price-eod/full (the `HistoricalPriceEodFullGet` operationId).
	HistoricalPriceEodFullGetWithResponse(ctx context.Context, params *HistoricalPriceEodFullGetParams, reqEditors ...RequestEditorFn) (*HistoricalPriceEodFullGetClientResponse, error)

	// HistoricalPriceEodLightGetWithResponse Access simplified stock chart data using the FMP Basic Stock Chart API. This API provides essential charting information, including date, price, and trading volume, making it ideal for tracking stock performance with minimal data and creating basic price and volume charts.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /historical-price-eod/light (the `HistoricalPriceEodLightGet` operationId).
	HistoricalPriceEodLightGetWithResponse(ctx context.Context, params *HistoricalPriceEodLightGetParams, reqEditors ...RequestEditorFn) (*HistoricalPriceEodLightGetClientResponse, error)

	// IncomeStatementGetWithResponse Access real-time income statement data for public companies, private companies, and ETFs with the FMP Real-Time Income Statements API. Track profitability, compare competitors, and identify business trends with up-to-date financial data.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /income-statement (the `IncomeStatementGet` operationId).
	IncomeStatementGetWithResponse(ctx context.Context, params *IncomeStatementGetParams, reqEditors ...RequestEditorFn) (*IncomeStatementGetClientResponse, error)

	// IncomeStatementBulkGetWithResponse The Bulk Income Statement API allows users to retrieve detailed income statement data in bulk. This API is designed for large-scale data analysis, providing comprehensive insights into a company's financial performance, including revenue, gross profit, expenses, and net income.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /income-statement-bulk (the `IncomeStatementBulkGet` operationId).
	IncomeStatementBulkGetWithResponse(ctx context.Context, params *IncomeStatementBulkGetParams, reqEditors ...RequestEditorFn) (*IncomeStatementBulkGetClientResponse, error)

	// IncomeStatementTTMGetWithResponse Get the trailing twelve months (TTM) income statement.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /income-statement-ttm (the `IncomeStatementTTMGet` operationId).
	IncomeStatementTTMGetWithResponse(ctx context.Context, params *IncomeStatementTTMGetParams, reqEditors ...RequestEditorFn) (*IncomeStatementTTMGetClientResponse, error)

	// IndexConstituentListGetWithResponse Retrieve a comprehensive list of stock market indexes across global exchanges using the FMP Stock Market Indexes List API. This API provides essential information such as the symbol, name, exchange, and currency for each index, helping analysts and investors keep track of various market benchmarks.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /index-constituent-list (the `IndexConstituentListGet` operationId).
	IndexConstituentListGetWithResponse(ctx context.Context, params *IndexConstituentListGetParams, reqEditors ...RequestEditorFn) (*IndexConstituentListGetClientResponse, error)

	// IndexListGetWithResponse Retrieve a comprehensive list of stock market indexes across global exchanges using the FMP Stock Market Indexes List API. This API provides essential information such as the symbol, name, exchange, and currency for each index, helping analysts and investors keep track of various market benchmarks.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /index-list (the `IndexListGet` operationId).
	IndexListGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*IndexListGetClientResponse, error)

	// InsiderTradingLatestGetWithResponse Access the latest insider trading activity using the Latest Insider Trading API. Track which company insiders are buying or selling stocks and analyze their transactions.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /insider-trading/latest (the `InsiderTradingLatestGet` operationId).
	InsiderTradingLatestGetWithResponse(ctx context.Context, params *InsiderTradingLatestGetParams, reqEditors ...RequestEditorFn) (*InsiderTradingLatestGetClientResponse, error)

	// InsiderTradingSearchGetWithResponse Search insider trading activity by company or symbol using the Search Insider Trades API. Find specific trades made by corporate insiders, including executives and directors.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /insider-trading/search (the `InsiderTradingSearchGet` operationId).
	InsiderTradingSearchGetWithResponse(ctx context.Context, params *InsiderTradingSearchGetParams, reqEditors ...RequestEditorFn) (*InsiderTradingSearchGetClientResponse, error)

	// KeyMetricsGetWithResponse Access essential financial metrics for a company with the FMP Financial Key Metrics API. Evaluate revenue, net income, P/E ratio, and more to assess performance and compare it to competitors.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /key-metrics (the `KeyMetricsGet` operationId).
	KeyMetricsGetWithResponse(ctx context.Context, params *KeyMetricsGetParams, reqEditors ...RequestEditorFn) (*KeyMetricsGetClientResponse, error)

	// KeyMetricsTTMGetWithResponse Retrieve a comprehensive set of trailing twelve-month (TTM) key performance metrics with the TTM Key Metrics API. Access data related to a company's profitability, capital efficiency, and liquidity, allowing for detailed analysis of its financial health over the past year.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /key-metrics-ttm (the `KeyMetricsTTMGet` operationId).
	KeyMetricsTTMGetWithResponse(ctx context.Context, params *KeyMetricsTTMGetParams, reqEditors ...RequestEditorFn) (*KeyMetricsTTMGetClientResponse, error)

	// KeyMetricsTTMBulkGetWithResponse The Key Metrics TTM Bulk API allows users to retrieve trailing twelve months (TTM) data for all companies available in the database. The API provides critical financial ratios and metrics based on each company’s latest financial report, offering insights into company performance and financial health.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /key-metrics-ttm-bulk (the `KeyMetricsTTMBulkGet` operationId).
	KeyMetricsTTMBulkGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*KeyMetricsTTMBulkGetClientResponse, error)

	// MarketCapitalizationGetWithResponse Retrieve the market capitalization for a specific company on any given date using the FMP Company Market Capitalization API. This API provides essential data to assess the size and value of a company in the stock market, helping users gauge its overall market standing.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /market-capitalization (the `MarketCapitalizationGet` operationId).
	MarketCapitalizationGetWithResponse(ctx context.Context, params *MarketCapitalizationGetParams, reqEditors ...RequestEditorFn) (*MarketCapitalizationGetClientResponse, error)

	// MarketCapitalizationBatchGetWithResponse Retrieve market capitalization data for multiple companies in a single request with the FMP Batch Market Capitalization API. This API allows users to compare the market size of various companies simultaneously, streamlining the analysis of company valuations.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /market-capitalization-batch (the `MarketCapitalizationBatchGet` operationId).
	MarketCapitalizationBatchGetWithResponse(ctx context.Context, params *MarketCapitalizationBatchGetParams, reqEditors ...RequestEditorFn) (*MarketCapitalizationBatchGetClientResponse, error)

	// MostActivesGetWithResponse performs a GET /most-actives (the `MostActivesGet` operationId) request.
	//
	// View the most actively traded stocks using the Top Traded Stocks API. Identify the companies experiencing the highest trading volumes in the market and track where the most trading activity is happening.
	//
	// Returns a wrapper object for the known response body format(s).
	MostActivesGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*MostActivesGetClientResponse, error)

	// NewsGeneralLatestGetWithResponse Access the latest general news articles from a variety of sources with the FMP General News API. Obtain headlines, snippets, and publication URLs for comprehensive news coverage.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /news/general-latest (the `NewsGeneralLatestGet` operationId).
	NewsGeneralLatestGetWithResponse(ctx context.Context, params *NewsGeneralLatestGetParams, reqEditors ...RequestEditorFn) (*NewsGeneralLatestGetClientResponse, error)

	// NewsStockLatestGetWithResponse Stay informed with the latest stock market news using the FMP Stock News Feed API. Access headlines, snippets, publication URLs, and ticker symbols for the most recent articles from a variety of sources.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /news/stock-latest (the `NewsStockLatestGet` operationId).
	NewsStockLatestGetWithResponse(ctx context.Context, params *NewsStockLatestGetParams, reqEditors ...RequestEditorFn) (*NewsStockLatestGetClientResponse, error)

	// ProfileGetWithResponse Access detailed company profile data with the FMP Company Profile Data API. This API provides key financial and operational information for a specific stock symbol, including the company's market capitalization, stock price, industry, and much more.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /profile (the `ProfileGet` operationId).
	ProfileGetWithResponse(ctx context.Context, params *ProfileGetParams, reqEditors ...RequestEditorFn) (*ProfileGetClientResponse, error)

	// ProfileBulkGetWithResponse The FMP Profile Bulk API allows users to retrieve comprehensive company profile data in bulk. Access essential information, such as company details, stock price, market cap, sector, industry, and more for multiple companies in a single request.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /profile-bulk (the `ProfileBulkGet` operationId).
	ProfileBulkGetWithResponse(ctx context.Context, params *ProfileBulkGetParams, reqEditors ...RequestEditorFn) (*ProfileBulkGetClientResponse, error)

	// QuoteGetWithResponse Access real-time stock quotes with the FMP Stock Quote API. Get up-to-the-minute prices, changes, and volume data for individual stocks.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /quote (the `QuoteGet` operationId).
	QuoteGetWithResponse(ctx context.Context, params *QuoteGetParams, reqEditors ...RequestEditorFn) (*QuoteGetClientResponse, error)

	// QuoteShortGetWithResponse Get quick snapshots of real-time stock quotes with the FMP Stock Quote Short API. Access key stock data like current price, volume, and price changes for instant market insights.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /quote-short (the `QuoteShortGet` operationId).
	QuoteShortGetWithResponse(ctx context.Context, params *QuoteShortGetParams, reqEditors ...RequestEditorFn) (*QuoteShortGetClientResponse, error)

	// RatingBulkGetWithResponse The FMP Rating Bulk API provides users with comprehensive rating data for multiple stocks in a single request. Retrieve key financial ratings and recommendations such as overall ratings, DCF recommendations, and more for multiple companies at once.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /rating-bulk (the `RatingBulkGet` operationId).
	RatingBulkGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RatingBulkGetClientResponse, error)

	// RatingsSnapshotGetWithResponse Quickly assess the financial health and performance of companies with the FMP Ratings Snapshot API. This API provides a comprehensive snapshot of financial ratings for stock symbols in our database, based on various key financial ratios.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /ratings-snapshot (the `RatingsSnapshotGet` operationId).
	RatingsSnapshotGetWithResponse(ctx context.Context, params *RatingsSnapshotGetParams, reqEditors ...RequestEditorFn) (*RatingsSnapshotGetClientResponse, error)

	// RatiosGetWithResponse Analyze a company's financial performance using the Financial Ratios API. This API provides detailed profitability, liquidity, and efficiency ratios, enabling users to assess a company's operational and financial health across various metrics.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /ratios (the `RatiosGet` operationId).
	RatiosGetWithResponse(ctx context.Context, params *RatiosGetParams, reqEditors ...RequestEditorFn) (*RatiosGetClientResponse, error)

	// RatiosTTMGetWithResponse Gain access to trailing twelve-month (TTM) financial ratios with the TTM Ratios API. This API provides key performance metrics over the past year, including profitability, liquidity, and efficiency ratios.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /ratios-ttm (the `RatiosTTMGet` operationId).
	RatiosTTMGetWithResponse(ctx context.Context, params *RatiosTTMGetParams, reqEditors ...RequestEditorFn) (*RatiosTTMGetClientResponse, error)

	// RatiosTTMBulkGetWithResponse The Ratios TTM Bulk API offers an efficient way to retrieve trailing twelve months (TTM) financial ratios for stocks. It provides users with detailed insights into a company’s profitability, liquidity, efficiency, leverage, and valuation ratios, all based on the most recent financial report.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /ratios-ttm-bulk (the `RatiosTTMBulkGet` operationId).
	RatiosTTMBulkGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RatiosTTMBulkGetClientResponse, error)

	// RevenueGeographicSegmentationGetWithResponse Access detailed revenue breakdowns by geographic region with the Revenue Geographic Segments API. Analyze how different regions contribute to a company's total revenue and identify key markets for growth.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /revenue-geographic-segmentation (the `RevenueGeographicSegmentationGet` operationId).
	RevenueGeographicSegmentationGetWithResponse(ctx context.Context, params *RevenueGeographicSegmentationGetParams, reqEditors ...RequestEditorFn) (*RevenueGeographicSegmentationGetClientResponse, error)

	// RevenueProductSegmentationGetWithResponse Access detailed revenue breakdowns by product line with the Revenue Product Segmentation API. Understand which products drive a company's earnings and get insights into the performance of individual product segments.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /revenue-product-segmentation (the `RevenueProductSegmentationGet` operationId).
	RevenueProductSegmentationGetWithResponse(ctx context.Context, params *RevenueProductSegmentationGetParams, reqEditors ...RequestEditorFn) (*RevenueProductSegmentationGetClientResponse, error)

	// SearchNameGetWithResponse Search for ticker symbols, company names, and exchange details for equity securities and ETFs listed on various exchanges with the FMP Name Search API. This endpoint is useful for retrieving ticker symbols when you know the full or partial company or asset name but not the symbol identifier.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /search-name (the `SearchNameGet` operationId).
	SearchNameGetWithResponse(ctx context.Context, params *SearchNameGetParams, reqEditors ...RequestEditorFn) (*SearchNameGetClientResponse, error)

	// SearchSymbolGetWithResponse Easily find the ticker symbol of any stock with the FMP Stock Symbol Search API. Search by company name or symbol across multiple global markets.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /search-symbol (the `SearchSymbolGet` operationId).
	SearchSymbolGetWithResponse(ctx context.Context, params *SearchSymbolGetParams, reqEditors ...RequestEditorFn) (*SearchSymbolGetClientResponse, error)

	// SharesFloatGetWithResponse Understand the liquidity and volatility of a stock with the FMP Company Share Float and Liquidity API. Access the total number of publicly traded shares for any company to make informed investment decisions.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /shares-float (the `SharesFloatGet` operationId).
	SharesFloatGetWithResponse(ctx context.Context, params *SharesFloatGetParams, reqEditors ...RequestEditorFn) (*SharesFloatGetClientResponse, error)

	// SplitsGetWithResponse Access detailed information on stock splits for a specific company using the FMP Stock Split Details API. This API provides essential data, including the split date and the split ratio, helping users understand changes in a company's share structure after a stock split.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /splits (the `SplitsGet` operationId).
	SplitsGetWithResponse(ctx context.Context, params *SplitsGetParams, reqEditors ...RequestEditorFn) (*SplitsGetClientResponse, error)

	// SplitsCalendarGetWithResponse Stay informed about upcoming stock splits with the FMP Stock Splits Calendar API. This API provides essential data on upcoming stock splits across multiple companies, including the split date and ratio, helping you track changes in share structures before they occur.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /splits-calendar (the `SplitsCalendarGet` operationId).
	SplitsCalendarGetWithResponse(ctx context.Context, params *SplitsCalendarGetParams, reqEditors ...RequestEditorFn) (*SplitsCalendarGetClientResponse, error)

	// StockListGetWithResponse Easily retrieve a comprehensive list of financial symbols with the FMP Company Symbols List API. Access a broad range of stock symbols and other tradable financial instruments from various global exchanges, helping you explore the full range of available securities.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /stock-list (the `StockListGet` operationId).
	StockListGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*StockListGetClientResponse, error)

	// TechnicalIndicatorsRsiGetWithResponse Get the Relative Strength Index(RSI) technical indicator for a given symbol and time period.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /technical-indicators/rsi (the `TechnicalIndicatorsRsiGet` operationId).
	TechnicalIndicatorsRsiGetWithResponse(ctx context.Context, params *TechnicalIndicatorsRsiGetParams, reqEditors ...RequestEditorFn) (*TechnicalIndicatorsRsiGetClientResponse, error)

	// TreasuryRatesGetWithResponse Access real-time and historical Treasury rates for all maturities with the FMP Treasury Rates API. Track key benchmarks for interest rates across the economy.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /treasury-rates (the `TreasuryRatesGet` operationId).
	TreasuryRatesGetWithResponse(ctx context.Context, params *TreasuryRatesGetParams, reqEditors ...RequestEditorFn) (*TreasuryRatesGetClientResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CommoditiesListGetClientResponse added in v0.1.42 

type CommoditiesListGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]CommoditySymbol
}

func ParseCommoditiesListGetClientResponse added in v0.1.42 

func ParseCommoditiesListGetClientResponse(rsp *http.Response) (*CommoditiesListGetClientResponse, error)

ParseCommoditiesListGetClientResponse parses an HTTP response from a CommoditiesListGetWithResponse call

func (CommoditiesListGetClientResponse) ContentType added in v0.1.43 

func (r CommoditiesListGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CommoditiesListGetClientResponse) GetBody added in v0.1.43 

func (r CommoditiesListGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CommoditiesListGetClientResponse) GetJSON200 added in v0.1.43 

func (r CommoditiesListGetClientResponse) GetJSON200() *[]CommoditySymbol

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (CommoditiesListGetClientResponse) Status added in v0.1.42 

func (r CommoditiesListGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (CommoditiesListGetClientResponse) StatusCode added in v0.1.42 

func (r CommoditiesListGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CommoditySymbol added in v0.1.40 

type CommoditySymbol struct {
	// Currency Example: USX
	Currency string  `json:"currency"`
	Exchange *string `json:"exchange,omitempty"`

	// Name Example: Lean Hogs Futures
	Name string `json:"name"`

	// Symbol Example: HEUSX
	Symbol string `json:"symbol"`

	// TradeMonth Example: Dec
	TradeMonth string `json:"tradeMonth"`
}

CommoditySymbol defines model for CommoditySymbol.

type CompanyCapitalization 

type CompanyCapitalization struct {
	// Date Example: 2025-02-04
	Date openapi_types.Date `json:"date"`

	// MarketCap Example: 3500823120000
	MarketCap float64 `json:"marketCap"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`
}

CompanyCapitalization defines model for CompanyCapitalization.

type CompanyProfile 

type CompanyProfile struct {
	// Address Example: One Apple Park Way
	Address string `json:"address"`

	// AverageVolume Example: 61946.7
	AverageVolume float64 `json:"averageVolume"`

	// Beta Example: 1.24
	Beta float64 `json:"beta"`

	// Ceo Example: Mr. Timothy D. Cook
	Ceo string `json:"ceo"`

	// Change Example: 4.79
	Change float64 `json:"change"`

	// ChangePercentage Example: 2.1008
	ChangePercentage float64 `json:"changePercentage"`

	// Cik Example: 0000320193
	Cik string `json:"cik"`

	// City Example: Cupertino
	City string `json:"city"`

	// CompanyName Example: Apple Inc.
	CompanyName string `json:"companyName"`

	// Country Example: US
	Country string `json:"country"`

	// Currency Example: USD
	Currency string `json:"currency"`

	// Cusip Example: 037833100
	Cusip string `json:"cusip"`

	// DefaultImage Example: false
	DefaultImage bool `json:"defaultImage"`

	// Description Example: Apple Inc. designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and accessories worldwide. The company offers iPhone, a line of smartphones; Mac, a line of personal computers; iPad, a line of multi-purpose tablets; and wearables, home, and accessories comprising AirPods, Apple TV, Apple Watch, Beats products, and HomePod. It also provides AppleCare support and cloud services; and operates various platforms, including the App Store that allow customers to discov...
	Description string `json:"description"`

	// Exchange Example: NASDAQ
	Exchange string `json:"exchange"`

	// ExchangeFullName Example: NASDAQ Global Select
	ExchangeFullName string `json:"exchangeFullName"`

	// FullTimeEmployees Example: 164000
	FullTimeEmployees string `json:"fullTimeEmployees"`

	// Image Example: https://images.financialmodelingprep.com/symbol/AAPL.png
	Image string `json:"image"`

	// Industry Example: Consumer Electronics
	Industry string `json:"industry"`
	IpoDate  string `json:"ipoDate"`

	// IsActivelyTrading Example: true
	IsActivelyTrading bool `json:"isActivelyTrading"`

	// IsAdr Example: false
	IsAdr bool `json:"isAdr"`

	// IsEtf Example: false
	IsEtf bool `json:"isEtf"`

	// IsFund Example: false
	IsFund bool `json:"isFund"`

	// Isin Example: US0378331005
	Isin string `json:"isin"`

	// LastDividend Example: 0.99
	LastDividend float64 `json:"lastDividend"`

	// MarketCap Example: 3500823120000
	MarketCap float64 `json:"marketCap"`

	// Phone Example: (408) 996-1010
	Phone string `json:"phone"`

	// Price Example: 232.8
	Price float64 `json:"price"`

	// Range Example: 164.08-260.1
	Range string `json:"range"`

	// Sector Example: Technology
	Sector string `json:"sector"`

	// State Example: CA
	State string `json:"state"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// Volume Example: 0
	Volume int `json:"volume"`

	// Website Example: https://www.apple.com
	Website string `json:"website"`

	// Zip Example: 95014
	Zip string `json:"zip"`
}

CompanyProfile defines model for CompanyProfile.

type CompanySharesFloat 

type CompanySharesFloat struct {
	// Date Example: 2025-02-04 17:01:35
	Date string `json:"date"`

	// FloatShares Example: 15024290700
	FloatShares int `json:"floatShares"`

	// FreeFloat Example: 99.9095
	FreeFloat float64 `json:"freeFloat"`

	// OutstandingShares Example: 15037900000
	OutstandingShares int    `json:"outstandingShares"`
	Source            string `json:"source"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`
}

CompanySharesFloat defines model for CompanySharesFloat.

type CompanySymbol added in v0.1.5 

type CompanySymbol struct {
	// CompanyName Example: China Aluminum Cans Holdings Limited
	CompanyName string `json:"companyName"`

	// Symbol Example: 6898.HK
	Symbol string `json:"symbol"`
}

CompanySymbol defines model for CompanySymbol.

type CryptoSymbol added in v0.1.55 

type CryptoSymbol struct {
	CirculatingSupply float64             `json:"circulatingSupply"`
	Exchange          string              `json:"exchange"`
	IcoDate           *openapi_types.Date `json:"icoDate,omitempty"`
	Name              string              `json:"name"`
	Symbol            string              `json:"symbol"`
	TotalSupply       float64             `json:"totalSupply"`
}

CryptoSymbol defines model for CryptoSymbol.

type CryptocurrencyListGetClientResponse added in v0.1.55 

type CryptocurrencyListGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]CryptoSymbol
}

func ParseCryptocurrencyListGetClientResponse added in v0.1.55 

func ParseCryptocurrencyListGetClientResponse(rsp *http.Response) (*CryptocurrencyListGetClientResponse, error)

ParseCryptocurrencyListGetClientResponse parses an HTTP response from a CryptocurrencyListGetWithResponse call

func (CryptocurrencyListGetClientResponse) ContentType added in v0.1.55 

func (r CryptocurrencyListGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CryptocurrencyListGetClientResponse) GetBody added in v0.1.55 

func (r CryptocurrencyListGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CryptocurrencyListGetClientResponse) GetJSON200 added in v0.1.55 

func (r CryptocurrencyListGetClientResponse) GetJSON200() *[]CryptoSymbol

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (CryptocurrencyListGetClientResponse) Status added in v0.1.55 

func (r CryptocurrencyListGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (CryptocurrencyListGetClientResponse) StatusCode added in v0.1.55 

func (r CryptocurrencyListGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DCF added in v0.1.29 

type DCF struct {
	// Date Example: 2025-07-09
	Date string `json:"date"`

	// Dcf Example: 179.6654688379575
	Dcf string `json:"dcf"`

	// StockPrice Example: 6.54
	StockPrice string `json:"stockPrice"`

	// Symbol Example: 000002.SZ
	Symbol string `json:"symbol"`
}

DCF defines model for DCF.

type DcfBulkGetClientResponse added in v0.1.29 

type DcfBulkGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]DCF
}

func ParseDcfBulkGetClientResponse added in v0.1.29 

func ParseDcfBulkGetClientResponse(rsp *http.Response) (*DcfBulkGetClientResponse, error)

ParseDcfBulkGetClientResponse parses an HTTP response from a DcfBulkGetWithResponse call

func (DcfBulkGetClientResponse) ContentType added in v0.1.43 

func (r DcfBulkGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DcfBulkGetClientResponse) GetBody added in v0.1.43 

func (r DcfBulkGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DcfBulkGetClientResponse) GetJSON200 added in v0.1.43 

func (r DcfBulkGetClientResponse) GetJSON200() *[]DCF

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (DcfBulkGetClientResponse) Status added in v0.1.29 

func (r DcfBulkGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (DcfBulkGetClientResponse) StatusCode added in v0.1.29 

func (r DcfBulkGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DelistedCompaniesClientResponse added in v0.1.26 

type DelistedCompaniesClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]DelistedCompany
}

func ParseDelistedCompaniesClientResponse added in v0.1.26 

func ParseDelistedCompaniesClientResponse(rsp *http.Response) (*DelistedCompaniesClientResponse, error)

ParseDelistedCompaniesClientResponse parses an HTTP response from a DelistedCompaniesWithResponse call

func (DelistedCompaniesClientResponse) ContentType added in v0.1.43 

func (r DelistedCompaniesClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DelistedCompaniesClientResponse) GetBody added in v0.1.43 

func (r DelistedCompaniesClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DelistedCompaniesClientResponse) GetJSON200 added in v0.1.43 

func (r DelistedCompaniesClientResponse) GetJSON200() *[]DelistedCompany

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (DelistedCompaniesClientResponse) Status added in v0.1.26 

func (r DelistedCompaniesClientResponse) Status() string

Status returns HTTPResponse.Status

func (DelistedCompaniesClientResponse) StatusCode added in v0.1.26 

func (r DelistedCompaniesClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DelistedCompaniesParams added in v0.1.26 

type DelistedCompaniesParams struct {
	Page  *int `form:"page,omitempty" json:"page,omitempty"`
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}

DelistedCompaniesParams defines parameters for DelistedCompanies.

type DelistedCompany added in v0.1.26 

type DelistedCompany struct {
	// CompanyName Example: Borqs Technologies, Inc.
	CompanyName string `json:"companyName"`

	// DelistedDate Example: 2025-02-03
	DelistedDate openapi_types.Date `json:"delistedDate"`

	// Exchange Example: PNK
	Exchange string `json:"exchange"`

	// IpoDate Example: 2017-08-24
	IpoDate openapi_types.Date `json:"ipoDate"`

	// Symbol Example: BRQSF
	Symbol string `json:"symbol"`
}

DelistedCompany defines model for DelistedCompany.

type DetailedCandle added in v0.1.28 

type DetailedCandle struct {
	// Close Example: 232.79
	Close float64 `json:"close"`

	// Date Example: 2025-02-04 15:45:00
	Date string `json:"date"`

	// High Example: 233.13
	High float64 `json:"high"`

	// Low Example: 232.18
	Low float64 `json:"low"`

	// Open Example: 232.25
	Open float64 `json:"open"`

	// Volume Example: 750590.924180001
	Volume float64 `json:"volume"`
}

DetailedCandle defines model for DetailedCandle.

type DividendEvent added in v0.1.7 

type DividendEvent struct {
	// AdjDividend Example: 0.01
	AdjDividend float64 `json:"adjDividend"`

	// Date Example: 2025-02-04
	Date openapi_types.Date `json:"date"`

	// DeclarationDate Example:
	DeclarationDate string `json:"declarationDate"`

	// Dividend Example: 0.01
	Dividend float64 `json:"dividend"`

	// Frequency Example: Semi-Annual
	Frequency string `json:"frequency"`

	// PaymentDate Example:
	PaymentDate string `json:"paymentDate"`

	// RecordDate Example:
	RecordDate string `json:"recordDate"`

	// Symbol Example: 1D0.SI
	Symbol string `json:"symbol"`

	// Yield Example: 6.25
	Yield float64 `json:"yield"`
}

DividendEvent defines model for DividendEvent.

type DividendsCalendarGetClientResponse added in v0.1.8 

type DividendsCalendarGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]DividendEvent
}

func ParseDividendsCalendarGetClientResponse added in v0.1.8 

func ParseDividendsCalendarGetClientResponse(rsp *http.Response) (*DividendsCalendarGetClientResponse, error)

ParseDividendsCalendarGetClientResponse parses an HTTP response from a DividendsCalendarGetWithResponse call

func (DividendsCalendarGetClientResponse) ContentType added in v0.1.43 

func (r DividendsCalendarGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DividendsCalendarGetClientResponse) GetBody added in v0.1.43 

func (r DividendsCalendarGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DividendsCalendarGetClientResponse) GetJSON200 added in v0.1.43 

func (r DividendsCalendarGetClientResponse) GetJSON200() *[]DividendEvent

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (DividendsCalendarGetClientResponse) Status added in v0.1.8 

func (r DividendsCalendarGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (DividendsCalendarGetClientResponse) StatusCode added in v0.1.8 

func (r DividendsCalendarGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DividendsCalendarGetParams added in v0.1.8 

type DividendsCalendarGetParams struct {
	From *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`
	To   *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`
}

DividendsCalendarGetParams defines parameters for DividendsCalendarGet.

type DividendsGetClientResponse added in v0.1.8 

type DividendsGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]DividendEvent
}

func ParseDividendsGetClientResponse added in v0.1.8 

func ParseDividendsGetClientResponse(rsp *http.Response) (*DividendsGetClientResponse, error)

ParseDividendsGetClientResponse parses an HTTP response from a DividendsGetWithResponse call

func (DividendsGetClientResponse) ContentType added in v0.1.43 

func (r DividendsGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DividendsGetClientResponse) GetBody added in v0.1.43 

func (r DividendsGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DividendsGetClientResponse) GetJSON200 added in v0.1.43 

func (r DividendsGetClientResponse) GetJSON200() *[]DividendEvent

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (DividendsGetClientResponse) Status added in v0.1.8 

func (r DividendsGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (DividendsGetClientResponse) StatusCode added in v0.1.8 

func (r DividendsGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DividendsGetParams added in v0.1.8 

type DividendsGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
	Limit  *int   `form:"limit,omitempty" json:"limit,omitempty"`
}

DividendsGetParams defines parameters for DividendsGet.

type ETFCountryWeight added in v0.1.32 

type ETFCountryWeight struct {
	// Country Example: United States
	Country string `json:"country"`

	// WeightPercentage Example: 97.29%
	WeightPercentage string `json:"weightPercentage"`
}

ETFCountryWeight defines model for ETFCountryWeight.

type ETFCountryWeightingsGetClientResponse added in v0.1.32 

type ETFCountryWeightingsGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]ETFCountryWeight
}

func ParseETFCountryWeightingsGetClientResponse added in v0.1.32 

func ParseETFCountryWeightingsGetClientResponse(rsp *http.Response) (*ETFCountryWeightingsGetClientResponse, error)

ParseETFCountryWeightingsGetClientResponse parses an HTTP response from a ETFCountryWeightingsGetWithResponse call

func (ETFCountryWeightingsGetClientResponse) ContentType added in v0.1.43 

func (r ETFCountryWeightingsGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ETFCountryWeightingsGetClientResponse) GetBody added in v0.1.43 

func (r ETFCountryWeightingsGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ETFCountryWeightingsGetClientResponse) GetJSON200 added in v0.1.43 

func (r ETFCountryWeightingsGetClientResponse) GetJSON200() *[]ETFCountryWeight

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ETFCountryWeightingsGetClientResponse) Status added in v0.1.32 

func (r ETFCountryWeightingsGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (ETFCountryWeightingsGetClientResponse) StatusCode added in v0.1.32 

func (r ETFCountryWeightingsGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ETFCountryWeightingsGetParams added in v0.1.32 

type ETFCountryWeightingsGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

ETFCountryWeightingsGetParams defines parameters for ETFCountryWeightingsGet.

type ETFHolding added in v0.1.34 

type ETFHolding struct {
	// Asset Example: AAPL
	Asset string `json:"asset"`

	// Isin Example: US0378331005
	Isin string `json:"isin"`

	// MarketValue Example: 44744793487.47
	MarketValue float64 `json:"marketValue"`

	// Name Example: APPLE INC
	Name string `json:"name"`

	// SecurityCusip Example: 037833100
	SecurityCusip string `json:"securityCusip"`

	// SharesNumber Example: 188106081
	SharesNumber float64 `json:"sharesNumber"`

	// Symbol Example: SPY
	Symbol string `json:"symbol"`

	// Updated Example: 2025-02-04 19:02:31
	Updated string `json:"updated"`

	// UpdatedAt Example: 2025-01-16 05:01:09
	UpdatedAt string `json:"updatedAt"`

	// WeightPercentage Example: 7.137
	WeightPercentage float64 `json:"weightPercentage"`
}

ETFHolding defines model for ETFHolding.

type ETFHoldingsGetClientResponse added in v0.1.34 

type ETFHoldingsGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]ETFHolding
}

func ParseETFHoldingsGetClientResponse added in v0.1.34 

func ParseETFHoldingsGetClientResponse(rsp *http.Response) (*ETFHoldingsGetClientResponse, error)

ParseETFHoldingsGetClientResponse parses an HTTP response from a ETFHoldingsGetWithResponse call

func (ETFHoldingsGetClientResponse) ContentType added in v0.1.43 

func (r ETFHoldingsGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ETFHoldingsGetClientResponse) GetBody added in v0.1.43 

func (r ETFHoldingsGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ETFHoldingsGetClientResponse) GetJSON200 added in v0.1.43 

func (r ETFHoldingsGetClientResponse) GetJSON200() *[]ETFHolding

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ETFHoldingsGetClientResponse) Status added in v0.1.34 

func (r ETFHoldingsGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (ETFHoldingsGetClientResponse) StatusCode added in v0.1.34 

func (r ETFHoldingsGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ETFHoldingsGetParams added in v0.1.34 

type ETFHoldingsGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

ETFHoldingsGetParams defines parameters for ETFHoldingsGet.

type ETFInfoGetClientResponse added in v0.1.32 

type ETFInfoGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]ETFProfile
}

func ParseETFInfoGetClientResponse added in v0.1.32 

func ParseETFInfoGetClientResponse(rsp *http.Response) (*ETFInfoGetClientResponse, error)

ParseETFInfoGetClientResponse parses an HTTP response from a ETFInfoGetWithResponse call

func (ETFInfoGetClientResponse) ContentType added in v0.1.43 

func (r ETFInfoGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ETFInfoGetClientResponse) GetBody added in v0.1.43 

func (r ETFInfoGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ETFInfoGetClientResponse) GetJSON200 added in v0.1.43 

func (r ETFInfoGetClientResponse) GetJSON200() *[]ETFProfile

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ETFInfoGetClientResponse) Status added in v0.1.32 

func (r ETFInfoGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (ETFInfoGetClientResponse) StatusCode added in v0.1.32 

func (r ETFInfoGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ETFInfoGetParams added in v0.1.32 

type ETFInfoGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

ETFInfoGetParams defines parameters for ETFInfoGet.

type ETFListGetClientResponse added in v0.1.32 

type ETFListGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]ETFSymbol
}

func ParseETFListGetClientResponse added in v0.1.32 

func ParseETFListGetClientResponse(rsp *http.Response) (*ETFListGetClientResponse, error)

ParseETFListGetClientResponse parses an HTTP response from a ETFListGetWithResponse call

func (ETFListGetClientResponse) ContentType added in v0.1.43 

func (r ETFListGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ETFListGetClientResponse) GetBody added in v0.1.43 

func (r ETFListGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ETFListGetClientResponse) GetJSON200 added in v0.1.43 

func (r ETFListGetClientResponse) GetJSON200() *[]ETFSymbol

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ETFListGetClientResponse) Status added in v0.1.32 

func (r ETFListGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (ETFListGetClientResponse) StatusCode added in v0.1.32 

func (r ETFListGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ETFProfile added in v0.1.32 

type ETFProfile struct {
	// AssetClass Example: Equity
	AssetClass string `json:"assetClass"`

	// AssetsUnderManagement Example: 633120180000
	AssetsUnderManagement float64 `json:"assetsUnderManagement"`

	// AvgVolume Example: 46396400
	AvgVolume float64 `json:"avgVolume"`

	// Description Example: The Trust seeks to achieve its investment objective by holding a portfolio of the common stocks that are included in the index (the “Portfolio”), with the weight of each stock in the Portfolio substantially corresponding to the weight of such stock in the index.
	Description string `json:"description"`

	// Domicile Example: US
	Domicile string `json:"domicile"`

	// EtfCompany Example: SPDR
	EtfCompany string `json:"etfCompany"`

	// ExpenseRatio Example: 0.0945
	ExpenseRatio float32 `json:"expenseRatio"`

	// HoldingsCount Example: 503
	HoldingsCount int `json:"holdingsCount"`

	// InceptionDate Example: 1993-01-22
	InceptionDate *openapi_types.Date `json:"inceptionDate,omitempty"`

	// IsActivelyTrading Example: true
	IsActivelyTrading bool `json:"isActivelyTrading"`

	// Isin Example: US78462F1030
	Isin string `json:"isin"`

	// Name Example: SPDR S&P 500 ETF Trust
	Name string `json:"name"`

	// Nav Example: 603.64
	Nav float64 `json:"nav"`

	// NavCurrency Example: USD
	NavCurrency string `json:"navCurrency"`
	SectorsList []struct {
		// Exposure Example: 1.97
		Exposure float32 `json:"exposure"`

		// Industry Example: Basic Materials
		Industry string `json:"industry"`
	} `json:"sectorsList"`

	// SecurityCusip Example: 78462F103
	SecurityCusip string `json:"securityCusip"`

	// Symbol Example: SPY
	Symbol string `json:"symbol"`

	// UpdatedAt Example: 2024-12-03T20:32:48.873Z
	UpdatedAt time.Time `json:"updatedAt"`

	// Website Example: https://www.ssga.com/us/en/institutional/etfs/spdr-sp-500-etf-trust-spy
	Website string `json:"website"`
}

ETFProfile defines model for ETFProfile.

type ETFSectorWeight added in v0.1.32 

type ETFSectorWeight struct {
	// Sector Example: Basic Materials
	Sector string `json:"sector"`

	// Symbol Example: SPY
	Symbol string `json:"symbol"`

	// WeightPercentage Example: 1.97
	WeightPercentage float64 `json:"weightPercentage"`
}

ETFSectorWeight defines model for ETFSectorWeight.

type ETFSectorWeightingsGetClientResponse added in v0.1.32 

type ETFSectorWeightingsGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]ETFSectorWeight
}

func ParseETFSectorWeightingsGetClientResponse added in v0.1.32 

func ParseETFSectorWeightingsGetClientResponse(rsp *http.Response) (*ETFSectorWeightingsGetClientResponse, error)

ParseETFSectorWeightingsGetClientResponse parses an HTTP response from a ETFSectorWeightingsGetWithResponse call

func (ETFSectorWeightingsGetClientResponse) ContentType added in v0.1.43 

func (r ETFSectorWeightingsGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ETFSectorWeightingsGetClientResponse) GetBody added in v0.1.43 

func (r ETFSectorWeightingsGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ETFSectorWeightingsGetClientResponse) GetJSON200 added in v0.1.43 

func (r ETFSectorWeightingsGetClientResponse) GetJSON200() *[]ETFSectorWeight

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ETFSectorWeightingsGetClientResponse) Status added in v0.1.32 

func (r ETFSectorWeightingsGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (ETFSectorWeightingsGetClientResponse) StatusCode added in v0.1.32 

func (r ETFSectorWeightingsGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ETFSectorWeightingsGetParams added in v0.1.32 

type ETFSectorWeightingsGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

ETFSectorWeightingsGetParams defines parameters for ETFSectorWeightingsGet.

type ETFSymbol added in v0.1.32 

type ETFSymbol struct {
	// Name Example: WisdomTree Middle East Dividend Fund
	Name *string `json:"name,omitempty"`

	// Symbol Example: GULF
	Symbol *string `json:"symbol,omitempty"`
}

ETFSymbol defines model for ETFSymbol.

type EarningEvent added in v0.1.7 

type EarningEvent struct {
	// Date Example: 2024-11-04
	Date openapi_types.Date `json:"date"`

	// EpsActual Example: 3.32
	EpsActual float64 `json:"epsActual"`

	// EpsEstimated Example: 4.97
	EpsEstimated float64 `json:"epsEstimated"`

	// LastUpdated Example: 2024-12-08
	LastUpdated openapi_types.Date `json:"lastUpdated"`

	// RevenueActual Example: 51133100000
	RevenueActual float64 `json:"revenueActual"`

	// RevenueEstimated Example: 44687400000
	RevenueEstimated float64 `json:"revenueEstimated"`

	// Symbol Example: KEC.NS
	Symbol string `json:"symbol"`
}

EarningEvent defines model for EarningEvent.

type EarningsCalendarGetClientResponse added in v0.1.53 

type EarningsCalendarGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]EarningEvent
}

func ParseEarningsCalendarGetClientResponse added in v0.1.53 

func ParseEarningsCalendarGetClientResponse(rsp *http.Response) (*EarningsCalendarGetClientResponse, error)

ParseEarningsCalendarGetClientResponse parses an HTTP response from a EarningsCalendarGetWithResponse call

func (EarningsCalendarGetClientResponse) ContentType added in v0.1.53 

func (r EarningsCalendarGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (EarningsCalendarGetClientResponse) GetBody added in v0.1.53 

func (r EarningsCalendarGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (EarningsCalendarGetClientResponse) GetJSON200 added in v0.1.53 

func (r EarningsCalendarGetClientResponse) GetJSON200() *[]EarningEvent

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (EarningsCalendarGetClientResponse) Status added in v0.1.53 

func (r EarningsCalendarGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (EarningsCalendarGetClientResponse) StatusCode added in v0.1.53 

func (r EarningsCalendarGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EarningsCalendarGetParams added in v0.1.53 

type EarningsCalendarGetParams struct {
	From *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`
	To   *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`
}

EarningsCalendarGetParams defines parameters for EarningsCalendarGet.

type EarningsGetClientResponse added in v0.1.8 

type EarningsGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]EarningEvent
}

func ParseEarningsGetClientResponse added in v0.1.8 

func ParseEarningsGetClientResponse(rsp *http.Response) (*EarningsGetClientResponse, error)

ParseEarningsGetClientResponse parses an HTTP response from a EarningsGetWithResponse call

func (EarningsGetClientResponse) ContentType added in v0.1.43 

func (r EarningsGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (EarningsGetClientResponse) GetBody added in v0.1.43 

func (r EarningsGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (EarningsGetClientResponse) GetJSON200 added in v0.1.43 

func (r EarningsGetClientResponse) GetJSON200() *[]EarningEvent

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (EarningsGetClientResponse) Status added in v0.1.8 

func (r EarningsGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (EarningsGetClientResponse) StatusCode added in v0.1.8 

func (r EarningsGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EarningsGetParams added in v0.1.8 

type EarningsGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
	Limit  *int   `form:"limit,omitempty" json:"limit,omitempty"`
}

EarningsGetParams defines parameters for EarningsGet.

type EconomicCalendarGetClientResponse 

type EconomicCalendarGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]EconomicEvent
}

func ParseEconomicCalendarGetClientResponse 

func ParseEconomicCalendarGetClientResponse(rsp *http.Response) (*EconomicCalendarGetClientResponse, error)

ParseEconomicCalendarGetClientResponse parses an HTTP response from a EconomicCalendarGetWithResponse call

func (EconomicCalendarGetClientResponse) ContentType added in v0.1.43 

func (r EconomicCalendarGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (EconomicCalendarGetClientResponse) GetBody added in v0.1.43 

func (r EconomicCalendarGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (EconomicCalendarGetClientResponse) GetJSON200 added in v0.1.43 

func (r EconomicCalendarGetClientResponse) GetJSON200() *[]EconomicEvent

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (EconomicCalendarGetClientResponse) Status 

func (r EconomicCalendarGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (EconomicCalendarGetClientResponse) StatusCode 

func (r EconomicCalendarGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EconomicCalendarGetParams 

type EconomicCalendarGetParams struct {
	From *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`
	To   *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`
}

EconomicCalendarGetParams defines parameters for EconomicCalendarGet.

type EconomicEsgDisclosure 

type EconomicEsgDisclosure struct {
	// ESGScore Example: 52.81
	ESGScore float64 `json:"ESGScore"`

	// AcceptedDate Example: 2025-01-30
	AcceptedDate openapi_types.Date `json:"acceptedDate"`

	// Cik Example: 0000320193
	Cik string `json:"cik"`

	// CompanyName Example: Apple Inc.
	CompanyName string `json:"companyName"`

	// Date Example: 2024-12-28
	Date openapi_types.Date `json:"date"`

	// EnvironmentalScore Example: 52.52
	EnvironmentalScore float64 `json:"environmentalScore"`

	// FormType Example: 8-K
	FormType string `json:"formType"`

	// GovernanceScore Example: 60.74
	GovernanceScore float64 `json:"governanceScore"`

	// SocialScore Example: 45.18
	SocialScore float64 `json:"socialScore"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// Url Example: https://www.sec.gov/Archives/edgar/data/320193/000032019325000007/0000320193-25-000007-index.htm
	Url string `json:"url"`
}

EconomicEsgDisclosure defines model for EconomicEsgDisclosure.

type EconomicEsgRating 

type EconomicEsgRating struct {
	// ESGRiskRating Example: B
	ESGRiskRating string `json:"ESGRiskRating"`

	// Cik Example: 0000320193
	Cik string `json:"cik"`

	// CompanyName Example: Apple Inc.
	CompanyName string `json:"companyName"`

	// FiscalYear Example: 2024
	FiscalYear int `json:"fiscalYear"`

	// Industry Example: CONSUMER ELECTRONICS
	Industry string `json:"industry"`

	// IndustryRank Example: 4 out of 5
	IndustryRank string `json:"industryRank"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`
}

EconomicEsgRating defines model for EconomicEsgRating.

type EconomicEvent 

type EconomicEvent struct {
	// Actual Example: -0.096
	Actual *float64 `json:"actual,omitempty"`

	// Change Example: 0.016
	Change *float64 `json:"change,omitempty"`

	// ChangePercentage Example: 14.286
	ChangePercentage float64 `json:"changePercentage"`

	// Country Example: JP
	Country string `json:"country"`

	// Currency Example: JPY
	Currency string `json:"currency"`

	// Date Example: 2024-03-01 03:35:00
	Date     string   `json:"date"`
	Estimate *float64 `json:"estimate,omitempty"`

	// Event Example: 3-Month Bill Auction
	Event string `json:"event"`

	// Impact Example: Low
	Impact string `json:"impact"`

	// Previous Example: -0.112
	Previous *float64 `json:"previous,omitempty"`

	// Unit Example: %
	Unit *string `json:"unit,omitempty"`
}

EconomicEvent defines model for EconomicEvent.

type EnterpriseValue added in v0.1.10 

type EnterpriseValue struct {
	// AddTotalDebt Example: 106629000000
	AddTotalDebt float64 `json:"addTotalDebt"`

	// Date Example: 2024-09-28
	Date openapi_types.Date `json:"date"`

	// EnterpriseValue Example: 3571846329570
	EnterpriseValue float64 `json:"enterpriseValue"`

	// MarketCapitalization Example: 3495160329570
	MarketCapitalization float64 `json:"marketCapitalization"`

	// MinusCashAndCashEquivalents Example: 29943000000
	MinusCashAndCashEquivalents float64 `json:"minusCashAndCashEquivalents"`

	// NumberOfShares Example: 15343783000
	NumberOfShares int `json:"numberOfShares"`

	// StockPrice Example: 227.79
	StockPrice float64 `json:"stockPrice"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`
}

EnterpriseValue defines model for EnterpriseValue.

type EnterpriseValueGetClientResponse added in v0.1.10 

type EnterpriseValueGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]EnterpriseValue
}

func ParseEnterpriseValueGetClientResponse added in v0.1.10 

func ParseEnterpriseValueGetClientResponse(rsp *http.Response) (*EnterpriseValueGetClientResponse, error)

ParseEnterpriseValueGetClientResponse parses an HTTP response from a EnterpriseValueGetWithResponse call

func (EnterpriseValueGetClientResponse) ContentType added in v0.1.43 

func (r EnterpriseValueGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (EnterpriseValueGetClientResponse) GetBody added in v0.1.43 

func (r EnterpriseValueGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (EnterpriseValueGetClientResponse) GetJSON200 added in v0.1.43 

func (r EnterpriseValueGetClientResponse) GetJSON200() *[]EnterpriseValue

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (EnterpriseValueGetClientResponse) Status added in v0.1.10 

func (r EnterpriseValueGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (EnterpriseValueGetClientResponse) StatusCode added in v0.1.10 

func (r EnterpriseValueGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EnterpriseValueGetParams added in v0.1.10 

type EnterpriseValueGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

EnterpriseValueGetParams defines parameters for EnterpriseValueGet.

type ErrorResponse 

type ErrorResponse map[string]interface{}

ErrorResponse defines model for ErrorResponse.

type EsgDisclosuresGetClientResponse 

type EsgDisclosuresGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]EconomicEsgDisclosure
}

func ParseEsgDisclosuresGetClientResponse 

func ParseEsgDisclosuresGetClientResponse(rsp *http.Response) (*EsgDisclosuresGetClientResponse, error)

ParseEsgDisclosuresGetClientResponse parses an HTTP response from a EsgDisclosuresGetWithResponse call

func (EsgDisclosuresGetClientResponse) ContentType added in v0.1.43 

func (r EsgDisclosuresGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (EsgDisclosuresGetClientResponse) GetBody added in v0.1.43 

func (r EsgDisclosuresGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (EsgDisclosuresGetClientResponse) GetJSON200 added in v0.1.43 

func (r EsgDisclosuresGetClientResponse) GetJSON200() *[]EconomicEsgDisclosure

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (EsgDisclosuresGetClientResponse) Status 

func (r EsgDisclosuresGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (EsgDisclosuresGetClientResponse) StatusCode 

func (r EsgDisclosuresGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EsgDisclosuresGetParams 

type EsgDisclosuresGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

EsgDisclosuresGetParams defines parameters for EsgDisclosuresGet.

type EsgRatingsGetClientResponse 

type EsgRatingsGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]EconomicEsgRating
}

func ParseEsgRatingsGetClientResponse 

func ParseEsgRatingsGetClientResponse(rsp *http.Response) (*EsgRatingsGetClientResponse, error)

ParseEsgRatingsGetClientResponse parses an HTTP response from a EsgRatingsGetWithResponse call

func (EsgRatingsGetClientResponse) ContentType added in v0.1.43 

func (r EsgRatingsGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (EsgRatingsGetClientResponse) GetBody added in v0.1.43 

func (r EsgRatingsGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (EsgRatingsGetClientResponse) GetJSON200 added in v0.1.43 

func (r EsgRatingsGetClientResponse) GetJSON200() *[]EconomicEsgRating

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (EsgRatingsGetClientResponse) Status 

func (r EsgRatingsGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (EsgRatingsGetClientResponse) StatusCode 

func (r EsgRatingsGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EsgRatingsGetParams 

type EsgRatingsGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

EsgRatingsGetParams defines parameters for EsgRatingsGet.

type Exchange added in v0.1.4 

type Exchange struct {
	// CountryCode Example: US
	CountryCode string `json:"countryCode"`

	// CountryName Example: United States of America
	CountryName string `json:"countryName"`

	// Delay Example: Real-time
	Delay string `json:"delay"`

	// Exchange Example: AMEX
	Exchange string `json:"exchange"`

	// Name Example: New York Stock Exchange Arca
	Name string `json:"name"`

	// SymbolSuffix Example: N/A
	SymbolSuffix string `json:"symbolSuffix"`
}

Exchange defines model for Exchange.

type FinancialEstimates 

type FinancialEstimates struct {
	// Date Example: 2029-09-28
	Date openapi_types.Date `json:"date"`

	// EbitAvg Example: 140628441297
	EbitAvg float64 `json:"ebitAvg"`

	// EbitHigh Example: 140628586847
	EbitHigh float32 `json:"ebitHigh"`

	// EbitLow Example: 140628295747
	EbitLow float64 `json:"ebitLow"`

	// EbitdaAvg Example: 155952327446
	EbitdaAvg float64 `json:"ebitdaAvg"`

	// EbitdaHigh Example: 155952488856
	EbitdaHigh float64 `json:"ebitdaHigh"`

	// EbitdaLow Example: 155952166036
	EbitdaLow float32 `json:"ebitdaLow"`

	// EpsAvg Example: 9.68
	EpsAvg float64 `json:"epsAvg"`

	// EpsHigh Example: 10.20148
	EpsHigh float64 `json:"epsHigh"`

	// EpsLow Example: 9.05024
	EpsLow float64 `json:"epsLow"`

	// NetIncomeAvg Example: 149150359609
	NetIncomeAvg float64 `json:"netIncomeAvg"`

	// NetIncomeHigh Example: 157185372990
	NetIncomeHigh float32 `json:"netIncomeHigh"`

	// NetIncomeLow Example: 139446957701
	NetIncomeLow float64 `json:"netIncomeLow"`

	// NumAnalystsEps Example: 6
	NumAnalystsEps int `json:"numAnalystsEps"`

	// NumAnalystsRevenue Example: 16
	NumAnalystsRevenue int `json:"numAnalystsRevenue"`

	// RevenueAvg Example: 483093000000
	RevenueAvg float64 `json:"revenueAvg"`

	// RevenueHigh Example: 483093500000
	RevenueHigh float64 `json:"revenueHigh"`

	// RevenueLow Example: 483092500000
	RevenueLow float64 `json:"revenueLow"`

	// SgaExpenseAvg Example: 31694685616
	SgaExpenseAvg float64 `json:"sgaExpenseAvg"`

	// SgaExpenseHigh Example: 31694718420
	SgaExpenseHigh float64 `json:"sgaExpenseHigh"`

	// SgaExpenseLow Example: 31694652812
	SgaExpenseLow float64 `json:"sgaExpenseLow"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`
}

FinancialEstimates defines model for FinancialEstimates.

type FinancialRatios 

type FinancialRatios struct {
	// AssetTurnover Example: 1.0713874732862074
	AssetTurnover float64 `json:"assetTurnover"`

	// BookValuePerShare Example: 3.711600978715614
	BookValuePerShare float64 `json:"bookValuePerShare"`

	// BottomLineProfitMargin Example: 0.23971255769943867
	BottomLineProfitMargin float64 `json:"bottomLineProfitMargin"`

	// CapexPerShare Example: 0.6156891035281195
	CapexPerShare float64 `json:"capexPerShare"`

	// CapitalExpenditureCoverageRatio Example: 12.517624642743728
	CapitalExpenditureCoverageRatio float64 `json:"capitalExpenditureCoverageRatio"`

	// CashPerShare Example: 4.247388013764271
	CashPerShare float64 `json:"cashPerShare"`

	// CashRatio Example: 0.16975259648963673
	CashRatio float64 `json:"cashRatio"`

	// ContinuousOperationsProfitMargin Example: 0.23971255769943867
	ContinuousOperationsProfitMargin float64 `json:"continuousOperationsProfitMargin"`

	// CurrentRatio Example: 0.8673125765340832
	CurrentRatio float64 `json:"currentRatio"`

	// Date Example: 2024-09-28
	Date openapi_types.Date `json:"date"`

	// DebtServiceCoverageRatio Example: 5.024761722304708
	DebtServiceCoverageRatio float64 `json:"debtServiceCoverageRatio"`

	// DebtToAssetsRatio Example: 0.29215025480848267
	DebtToAssetsRatio float64 `json:"debtToAssetsRatio"`

	// DebtToCapitalRatio Example: 0.6518501763673821
	DebtToCapitalRatio float64 `json:"debtToCapitalRatio"`

	// DebtToEquityRatio Example: 1.872326602282704
	DebtToEquityRatio float64 `json:"debtToEquityRatio"`

	// DebtToMarketCap Example: 0.03050761336980449
	DebtToMarketCap float64 `json:"debtToMarketCap"`

	// DividendPaidAndCapexCoverageRatio Example: 4.7912969490701345
	DividendPaidAndCapexCoverageRatio float64 `json:"dividendPaidAndCapexCoverageRatio"`

	// DividendPayoutRatio Example: 0.16252026969360758
	DividendPayoutRatio float64 `json:"dividendPayoutRatio"`

	// DividendPerShare Example: 1.0316085225942402
	DividendPerShare float64 `json:"dividendPerShare"`

	// DividendYield Example: 0.0043585983369965175
	DividendYield float64 `json:"dividendYield"`

	// DividendYieldPercentage Example: 0.43585983369965176
	DividendYieldPercentage float64 `json:"dividendYieldPercentage"`

	// EbitMargin Example: 0.31510222870075566
	EbitMargin float64 `json:"ebitMargin"`

	// EbitdaMargin Example: 0.3443707085043538
	EbitdaMargin float64 `json:"ebitdaMargin"`

	// EbtPerEbit Example: 1.0021831580314244
	EbtPerEbit float64 `json:"ebtPerEbit"`

	// EffectiveTaxRate Example: 0.24091185164189982
	EffectiveTaxRate float64 `json:"effectiveTaxRate"`

	// EnterpriseValueMultiple Example: 26.524727497716487
	EnterpriseValueMultiple float64 `json:"enterpriseValueMultiple"`

	// FinancialLeverageRatio Example: 6.408779631255487
	FinancialLeverageRatio float64 `json:"financialLeverageRatio"`

	// FiscalYear Example: 2024
	FiscalYear string `json:"fiscalYear"`

	// FixedAssetTurnover Example: 8.560310858143607
	FixedAssetTurnover float64 `json:"fixedAssetTurnover"`

	// ForwardPriceToEarningsGrowthRatio Example: -45.93792700808932
	ForwardPriceToEarningsGrowthRatio float64 `json:"forwardPriceToEarningsGrowthRatio"`

	// FreeCashFlowOperatingCashFlowRatio Example: 0.9201126388959359
	FreeCashFlowOperatingCashFlowRatio float64 `json:"freeCashFlowOperatingCashFlowRatio"`

	// FreeCashFlowPerShare Example: 7.091275991064264
	FreeCashFlowPerShare float64 `json:"freeCashFlowPerShare"`

	// GrossProfitMargin Example: 0.4620634981523393
	GrossProfitMargin float64 `json:"grossProfitMargin"`

	// InterestCoverageRatio Example: 0
	InterestCoverageRatio float64 `json:"interestCoverageRatio"`

	// InterestDebtPerShare Example: 6.949329249507765
	InterestDebtPerShare float64 `json:"interestDebtPerShare"`

	// InventoryTurnover Example: 28.870710952511665
	InventoryTurnover float64 `json:"inventoryTurnover"`

	// LongTermDebtToCapitalRatio Example: 0.6009110021023125
	LongTermDebtToCapitalRatio float64 `json:"longTermDebtToCapitalRatio"`

	// NetIncomePerEBT Example: 0.7590881483581001
	NetIncomePerEBT float64 `json:"netIncomePerEBT"`

	// NetIncomePerShare Example: 6.109054070954992
	NetIncomePerShare float64 `json:"netIncomePerShare"`

	// NetProfitMargin Example: 0.23971255769943867
	NetProfitMargin float64 `json:"netProfitMargin"`

	// OperatingCashFlowCoverageRatio Example: 1.109022873702276
	OperatingCashFlowCoverageRatio float64 `json:"operatingCashFlowCoverageRatio"`

	// OperatingCashFlowPerShare Example: 7.706965094592383
	OperatingCashFlowPerShare float64 `json:"operatingCashFlowPerShare"`

	// OperatingCashFlowRatio Example: 0.6704045534944896
	OperatingCashFlowRatio float64 `json:"operatingCashFlowRatio"`

	// OperatingCashFlowSalesRatio Example: 0.3024128274962599
	OperatingCashFlowSalesRatio float64 `json:"operatingCashFlowSalesRatio"`

	// OperatingProfitMargin Example: 0.31510222870075566
	OperatingProfitMargin float64 `json:"operatingProfitMargin"`

	// PayablesTurnover Example: 3.0503480278422272
	PayablesTurnover float64 `json:"payablesTurnover"`

	// Period Example: FY
	Period string `json:"period"`

	// PretaxProfitMargin Example: 0.3157901466620635
	PretaxProfitMargin float64 `json:"pretaxProfitMargin"`

	// PriceToBookRatio Example: 61.37243774486391
	PriceToBookRatio float64 `json:"priceToBookRatio"`

	// PriceToEarningsGrowthRatio Example: -45.93792700808932
	PriceToEarningsGrowthRatio float64 `json:"priceToEarningsGrowthRatio"`

	// PriceToEarningsRatio Example: 37.287278415656736
	PriceToEarningsRatio float64 `json:"priceToEarningsRatio"`

	// PriceToFairValue Example: 61.37243774486391
	PriceToFairValue float64 `json:"priceToFairValue"`

	// PriceToFreeCashFlowRatio Example: 32.12256867269569
	PriceToFreeCashFlowRatio float64 `json:"priceToFreeCashFlowRatio"`

	// PriceToOperatingCashFlowRatio Example: 29.55638142954995
	PriceToOperatingCashFlowRatio float64 `json:"priceToOperatingCashFlowRatio"`

	// PriceToSalesRatio Example: 8.93822887866815
	PriceToSalesRatio float64 `json:"priceToSalesRatio"`

	// QuickRatio Example: 0.8260068483831466
	QuickRatio float64 `json:"quickRatio"`

	// ReceivablesTurnover Example: 5.903038811648023
	ReceivablesTurnover float64 `json:"receivablesTurnover"`

	// ReportedCurrency Example: USD
	ReportedCurrency string `json:"reportedCurrency"`

	// RevenuePerShare Example: 25.484914639368924
	RevenuePerShare float64 `json:"revenuePerShare"`

	// ShareholdersEquityPerShare Example: 3.711600978715614
	ShareholdersEquityPerShare float64 `json:"shareholdersEquityPerShare"`

	// ShortTermOperatingCashFlowCoverageRatio Example: 5.663777000814215
	ShortTermOperatingCashFlowCoverageRatio float64 `json:"shortTermOperatingCashFlowCoverageRatio"`

	// SolvencyRatio Example: 0.3414634938155374
	SolvencyRatio float64 `json:"solvencyRatio"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// TangibleBookValuePerShare Example: 3.711600978715614
	TangibleBookValuePerShare float64 `json:"tangibleBookValuePerShare"`

	// WorkingCapitalTurnoverRatio Example: -31.099932397502684
	WorkingCapitalTurnoverRatio float64 `json:"workingCapitalTurnoverRatio"`
}

FinancialRatios defines model for FinancialRatios.

type ForexCurrencyPair added in v0.1.34 

type ForexCurrencyPair struct {
	// FromCurrency Example: EUR
	FromCurrency string `json:"fromCurrency"`

	// FromName Example: Euro
	FromName string `json:"fromName"`

	// Symbol Example: EURUSD
	Symbol string `json:"symbol"`

	// ToCurrency Example: USD
	ToCurrency string `json:"toCurrency"`

	// ToName Example: US Dollar
	ToName string `json:"toName"`
}

ForexCurrencyPair defines model for ForexCurrencyPair.

type ForexCurrencyPairsGetClientResponse added in v0.1.34 

type ForexCurrencyPairsGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]ForexCurrencyPair
}

func ParseForexCurrencyPairsGetClientResponse added in v0.1.34 

func ParseForexCurrencyPairsGetClientResponse(rsp *http.Response) (*ForexCurrencyPairsGetClientResponse, error)

ParseForexCurrencyPairsGetClientResponse parses an HTTP response from a ForexCurrencyPairsGetWithResponse call

func (ForexCurrencyPairsGetClientResponse) ContentType added in v0.1.43 

func (r ForexCurrencyPairsGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ForexCurrencyPairsGetClientResponse) GetBody added in v0.1.43 

func (r ForexCurrencyPairsGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ForexCurrencyPairsGetClientResponse) GetJSON200 added in v0.1.43 

func (r ForexCurrencyPairsGetClientResponse) GetJSON200() *[]ForexCurrencyPair

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ForexCurrencyPairsGetClientResponse) Status added in v0.1.34 

func (r ForexCurrencyPairsGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (ForexCurrencyPairsGetClientResponse) StatusCode added in v0.1.34 

func (r ForexCurrencyPairsGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FullCandle 

type FullCandle struct {
	// Change Example: 5.6
	Change float64 `json:"change"`

	// ChangePercent Example: 2.46479
	ChangePercent float64 `json:"changePercent"`

	// Close Example: 232.8
	Close float64 `json:"close"`

	// Date Example: 2025-02-04
	Date openapi_types.Date `json:"date"`

	// High Example: 233.13
	High float64 `json:"high"`

	// Low Example: 226.65
	Low float64 `json:"low"`

	// Open Example: 227.2
	Open float64 `json:"open"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// Volume Example: 44489128
	Volume float64 `json:"volume"`

	// Vwap Example: 230.86
	Vwap float64 `json:"vwap"`
}

FullCandle defines model for FullCandle.

type FullQuote 

type FullQuote struct {
	// Change Example: 4.79
	Change float64 `json:"change"`

	// ChangePercentage Example: 2.1008
	ChangePercentage float64 `json:"changePercentage"`

	// DayHigh Example: 233.13
	DayHigh float64 `json:"dayHigh"`

	// DayLow Example: 226.65
	DayLow float64 `json:"dayLow"`

	// Exchange Example: NASDAQ
	Exchange string `json:"exchange"`

	// MarketCap Example: 3500823120000
	MarketCap float64 `json:"marketCap"`

	// Name Example: Apple Inc.
	Name string `json:"name"`

	// Open Example: 227.2
	Open float64 `json:"open"`

	// PreviousClose Example: 228.01
	PreviousClose float64 `json:"previousClose"`

	// Price Example: 232.8
	Price float64 `json:"price"`

	// PriceAvg200 Example: 219.98755
	PriceAvg200 float64 `json:"priceAvg200"`

	// PriceAvg50 Example: 240.2278
	PriceAvg50 float64 `json:"priceAvg50"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// Timestamp Example: 1738702801
	Timestamp int `json:"timestamp"`

	// Volume Example: 44489128
	Volume float64 `json:"volume"`

	// YearHigh Example: 260.1
	YearHigh float64 `json:"yearHigh"`

	// YearLow Example: 164.08
	YearLow float64 `json:"yearLow"`
}

FullQuote defines model for FullQuote.

type GradeNews added in v0.1.9 

type GradeNews struct {
	// Action Example: hold
	Action string `json:"action"`

	// GradingCompany Example: J.P. Morgan
	GradingCompany string `json:"gradingCompany"`

	// NewGrade Example: Overweight
	NewGrade string `json:"newGrade"`

	// NewsBaseURL Example: benzinga.com
	NewsBaseURL string `json:"newsBaseURL"`

	// NewsPublisher Example: Benzinga
	NewsPublisher string `json:"newsPublisher"`

	// NewsTitle Example: PayPal Transaction Margins and Payment Volume Drive Growth, Eyes 2025 Growth With Strong TMD Ahead of Investor Day: Analyst
	NewsTitle string `json:"newsTitle"`

	// NewsURL Example: https://www.benzinga.com/25/02/43475080/paypal-beats-q4-estimates-as-transaction-margins-and-payment-volume-drive-growth-eyes-2025-growth-with-strong-tmd
	NewsURL string `json:"newsURL"`

	// PreviousGrade Example: Overweight
	PreviousGrade string `json:"previousGrade"`

	// PriceWhenPosted Example: 77.725
	PriceWhenPosted float32 `json:"priceWhenPosted"`

	// PublishedDate Example: 2025-02-04T19:18:04.000Z
	PublishedDate time.Time `json:"publishedDate"`

	// Symbol Example: PYPL
	Symbol string `json:"symbol"`
}

GradeNews defines model for GradeNews.

type GradesLatestNewsGetClientResponse 

type GradesLatestNewsGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]GradeNews
}

func ParseGradesLatestNewsGetClientResponse 

func ParseGradesLatestNewsGetClientResponse(rsp *http.Response) (*GradesLatestNewsGetClientResponse, error)

ParseGradesLatestNewsGetClientResponse parses an HTTP response from a GradesLatestNewsGetWithResponse call

func (GradesLatestNewsGetClientResponse) ContentType added in v0.1.43 

func (r GradesLatestNewsGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GradesLatestNewsGetClientResponse) GetBody added in v0.1.43 

func (r GradesLatestNewsGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GradesLatestNewsGetClientResponse) GetJSON200 added in v0.1.43 

func (r GradesLatestNewsGetClientResponse) GetJSON200() *[]GradeNews

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GradesLatestNewsGetClientResponse) Status 

func (r GradesLatestNewsGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (GradesLatestNewsGetClientResponse) StatusCode 

func (r GradesLatestNewsGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GradesLatestNewsGetParams 

type GradesLatestNewsGetParams struct {
	Page  *int `form:"page,omitempty" json:"page,omitempty"`
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}

GradesLatestNewsGetParams defines parameters for GradesLatestNewsGet.

type HistoricalChart15MinGetClientResponse added in v0.1.28 

type HistoricalChart15MinGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]DetailedCandle
}

func ParseHistoricalChart15MinGetClientResponse added in v0.1.28 

func ParseHistoricalChart15MinGetClientResponse(rsp *http.Response) (*HistoricalChart15MinGetClientResponse, error)

ParseHistoricalChart15MinGetClientResponse parses an HTTP response from a HistoricalChart15MinGetWithResponse call

func (HistoricalChart15MinGetClientResponse) ContentType added in v0.1.43 

func (r HistoricalChart15MinGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (HistoricalChart15MinGetClientResponse) GetBody added in v0.1.43 

func (r HistoricalChart15MinGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (HistoricalChart15MinGetClientResponse) GetJSON200 added in v0.1.43 

func (r HistoricalChart15MinGetClientResponse) GetJSON200() *[]DetailedCandle

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (HistoricalChart15MinGetClientResponse) Status added in v0.1.28 

func (r HistoricalChart15MinGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (HistoricalChart15MinGetClientResponse) StatusCode added in v0.1.28 

func (r HistoricalChart15MinGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HistoricalChart15MinGetParams added in v0.1.28 

type HistoricalChart15MinGetParams struct {
	Symbol      string              `form:"symbol" json:"symbol"`
	From        *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`
	To          *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`
	Nonadjusted *bool               `form:"nonadjusted,omitempty" json:"nonadjusted,omitempty"`
}

HistoricalChart15MinGetParams defines parameters for HistoricalChart15MinGet.

type HistoricalPriceEodFullGetClientResponse 

type HistoricalPriceEodFullGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]FullCandle
}

func ParseHistoricalPriceEodFullGetClientResponse 

func ParseHistoricalPriceEodFullGetClientResponse(rsp *http.Response) (*HistoricalPriceEodFullGetClientResponse, error)

ParseHistoricalPriceEodFullGetClientResponse parses an HTTP response from a HistoricalPriceEodFullGetWithResponse call

func (HistoricalPriceEodFullGetClientResponse) ContentType added in v0.1.43 

func (r HistoricalPriceEodFullGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (HistoricalPriceEodFullGetClientResponse) GetBody added in v0.1.43 

func (r HistoricalPriceEodFullGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (HistoricalPriceEodFullGetClientResponse) GetJSON200 added in v0.1.43 

func (r HistoricalPriceEodFullGetClientResponse) GetJSON200() *[]FullCandle

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (HistoricalPriceEodFullGetClientResponse) Status 

func (r HistoricalPriceEodFullGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (HistoricalPriceEodFullGetClientResponse) StatusCode 

func (r HistoricalPriceEodFullGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HistoricalPriceEodFullGetParams 

type HistoricalPriceEodFullGetParams struct {
	Symbol string              `form:"symbol" json:"symbol"`
	From   *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`
	To     *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`
}

HistoricalPriceEodFullGetParams defines parameters for HistoricalPriceEodFullGet.

type HistoricalPriceEodLightGetClientResponse 

type HistoricalPriceEodLightGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]LightCandle
}

func ParseHistoricalPriceEodLightGetClientResponse 

func ParseHistoricalPriceEodLightGetClientResponse(rsp *http.Response) (*HistoricalPriceEodLightGetClientResponse, error)

ParseHistoricalPriceEodLightGetClientResponse parses an HTTP response from a HistoricalPriceEodLightGetWithResponse call

func (HistoricalPriceEodLightGetClientResponse) ContentType added in v0.1.43 

func (r HistoricalPriceEodLightGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (HistoricalPriceEodLightGetClientResponse) GetBody added in v0.1.43 

func (r HistoricalPriceEodLightGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (HistoricalPriceEodLightGetClientResponse) GetJSON200 added in v0.1.43 

func (r HistoricalPriceEodLightGetClientResponse) GetJSON200() *[]LightCandle

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (HistoricalPriceEodLightGetClientResponse) Status 

func (r HistoricalPriceEodLightGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (HistoricalPriceEodLightGetClientResponse) StatusCode 

func (r HistoricalPriceEodLightGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HistoricalPriceEodLightGetParams 

type HistoricalPriceEodLightGetParams struct {
	Symbol string              `form:"symbol" json:"symbol"`
	From   *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`
	To     *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`
}

HistoricalPriceEodLightGetParams defines parameters for HistoricalPriceEodLightGet.

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type IncomeStatement 

type IncomeStatement struct {
	// AcceptedDate Example: 2024-11-01 06:01:36
	AcceptedDate string `json:"acceptedDate"`

	// BottomLineNetIncome Example: 93736000000
	BottomLineNetIncome float64 `json:"bottomLineNetIncome"`

	// Cik Example: 0000320193
	Cik string `json:"cik"`

	// CostAndExpenses Example: 267819000000
	CostAndExpenses float64 `json:"costAndExpenses"`

	// CostOfRevenue Example: 210352000000
	CostOfRevenue float64 `json:"costOfRevenue"`

	// Date Example: 2024-09-28
	Date openapi_types.Date `json:"date"`

	// DepreciationAndAmortization Example: 11445000000
	DepreciationAndAmortization float64 `json:"depreciationAndAmortization"`

	// Ebit Example: 123216000000
	Ebit float64 `json:"ebit"`

	// Ebitda Example: 134661000000
	Ebitda float64 `json:"ebitda"`

	// Eps Example: 6.11
	Eps float64 `json:"eps"`

	// EpsDiluted Example: 6.08
	EpsDiluted float64 `json:"epsDiluted"`

	// FilingDate Example: 2024-11-01
	FilingDate openapi_types.Date `json:"filingDate"`

	// FiscalYear Example: 2024
	FiscalYear string `json:"fiscalYear"`

	// GeneralAndAdministrativeExpenses Example: 0
	GeneralAndAdministrativeExpenses float64 `json:"generalAndAdministrativeExpenses"`

	// GrossProfit Example: 180683000000
	GrossProfit float64 `json:"grossProfit"`

	// IncomeBeforeTax Example: 123485000000
	IncomeBeforeTax float64 `json:"incomeBeforeTax"`

	// IncomeTaxExpense Example: 29749000000
	IncomeTaxExpense float64 `json:"incomeTaxExpense"`

	// InterestExpense Example: 0
	InterestExpense float64 `json:"interestExpense"`

	// InterestIncome Example: 0
	InterestIncome float64 `json:"interestIncome"`

	// NetIncome Example: 93736000000
	NetIncome float64 `json:"netIncome"`

	// NetIncomeDeductions Example: 0
	NetIncomeDeductions float64 `json:"netIncomeDeductions"`

	// NetIncomeFromContinuingOperations Example: 93736000000
	NetIncomeFromContinuingOperations float64 `json:"netIncomeFromContinuingOperations"`

	// NetIncomeFromDiscontinuedOperations Example: 0
	NetIncomeFromDiscontinuedOperations float64 `json:"netIncomeFromDiscontinuedOperations"`

	// NetInterestIncome Example: 0
	NetInterestIncome float64 `json:"netInterestIncome"`

	// NonOperatingIncomeExcludingInterest Example: 0
	NonOperatingIncomeExcludingInterest float64 `json:"nonOperatingIncomeExcludingInterest"`

	// OperatingExpenses Example: 57467000000
	OperatingExpenses float64 `json:"operatingExpenses"`

	// OperatingIncome Example: 123216000000
	OperatingIncome float64 `json:"operatingIncome"`

	// OtherAdjustmentsToNetIncome Example: 0
	OtherAdjustmentsToNetIncome float64 `json:"otherAdjustmentsToNetIncome"`

	// OtherExpenses Example: 0
	OtherExpenses float64 `json:"otherExpenses"`

	// Period Example: FY
	Period string `json:"period"`

	// ReportedCurrency Example: USD
	ReportedCurrency string `json:"reportedCurrency"`

	// ResearchAndDevelopmentExpenses Example: 31370000000
	ResearchAndDevelopmentExpenses float64 `json:"researchAndDevelopmentExpenses"`

	// Revenue Example: 391035000000
	Revenue float64 `json:"revenue"`

	// SellingAndMarketingExpenses Example: 0
	SellingAndMarketingExpenses float64 `json:"sellingAndMarketingExpenses"`

	// SellingGeneralAndAdministrativeExpenses Example: 26097000000
	SellingGeneralAndAdministrativeExpenses float64 `json:"sellingGeneralAndAdministrativeExpenses"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// TotalOtherIncomeExpensesNet Example: 269000000
	TotalOtherIncomeExpensesNet float64 `json:"totalOtherIncomeExpensesNet"`

	// WeightedAverageShsOut Example: 15343783000
	WeightedAverageShsOut float64 `json:"weightedAverageShsOut"`

	// WeightedAverageShsOutDil Example: 15408095000
	WeightedAverageShsOutDil float64 `json:"weightedAverageShsOutDil"`
}

IncomeStatement defines model for IncomeStatement.

type IncomeStatementBulkGetClientResponse added in v0.1.29 

type IncomeStatementBulkGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseIncomeStatementBulkGetClientResponse added in v0.1.29 

func ParseIncomeStatementBulkGetClientResponse(rsp *http.Response) (*IncomeStatementBulkGetClientResponse, error)

ParseIncomeStatementBulkGetClientResponse parses an HTTP response from a IncomeStatementBulkGetWithResponse call

func (IncomeStatementBulkGetClientResponse) ContentType added in v0.1.43 

func (r IncomeStatementBulkGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (IncomeStatementBulkGetClientResponse) GetBody added in v0.1.43 

func (r IncomeStatementBulkGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (IncomeStatementBulkGetClientResponse) Status added in v0.1.29 

func (r IncomeStatementBulkGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (IncomeStatementBulkGetClientResponse) StatusCode added in v0.1.29 

func (r IncomeStatementBulkGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type IncomeStatementBulkGetParams added in v0.1.29 

type IncomeStatementBulkGetParams struct {
	Period Period `form:"period" json:"period"`
	Year   int    `form:"year" json:"year"`
}

IncomeStatementBulkGetParams defines parameters for IncomeStatementBulkGet.

type IncomeStatementGetClientResponse 

type IncomeStatementGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]IncomeStatement
}

func ParseIncomeStatementGetClientResponse 

func ParseIncomeStatementGetClientResponse(rsp *http.Response) (*IncomeStatementGetClientResponse, error)

ParseIncomeStatementGetClientResponse parses an HTTP response from a IncomeStatementGetWithResponse call

func (IncomeStatementGetClientResponse) ContentType added in v0.1.43 

func (r IncomeStatementGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (IncomeStatementGetClientResponse) GetBody added in v0.1.43 

func (r IncomeStatementGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (IncomeStatementGetClientResponse) GetJSON200 added in v0.1.43 

func (r IncomeStatementGetClientResponse) GetJSON200() *[]IncomeStatement

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (IncomeStatementGetClientResponse) Status 

func (r IncomeStatementGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (IncomeStatementGetClientResponse) StatusCode 

func (r IncomeStatementGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type IncomeStatementGetParams 

type IncomeStatementGetParams struct {
	Symbol string  `form:"symbol" json:"symbol"`
	Limit  *int    `form:"limit,omitempty" json:"limit,omitempty"`
	Period *Period `form:"period,omitempty" json:"period,omitempty"`
}

IncomeStatementGetParams defines parameters for IncomeStatementGet.

type IncomeStatementTTM added in v0.1.11 

type IncomeStatementTTM struct {
	// AcceptedDate Example: 2025-01-31 06:01:27
	AcceptedDate string `json:"acceptedDate"`

	// BottomLineNetIncome Example: 96150000000
	BottomLineNetIncome float64 `json:"bottomLineNetIncome"`

	// Cik Example: 0000320193
	Cik string `json:"cik"`

	// CostAndExpenses Example: 270085000000
	CostAndExpenses float64 `json:"costAndExpenses"`

	// CostOfRevenue Example: 211657000000
	CostOfRevenue float64 `json:"costOfRevenue"`

	// Date Example: 2024-12-28
	Date openapi_types.Date `json:"date"`

	// DepreciationAndAmortization Example: 11677000000
	DepreciationAndAmortization float64 `json:"depreciationAndAmortization"`

	// Ebit Example: 125675000000
	Ebit float64 `json:"ebit"`

	// Ebitda Example: 137352000000
	Ebitda float64 `json:"ebitda"`

	// Eps Example: 6.31
	Eps float64 `json:"eps"`

	// EpsDiluted Example: 6.3
	EpsDiluted float64 `json:"epsDiluted"`

	// FilingDate Example: 2025-01-31
	FilingDate openapi_types.Date `json:"filingDate"`

	// FiscalYear Example: 2025
	FiscalYear string `json:"fiscalYear"`

	// GeneralAndAdministrativeExpenses Example: 0
	GeneralAndAdministrativeExpenses float64 `json:"generalAndAdministrativeExpenses"`

	// GrossProfit Example: 184103000000
	GrossProfit float64 `json:"grossProfit"`

	// IncomeBeforeTax Example: 125746000000
	IncomeBeforeTax float64 `json:"incomeBeforeTax"`

	// IncomeTaxExpense Example: 29596000000
	IncomeTaxExpense float64 `json:"incomeTaxExpense"`

	// InterestExpense Example: 0
	InterestExpense float64 `json:"interestExpense"`

	// InterestIncome Example: 0
	InterestIncome float64 `json:"interestIncome"`

	// NetIncome Example: 96150000000
	NetIncome float64 `json:"netIncome"`

	// NetIncomeDeductions Example: 0
	NetIncomeDeductions float64 `json:"netIncomeDeductions"`

	// NetIncomeFromContinuingOperations Example: 96150000000
	NetIncomeFromContinuingOperations float64 `json:"netIncomeFromContinuingOperations"`

	// NetIncomeFromDiscontinuedOperations Example: 0
	NetIncomeFromDiscontinuedOperations float64 `json:"netIncomeFromDiscontinuedOperations"`

	// NetInterestIncome Example: 0
	NetInterestIncome float64 `json:"netInterestIncome"`

	// NonOperatingIncomeExcludingInterest Example: 0
	NonOperatingIncomeExcludingInterest float64 `json:"nonOperatingIncomeExcludingInterest"`

	// OperatingExpenses Example: 58428000000
	OperatingExpenses float64 `json:"operatingExpenses"`

	// OperatingIncome Example: 125675000000
	OperatingIncome float64 `json:"operatingIncome"`

	// OtherAdjustmentsToNetIncome Example: 0
	OtherAdjustmentsToNetIncome float64 `json:"otherAdjustmentsToNetIncome"`

	// OtherExpenses Example: 0
	OtherExpenses float64 `json:"otherExpenses"`

	// Period Example: Q1
	Period string `json:"period"`

	// ReportedCurrency Example: USD
	ReportedCurrency string `json:"reportedCurrency"`

	// ResearchAndDevelopmentExpenses Example: 31942000000
	ResearchAndDevelopmentExpenses float64 `json:"researchAndDevelopmentExpenses"`

	// Revenue Example: 395760000000
	Revenue float64 `json:"revenue"`

	// SellingAndMarketingExpenses Example: 0
	SellingAndMarketingExpenses float64 `json:"sellingAndMarketingExpenses"`

	// SellingGeneralAndAdministrativeExpenses Example: 26486000000
	SellingGeneralAndAdministrativeExpenses float64 `json:"sellingGeneralAndAdministrativeExpenses"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// TotalOtherIncomeExpensesNet Example: 71000000
	TotalOtherIncomeExpensesNet float64 `json:"totalOtherIncomeExpensesNet"`

	// WeightedAverageShsOut Example: 15081724000
	WeightedAverageShsOut float64 `json:"weightedAverageShsOut"`

	// WeightedAverageShsOutDil Example: 15150865000
	WeightedAverageShsOutDil float64 `json:"weightedAverageShsOutDil"`
}

IncomeStatementTTM defines model for IncomeStatementTTM.

type IncomeStatementTTMGetClientResponse added in v0.1.11 

type IncomeStatementTTMGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]IncomeStatementTTM
}

func ParseIncomeStatementTTMGetClientResponse added in v0.1.11 

func ParseIncomeStatementTTMGetClientResponse(rsp *http.Response) (*IncomeStatementTTMGetClientResponse, error)

ParseIncomeStatementTTMGetClientResponse parses an HTTP response from a IncomeStatementTTMGetWithResponse call

func (IncomeStatementTTMGetClientResponse) ContentType added in v0.1.43 

func (r IncomeStatementTTMGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (IncomeStatementTTMGetClientResponse) GetBody added in v0.1.43 

func (r IncomeStatementTTMGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (IncomeStatementTTMGetClientResponse) GetJSON200 added in v0.1.43 

func (r IncomeStatementTTMGetClientResponse) GetJSON200() *[]IncomeStatementTTM

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (IncomeStatementTTMGetClientResponse) Status added in v0.1.11 

func (r IncomeStatementTTMGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (IncomeStatementTTMGetClientResponse) StatusCode added in v0.1.11 

func (r IncomeStatementTTMGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type IncomeStatementTTMGetParams added in v0.1.11 

type IncomeStatementTTMGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
	Limit  *int   `form:"limit,omitempty" json:"limit,omitempty"`
}

IncomeStatementTTMGetParams defines parameters for IncomeStatementTTMGet.

type Index added in v0.1.30 

type Index struct {
	// Currency Example: CAD
	Currency string `json:"currency"`

	// Exchange Example: TSX
	Exchange string `json:"exchange"`

	// Name Example: S&P/TSX Capped Industrials Index
	Name string `json:"name"`

	// Symbol Example: ^TTIN
	Symbol string `json:"symbol"`
}

Index defines model for Index.

type IndexConstituent added in v0.1.36 

type IndexConstituent struct {
	Cik            string  `json:"cik"`
	DateFirstAdded *string `json:"dateFirstAdded,omitempty"`
	Founded        *string `json:"founded,omitempty"`
	HeadQuarter    string  `json:"headQuarter"`
	Name           string  `json:"name"`
	Sector         string  `json:"sector"`
	SubSector      string  `json:"subSector"`
	Symbol         string  `json:"symbol"`
}

IndexConstituent defines model for IndexConstituent.

type IndexConstituentListGetClientResponse added in v0.1.36 

type IndexConstituentListGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]IndexConstituent
}

func ParseIndexConstituentListGetClientResponse added in v0.1.36 

func ParseIndexConstituentListGetClientResponse(rsp *http.Response) (*IndexConstituentListGetClientResponse, error)

ParseIndexConstituentListGetClientResponse parses an HTTP response from a IndexConstituentListGetWithResponse call

func (IndexConstituentListGetClientResponse) ContentType added in v0.1.43 

func (r IndexConstituentListGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (IndexConstituentListGetClientResponse) GetBody added in v0.1.43 

func (r IndexConstituentListGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (IndexConstituentListGetClientResponse) GetJSON200 added in v0.1.43 

func (r IndexConstituentListGetClientResponse) GetJSON200() *[]IndexConstituent

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (IndexConstituentListGetClientResponse) Status added in v0.1.36 

func (r IndexConstituentListGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (IndexConstituentListGetClientResponse) StatusCode added in v0.1.36 

func (r IndexConstituentListGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type IndexConstituentListGetParams added in v0.1.36 

type IndexConstituentListGetParams struct {
	Type string `form:"type" json:"type"`
}

IndexConstituentListGetParams defines parameters for IndexConstituentListGet.

type IndexListGetClientResponse added in v0.1.30 

type IndexListGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]Index
}

func ParseIndexListGetClientResponse added in v0.1.30 

func ParseIndexListGetClientResponse(rsp *http.Response) (*IndexListGetClientResponse, error)

ParseIndexListGetClientResponse parses an HTTP response from a IndexListGetWithResponse call

func (IndexListGetClientResponse) ContentType added in v0.1.43 

func (r IndexListGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (IndexListGetClientResponse) GetBody added in v0.1.43 

func (r IndexListGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (IndexListGetClientResponse) GetJSON200 added in v0.1.43 

func (r IndexListGetClientResponse) GetJSON200() *[]Index

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (IndexListGetClientResponse) Status added in v0.1.30 

func (r IndexListGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (IndexListGetClientResponse) StatusCode added in v0.1.30 

func (r IndexListGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InsiderTradingLatestGetClientResponse 

type InsiderTradingLatestGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]InsiderTransaction
}

func ParseInsiderTradingLatestGetClientResponse 

func ParseInsiderTradingLatestGetClientResponse(rsp *http.Response) (*InsiderTradingLatestGetClientResponse, error)

ParseInsiderTradingLatestGetClientResponse parses an HTTP response from a InsiderTradingLatestGetWithResponse call

func (InsiderTradingLatestGetClientResponse) ContentType added in v0.1.43 

func (r InsiderTradingLatestGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (InsiderTradingLatestGetClientResponse) GetBody added in v0.1.43 

func (r InsiderTradingLatestGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (InsiderTradingLatestGetClientResponse) GetJSON200 added in v0.1.43 

func (r InsiderTradingLatestGetClientResponse) GetJSON200() *[]InsiderTransaction

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (InsiderTradingLatestGetClientResponse) Status 

func (r InsiderTradingLatestGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (InsiderTradingLatestGetClientResponse) StatusCode 

func (r InsiderTradingLatestGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InsiderTradingLatestGetParams 

type InsiderTradingLatestGetParams struct {
	Date  *openapi_types.Date `form:"date,omitempty" json:"date,omitempty"`
	Page  *int                `form:"page,omitempty" json:"page,omitempty"`
	Limit *int                `form:"limit,omitempty" json:"limit,omitempty"`
}

InsiderTradingLatestGetParams defines parameters for InsiderTradingLatestGet.

type InsiderTradingSearchGetClientResponse added in v0.1.16 

type InsiderTradingSearchGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]InsiderTransaction
}

func ParseInsiderTradingSearchGetClientResponse added in v0.1.16 

func ParseInsiderTradingSearchGetClientResponse(rsp *http.Response) (*InsiderTradingSearchGetClientResponse, error)

ParseInsiderTradingSearchGetClientResponse parses an HTTP response from a InsiderTradingSearchGetWithResponse call

func (InsiderTradingSearchGetClientResponse) ContentType added in v0.1.43 

func (r InsiderTradingSearchGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (InsiderTradingSearchGetClientResponse) GetBody added in v0.1.43 

func (r InsiderTradingSearchGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (InsiderTradingSearchGetClientResponse) GetJSON200 added in v0.1.43 

func (r InsiderTradingSearchGetClientResponse) GetJSON200() *[]InsiderTransaction

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (InsiderTradingSearchGetClientResponse) Status added in v0.1.16 

func (r InsiderTradingSearchGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (InsiderTradingSearchGetClientResponse) StatusCode added in v0.1.16 

func (r InsiderTradingSearchGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InsiderTradingSearchGetParams added in v0.1.16 

type InsiderTradingSearchGetParams struct {
	Symbol          string  `form:"symbol" json:"symbol"`
	Page            *int    `form:"page,omitempty" json:"page,omitempty"`
	Limit           *int    `form:"limit,omitempty" json:"limit,omitempty"`
	ReportingCik    *string `form:"reportingCik,omitempty" json:"reportingCik,omitempty"`
	TransactionType *string `form:"transactionType,omitempty" json:"transactionType,omitempty"`
}

InsiderTradingSearchGetParams defines parameters for InsiderTradingSearchGet.

type InsiderTransaction 

type InsiderTransaction struct {
	// AcquisitionOrDisposition Example: A
	AcquisitionOrDisposition string `json:"acquisitionOrDisposition"`

	// CompanyCik Example: 0001841666
	CompanyCik string `json:"companyCik"`

	// DirectOrIndirect Example: D
	DirectOrIndirect string `json:"directOrIndirect"`

	// FilingDate Example: 2025-02-04
	FilingDate openapi_types.Date `json:"filingDate"`

	// FormType Example: 4
	FormType string `json:"formType"`

	// Price Example: 0
	Price float32 `json:"price"`

	// ReportingCik Example: 0001380034
	ReportingCik string `json:"reportingCik"`

	// ReportingName Example: Hoyt Rebecca A
	ReportingName string `json:"reportingName"`

	// SecuritiesOwned Example: 104398
	SecuritiesOwned float64 `json:"securitiesOwned"`

	// SecuritiesTransacted Example: 3450
	SecuritiesTransacted float64 `json:"securitiesTransacted"`

	// SecurityName Example: Common Stock
	SecurityName string `json:"securityName"`

	// Symbol Example: APA
	Symbol string `json:"symbol"`

	// TransactionDate Example: 2025-02-01
	TransactionDate openapi_types.Date `json:"transactionDate"`

	// TransactionType Example: M-Exempt
	TransactionType string `json:"transactionType"`

	// TypeOfOwner Example: officer: Sr. VP, Chief Acct Officer
	TypeOfOwner string `json:"typeOfOwner"`

	// Url Example: https://www.sec.gov/Archives/edgar/data/1841666/000194906025000035/0001949060-25-000035-index.htm
	Url string `json:"url"`
}

InsiderTransaction defines model for InsiderTransaction.

type KeyMetrics 

type KeyMetrics struct {
	// AverageInventory Example: 6808500000
	AverageInventory float64 `json:"averageInventory"`

	// AveragePayables Example: 65785500000
	AveragePayables float64 `json:"averagePayables"`

	// AverageReceivables Example: 63614000000
	AverageReceivables float64 `json:"averageReceivables"`

	// CapexToDepreciation Example: 0.8254259501965924
	CapexToDepreciation float64 `json:"capexToDepreciation"`

	// CapexToOperatingCashFlow Example: 0.07988736110406414
	CapexToOperatingCashFlow float64 `json:"capexToOperatingCashFlow"`

	// CapexToRevenue Example: 0.02415896275269477
	CapexToRevenue float64 `json:"capexToRevenue"`

	// CashConversionCycle Example: -45.18334692543202
	CashConversionCycle float64 `json:"cashConversionCycle"`

	// CurrentRatio Example: 0.8673125765340832
	CurrentRatio float64 `json:"currentRatio"`

	// Date Example: 2024-09-28
	Date openapi_types.Date `json:"date"`

	// DaysOfInventoryOutstanding Example: 12.642570548414087
	DaysOfInventoryOutstanding float64 `json:"daysOfInventoryOutstanding"`

	// DaysOfPayablesOutstanding Example: 119.65847721913745
	DaysOfPayablesOutstanding float64 `json:"daysOfPayablesOutstanding"`

	// DaysOfSalesOutstanding Example: 61.83255974529134
	DaysOfSalesOutstanding float64 `json:"daysOfSalesOutstanding"`

	// EarningsYield Example: 0.026818798327209237
	EarningsYield float64 `json:"earningsYield"`

	// EnterpriseValue Example: 3571846329570
	EnterpriseValue float64 `json:"enterpriseValue"`

	// EvToEBITDA Example: 26.524727497716487
	EvToEBITDA float64 `json:"evToEBITDA"`

	// EvToFreeCashFlow Example: 32.82735788662494
	EvToFreeCashFlow float64 `json:"evToFreeCashFlow"`

	// EvToOperatingCashFlow Example: 30.204866893043786
	EvToOperatingCashFlow float64 `json:"evToOperatingCashFlow"`

	// EvToSales Example: 9.134339201273542
	EvToSales float64 `json:"evToSales"`

	// FiscalYear Example: 2024
	FiscalYear string `json:"fiscalYear"`

	// FreeCashFlowToEquity Example: 32121000000
	FreeCashFlowToEquity float64 `json:"freeCashFlowToEquity"`

	// FreeCashFlowToFirm Example: 117192805288.09166
	FreeCashFlowToFirm float64 `json:"freeCashFlowToFirm"`

	// FreeCashFlowYield Example: 0.03113076074921754
	FreeCashFlowYield float64 `json:"freeCashFlowYield"`

	// GrahamNetNet Example: -12.352478525015636
	GrahamNetNet float64 `json:"grahamNetNet"`

	// GrahamNumber Example: 22.587017267616833
	GrahamNumber float64 `json:"grahamNumber"`

	// IncomeQuality Example: 1.2615643936161134
	IncomeQuality float64 `json:"incomeQuality"`

	// IntangiblesToTotalAssets Example: 0
	IntangiblesToTotalAssets float64 `json:"intangiblesToTotalAssets"`

	// InterestBurden Example: 1.0021831580314244
	InterestBurden float64 `json:"interestBurden"`

	// InvestedCapital Example: 22275000000
	InvestedCapital float64 `json:"investedCapital"`

	// MarketCap Example: 3495160329570
	MarketCap float64 `json:"marketCap"`

	// NetCurrentAssetValue Example: -155043000000
	NetCurrentAssetValue float64 `json:"netCurrentAssetValue"`

	// NetDebtToEBITDA Example: 0.5694744580836323
	NetDebtToEBITDA float64 `json:"netDebtToEBITDA"`

	// OperatingCycle Example: 74.47513029370543
	OperatingCycle float64 `json:"operatingCycle"`

	// OperatingReturnOnAssets Example: 0.3434290787011036
	OperatingReturnOnAssets float64 `json:"operatingReturnOnAssets"`

	// Period Example: FY
	Period string `json:"period"`

	// ReportedCurrency Example: USD
	ReportedCurrency string `json:"reportedCurrency"`

	// ResearchAndDevelopementToRevenue Example: 0.08022299794136074
	ResearchAndDevelopementToRevenue float64 `json:"researchAndDevelopementToRevenue"`

	// ReturnOnAssets Example: 0.25682503150857583
	ReturnOnAssets float64 `json:"returnOnAssets"`

	// ReturnOnCapitalEmployed Example: 0.6533607652660827
	ReturnOnCapitalEmployed float64 `json:"returnOnCapitalEmployed"`

	// ReturnOnEquity Example: 1.6459350307287095
	ReturnOnEquity float64 `json:"returnOnEquity"`

	// ReturnOnInvestedCapital Example: 0.4430708117427921
	ReturnOnInvestedCapital float64 `json:"returnOnInvestedCapital"`

	// ReturnOnTangibleAssets Example: 0.25682503150857583
	ReturnOnTangibleAssets float64 `json:"returnOnTangibleAssets"`

	// SalesGeneralAndAdministrativeToRevenue Example: 0
	SalesGeneralAndAdministrativeToRevenue float64 `json:"salesGeneralAndAdministrativeToRevenue"`

	// StockBasedCompensationToRevenue Example: 0.02988990755303234
	StockBasedCompensationToRevenue float64 `json:"stockBasedCompensationToRevenue"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// TangibleAssetValue Example: 56950000000
	TangibleAssetValue float64 `json:"tangibleAssetValue"`

	// TaxBurden Example: 0.7590881483581001
	TaxBurden float64 `json:"taxBurden"`

	// WorkingCapital Example: -23405000000
	WorkingCapital float64 `json:"workingCapital"`
}

KeyMetrics defines model for KeyMetrics.

type KeyMetricsGetClientResponse 

type KeyMetricsGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]KeyMetrics
}

func ParseKeyMetricsGetClientResponse 

func ParseKeyMetricsGetClientResponse(rsp *http.Response) (*KeyMetricsGetClientResponse, error)

ParseKeyMetricsGetClientResponse parses an HTTP response from a KeyMetricsGetWithResponse call

func (KeyMetricsGetClientResponse) ContentType added in v0.1.43 

func (r KeyMetricsGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (KeyMetricsGetClientResponse) GetBody added in v0.1.43 

func (r KeyMetricsGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (KeyMetricsGetClientResponse) GetJSON200 added in v0.1.43 

func (r KeyMetricsGetClientResponse) GetJSON200() *[]KeyMetrics

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (KeyMetricsGetClientResponse) Status 

func (r KeyMetricsGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (KeyMetricsGetClientResponse) StatusCode 

func (r KeyMetricsGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type KeyMetricsGetParams 

type KeyMetricsGetParams struct {
	Symbol string  `form:"symbol" json:"symbol"`
	Limit  *int    `form:"limit,omitempty" json:"limit,omitempty"`
	Period *Period `form:"period,omitempty" json:"period,omitempty"`
}

KeyMetricsGetParams defines parameters for KeyMetricsGet.

type KeyMetricsTTM added in v0.1.11 

type KeyMetricsTTM struct {
	// AverageInventoryTTM Example: 7098500000
	AverageInventoryTTM float64 `json:"averageInventoryTTM"`

	// AveragePayablesTTM Example: 65435000000
	AveragePayablesTTM float64 `json:"averagePayablesTTM"`

	// AverageReceivablesTTM Example: 62774500000
	AverageReceivablesTTM float64 `json:"averageReceivablesTTM"`

	// CapexToDepreciationTTM Example: 0.855956153121521
	CapexToDepreciationTTM float64 `json:"capexToDepreciationTTM"`

	// CapexToOperatingCashFlowTTM Example: 0.09229504866382256
	CapexToOperatingCashFlowTTM float64 `json:"capexToOperatingCashFlowTTM"`

	// CapexToRevenueTTM Example: 0.025255205174853447
	CapexToRevenueTTM float64 `json:"capexToRevenueTTM"`

	// CashConversionCycleTTM Example: -40.148618800680595
	CashConversionCycleTTM float64 `json:"cashConversionCycleTTM"`

	// CurrentRatioTTM Example: 0.9229383853427077
	CurrentRatioTTM float64 `json:"currentRatioTTM"`

	// DaysOfInventoryOutstandingTTM Example: 11.917937984569374
	DaysOfInventoryOutstandingTTM float64 `json:"daysOfInventoryOutstandingTTM"`

	// DaysOfPayablesOutstandingTTM Example: 106.76306476988712
	DaysOfPayablesOutstandingTTM float64 `json:"daysOfPayablesOutstandingTTM"`

	// DaysOfSalesOutstandingTTM Example: 54.69650798463715
	DaysOfSalesOutstandingTTM float64 `json:"daysOfSalesOutstandingTTM"`

	// EarningsYieldTTM Example: 0.030404739849149914
	EarningsYieldTTM float64 `json:"earningsYieldTTM"`

	// EnterpriseValueTTM Example: 3216333928000
	EnterpriseValueTTM float64 `json:"enterpriseValueTTM"`

	// EvToEBITDATTM Example: 23.41672438697653
	EvToEBITDATTM float64 `json:"evToEBITDATTM"`

	// EvToFreeCashFlowTTM Example: 32.71990486169747
	EvToFreeCashFlowTTM float64 `json:"evToFreeCashFlowTTM"`

	// EvToOperatingCashFlowTTM Example: 29.70001965021146
	EvToOperatingCashFlowTTM float64 `json:"evToOperatingCashFlowTTM"`

	// EvToSalesTTM Example: 8.126980816656559
	EvToSalesTTM float64 `json:"evToSalesTTM"`

	// FreeCashFlowToEquityTTM Example: 31799000000
	FreeCashFlowToEquityTTM float64 `json:"freeCashFlowToEquityTTM"`

	// FreeCashFlowToFirmTTM Example: 85497710797.9578
	FreeCashFlowToFirmTTM float64 `json:"freeCashFlowToFirmTTM"`

	// FreeCashFlowYieldTTM Example: 0.03120767705439485
	FreeCashFlowYieldTTM float64 `json:"freeCashFlowYieldTTM"`

	// GrahamNetNetTTM Example: -11.64435843011051
	GrahamNetNetTTM float64 `json:"grahamNetNetTTM"`

	// GrahamNumberTTM Example: 25.198029099282905
	GrahamNumberTTM float64 `json:"grahamNumberTTM"`

	// IncomeQualityTTM Example: 1.1263026521060842
	IncomeQualityTTM float64 `json:"incomeQualityTTM"`

	// IntangiblesToTotalAssetsTTM Example: 0
	IntangiblesToTotalAssetsTTM float64 `json:"intangiblesToTotalAssetsTTM"`

	// InterestBurdenTTM Example: 1.0005649492739208
	InterestBurdenTTM float64 `json:"interestBurdenTTM"`

	// InvestedCapitalTTM Example: 34944000000
	InvestedCapitalTTM float64 `json:"investedCapitalTTM"`

	// MarketCap Example: 3149833928000
	MarketCap *float64 `json:"marketCap,omitempty"`

	// NetCurrentAssetValueTTM Example: -144087000000
	NetCurrentAssetValueTTM float64 `json:"netCurrentAssetValueTTM"`

	// NetDebtToEBITDATTM Example: 0.48415749315627005
	NetDebtToEBITDATTM float64 `json:"netDebtToEBITDATTM"`

	// OperatingCycleTTM Example: 66.61444596920653
	OperatingCycleTTM float64 `json:"operatingCycleTTM"`

	// OperatingReturnOnAssetsTTM Example: 0.35448090090471257
	OperatingReturnOnAssetsTTM float64 `json:"operatingReturnOnAssetsTTM"`

	// ResearchAndDevelopementToRevenueTTM Example: 0.08071053163533455
	ResearchAndDevelopementToRevenueTTM float64 `json:"researchAndDevelopementToRevenueTTM"`

	// ReturnOnAssetsTTM Example: 0.27943676707790227
	ReturnOnAssetsTTM float64 `json:"returnOnAssetsTTM"`

	// ReturnOnCapitalEmployedTTM Example: 0.6292559583416784
	ReturnOnCapitalEmployedTTM float64 `json:"returnOnCapitalEmployedTTM"`

	// ReturnOnEquityTTM Example: 1.4534598087751787
	ReturnOnEquityTTM float64 `json:"returnOnEquityTTM"`

	// ReturnOnInvestedCapitalTTM Example: 0.45208108089346594
	ReturnOnInvestedCapitalTTM float64 `json:"returnOnInvestedCapitalTTM"`

	// ReturnOnTangibleAssetsTTM Example: 0.27943676707790227
	ReturnOnTangibleAssetsTTM float64 `json:"returnOnTangibleAssetsTTM"`

	// SalesGeneralAndAdministrativeToRevenueTTM Example: 0
	SalesGeneralAndAdministrativeToRevenueTTM float64 `json:"salesGeneralAndAdministrativeToRevenueTTM"`

	// StockBasedCompensationToRevenueTTM Example: 0.030263290883363655
	StockBasedCompensationToRevenueTTM float64 `json:"stockBasedCompensationToRevenueTTM"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// TangibleAssetValueTTM Example: 66758000000
	TangibleAssetValueTTM float64 `json:"tangibleAssetValueTTM"`

	// TaxBurdenTTM Example: 0.7646366484818603
	TaxBurdenTTM float64 `json:"taxBurdenTTM"`

	// WorkingCapitalTTM Example: -11125000000
	WorkingCapitalTTM float64 `json:"workingCapitalTTM"`
}

KeyMetricsTTM defines model for KeyMetricsTTM.

type KeyMetricsTTMBulkGetClientResponse added in v0.1.29 

type KeyMetricsTTMBulkGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]KeyMetricsTTM
}

func ParseKeyMetricsTTMBulkGetClientResponse added in v0.1.29 

func ParseKeyMetricsTTMBulkGetClientResponse(rsp *http.Response) (*KeyMetricsTTMBulkGetClientResponse, error)

ParseKeyMetricsTTMBulkGetClientResponse parses an HTTP response from a KeyMetricsTTMBulkGetWithResponse call

func (KeyMetricsTTMBulkGetClientResponse) ContentType added in v0.1.43 

func (r KeyMetricsTTMBulkGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (KeyMetricsTTMBulkGetClientResponse) GetBody added in v0.1.43 

func (r KeyMetricsTTMBulkGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (KeyMetricsTTMBulkGetClientResponse) GetJSON200 added in v0.1.43 

func (r KeyMetricsTTMBulkGetClientResponse) GetJSON200() *[]KeyMetricsTTM

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (KeyMetricsTTMBulkGetClientResponse) Status added in v0.1.29 

func (r KeyMetricsTTMBulkGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (KeyMetricsTTMBulkGetClientResponse) StatusCode added in v0.1.29 

func (r KeyMetricsTTMBulkGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type KeyMetricsTTMGetClientResponse added in v0.1.11 

type KeyMetricsTTMGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]KeyMetricsTTM
}

func ParseKeyMetricsTTMGetClientResponse added in v0.1.11 

func ParseKeyMetricsTTMGetClientResponse(rsp *http.Response) (*KeyMetricsTTMGetClientResponse, error)

ParseKeyMetricsTTMGetClientResponse parses an HTTP response from a KeyMetricsTTMGetWithResponse call

func (KeyMetricsTTMGetClientResponse) ContentType added in v0.1.43 

func (r KeyMetricsTTMGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (KeyMetricsTTMGetClientResponse) GetBody added in v0.1.43 

func (r KeyMetricsTTMGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (KeyMetricsTTMGetClientResponse) GetJSON200 added in v0.1.43 

func (r KeyMetricsTTMGetClientResponse) GetJSON200() *[]KeyMetricsTTM

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (KeyMetricsTTMGetClientResponse) Status added in v0.1.11 

func (r KeyMetricsTTMGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (KeyMetricsTTMGetClientResponse) StatusCode added in v0.1.11 

func (r KeyMetricsTTMGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type KeyMetricsTTMGetParams added in v0.1.11 

type KeyMetricsTTMGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

KeyMetricsTTMGetParams defines parameters for KeyMetricsTTMGet.

type LightCandle 

type LightCandle struct {
	// Date Example: 2025-02-04
	Date openapi_types.Date `json:"date"`

	// Price Example: 232.8
	Price float32 `json:"price"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// Volume Example: 44489128
	Volume int `json:"volume"`
}

LightCandle defines model for LightCandle.

type MarketCapitalizationBatchGetClientResponse 

type MarketCapitalizationBatchGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]CompanyCapitalization
}

func ParseMarketCapitalizationBatchGetClientResponse 

func ParseMarketCapitalizationBatchGetClientResponse(rsp *http.Response) (*MarketCapitalizationBatchGetClientResponse, error)

ParseMarketCapitalizationBatchGetClientResponse parses an HTTP response from a MarketCapitalizationBatchGetWithResponse call

func (MarketCapitalizationBatchGetClientResponse) ContentType added in v0.1.43 

func (r MarketCapitalizationBatchGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MarketCapitalizationBatchGetClientResponse) GetBody added in v0.1.43 

func (r MarketCapitalizationBatchGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (MarketCapitalizationBatchGetClientResponse) GetJSON200 added in v0.1.43 

func (r MarketCapitalizationBatchGetClientResponse) GetJSON200() *[]CompanyCapitalization

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (MarketCapitalizationBatchGetClientResponse) Status 

func (r MarketCapitalizationBatchGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (MarketCapitalizationBatchGetClientResponse) StatusCode 

func (r MarketCapitalizationBatchGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MarketCapitalizationBatchGetParams 

type MarketCapitalizationBatchGetParams struct {
	// Symbols Array of symbols to fetch market capitalization data for
	Symbols string `form:"symbols" json:"symbols"`
}

MarketCapitalizationBatchGetParams defines parameters for MarketCapitalizationBatchGet.

type MarketCapitalizationGetClientResponse 

type MarketCapitalizationGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]CompanyCapitalization
}

func ParseMarketCapitalizationGetClientResponse 

func ParseMarketCapitalizationGetClientResponse(rsp *http.Response) (*MarketCapitalizationGetClientResponse, error)

ParseMarketCapitalizationGetClientResponse parses an HTTP response from a MarketCapitalizationGetWithResponse call

func (MarketCapitalizationGetClientResponse) ContentType added in v0.1.43 

func (r MarketCapitalizationGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MarketCapitalizationGetClientResponse) GetBody added in v0.1.43 

func (r MarketCapitalizationGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (MarketCapitalizationGetClientResponse) GetJSON200 added in v0.1.43 

func (r MarketCapitalizationGetClientResponse) GetJSON200() *[]CompanyCapitalization

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (MarketCapitalizationGetClientResponse) Status 

func (r MarketCapitalizationGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (MarketCapitalizationGetClientResponse) StatusCode 

func (r MarketCapitalizationGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MarketCapitalizationGetParams 

type MarketCapitalizationGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

MarketCapitalizationGetParams defines parameters for MarketCapitalizationGet.

type MostActivesGetClientResponse added in v0.1.54 

type MostActivesGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]StockActivity
}

func ParseMostActivesGetClientResponse added in v0.1.54 

func ParseMostActivesGetClientResponse(rsp *http.Response) (*MostActivesGetClientResponse, error)

ParseMostActivesGetClientResponse parses an HTTP response from a MostActivesGetWithResponse call

func (MostActivesGetClientResponse) ContentType added in v0.1.54 

func (r MostActivesGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (MostActivesGetClientResponse) GetBody added in v0.1.54 

func (r MostActivesGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (MostActivesGetClientResponse) GetJSON200 added in v0.1.54 

func (r MostActivesGetClientResponse) GetJSON200() *[]StockActivity

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (MostActivesGetClientResponse) Status added in v0.1.54 

func (r MostActivesGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (MostActivesGetClientResponse) StatusCode added in v0.1.54 

func (r MostActivesGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type NewsArticle 

type NewsArticle struct {
	// Image Example: https://images.financialmodelingprep.com/news/crypto-prices-today-feb-4-btc-altcoins-recover-amid-20250203.webp
	Image string `json:"image"`

	// PublishedDate Example: 2025-02-03 23:32:19
	PublishedDate string `json:"publishedDate"`

	// Publisher Example: Coingape
	Publisher string `json:"publisher"`

	// Site Example: coingape.com
	Site string `json:"site"`

	// Symbol Example: BTCUSD
	Symbol *string `json:"symbol,omitempty"`

	// Text Example: Crypto prices today have shown signs of recovery as U.S. President Donald Trump's newly announced import tariffs on Canada and Mexico were paused for 30 days. Bitcoin (BTC) price regained its value, hitting a $102K high amid broader market recovery.
	Text string `json:"text"`

	// Title Example: Crypto Prices Today Feb 4: BTC & Altcoins Recover Amid Pause On Trump's Tariffs
	Title string `json:"title"`

	// Url Example: https://coingape.com/crypto-prices-today-feb-4-btc-altcoins-recover-amid-pause-on-trumps-tariffs/
	Url string `json:"url"`
}

NewsArticle defines model for NewsArticle.

type NewsGeneralLatestGetClientResponse 

type NewsGeneralLatestGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]NewsArticle
}

func ParseNewsGeneralLatestGetClientResponse 

func ParseNewsGeneralLatestGetClientResponse(rsp *http.Response) (*NewsGeneralLatestGetClientResponse, error)

ParseNewsGeneralLatestGetClientResponse parses an HTTP response from a NewsGeneralLatestGetWithResponse call

func (NewsGeneralLatestGetClientResponse) ContentType added in v0.1.43 

func (r NewsGeneralLatestGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (NewsGeneralLatestGetClientResponse) GetBody added in v0.1.43 

func (r NewsGeneralLatestGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (NewsGeneralLatestGetClientResponse) GetJSON200 added in v0.1.43 

func (r NewsGeneralLatestGetClientResponse) GetJSON200() *[]NewsArticle

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (NewsGeneralLatestGetClientResponse) Status 

func (r NewsGeneralLatestGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (NewsGeneralLatestGetClientResponse) StatusCode 

func (r NewsGeneralLatestGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type NewsGeneralLatestGetParams 

type NewsGeneralLatestGetParams struct {
	From  *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`
	To    *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`
	Page  *int                `form:"page,omitempty" json:"page,omitempty"`
	Limit *int                `form:"limit,omitempty" json:"limit,omitempty"`
}

NewsGeneralLatestGetParams defines parameters for NewsGeneralLatestGet.

type NewsStockLatestGetClientResponse added in v0.1.25 

type NewsStockLatestGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]NewsArticle
}

func ParseNewsStockLatestGetClientResponse added in v0.1.25 

func ParseNewsStockLatestGetClientResponse(rsp *http.Response) (*NewsStockLatestGetClientResponse, error)

ParseNewsStockLatestGetClientResponse parses an HTTP response from a NewsStockLatestGetWithResponse call

func (NewsStockLatestGetClientResponse) ContentType added in v0.1.43 

func (r NewsStockLatestGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (NewsStockLatestGetClientResponse) GetBody added in v0.1.43 

func (r NewsStockLatestGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (NewsStockLatestGetClientResponse) GetJSON200 added in v0.1.43 

func (r NewsStockLatestGetClientResponse) GetJSON200() *[]NewsArticle

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (NewsStockLatestGetClientResponse) Status added in v0.1.25 

func (r NewsStockLatestGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (NewsStockLatestGetClientResponse) StatusCode added in v0.1.25 

func (r NewsStockLatestGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type NewsStockLatestGetParams added in v0.1.25 

type NewsStockLatestGetParams struct {
	From  *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`
	To    *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`
	Page  *int                `form:"page,omitempty" json:"page,omitempty"`
	Limit *int                `form:"limit,omitempty" json:"limit,omitempty"`
}

NewsStockLatestGetParams defines parameters for NewsStockLatestGet.

type OperationPath 

type OperationPath string
const (

	// /analyst-estimates
	AnalystEstimatesGetOperationPath OperationPath = "/analyst-estimates"

	// /available-exchanges
	AvailableExchangesGetOperationPath OperationPath = "/available-exchanges"

	// /balance-sheet-statement
	BalanceSheetStatementGetOperationPath OperationPath = "/balance-sheet-statement"

	// /balance-sheet-statement-bulk
	BalanceSheetStatementBulkGetOperationPath OperationPath = "/balance-sheet-statement-bulk"

	// /balance-sheet-statement-ttm
	BalanceSheetStatementTTMGetOperationPath OperationPath = "/balance-sheet-statement-ttm"

	// /batch-aftermarket-quote
	BatchAfterMarketQuoteGetOperationPath OperationPath = "/batch-aftermarket-quote"

	// /batch-index-quotes
	BatchIndexQuotesGetOperationPath OperationPath = "/batch-index-quotes"

	// /batch-quote
	BatchQuoteGetOperationPath OperationPath = "/batch-quote"

	// /batch-quote-short
	BatchQuoteShortGetOperationPath OperationPath = "/batch-quote-short"

	// /biggest-gainers
	BiggestGainersGetOperationPath OperationPath = "/biggest-gainers"

	// /biggest-losers
	BiggestLosersGetOperationPath OperationPath = "/biggest-losers"

	// /cash-flow-statement
	CashFlowStatementGetOperationPath OperationPath = "/cash-flow-statement"

	// /cash-flow-statement-bulk
	CashFlowStatementBulkGetOperationPath OperationPath = "/cash-flow-statement-bulk"

	// /cash-flow-statement-ttm
	CashFlowStatementTTMGetOperationPath OperationPath = "/cash-flow-statement-ttm"

	// /commodities-list
	CommoditiesListGetOperationPath OperationPath = "/commodities-list"

	// /cryptocurrency-list
	CryptocurrencyListGetOperationPath OperationPath = "/cryptocurrency-list"

	// /dcf-bulk
	DcfBulkGetOperationPath OperationPath = "/dcf-bulk"

	// /delisted-companies
	DelistedCompaniesOperationPath OperationPath = "/delisted-companies"

	// /dividends
	DividendsGetOperationPath OperationPath = "/dividends"

	// /dividends-calendar
	DividendsCalendarGetOperationPath OperationPath = "/dividends-calendar"

	// /earnings
	EarningsGetOperationPath OperationPath = "/earnings"

	// /earnings-calendar
	EarningsCalendarGetOperationPath OperationPath = "/earnings-calendar"

	// /economic-calendar
	EconomicCalendarGetOperationPath OperationPath = "/economic-calendar"

	// /enterprise-values
	EnterpriseValueGetOperationPath OperationPath = "/enterprise-values"

	// /esg-disclosures
	EsgDisclosuresGetOperationPath OperationPath = "/esg-disclosures"

	// /esg-ratings
	EsgRatingsGetOperationPath OperationPath = "/esg-ratings"

	// /etf-list
	ETFListGetOperationPath OperationPath = "/etf-list"

	// /etf/country-weightings
	ETFCountryWeightingsGetOperationPath OperationPath = "/etf/country-weightings"

	// /etf/holdings
	ETFHoldingsGetOperationPath OperationPath = "/etf/holdings"

	// /etf/info
	ETFInfoGetOperationPath OperationPath = "/etf/info"

	// /etf/sector-weightings
	ETFSectorWeightingsGetOperationPath OperationPath = "/etf/sector-weightings"

	// /forex-list
	ForexCurrencyPairsGetOperationPath OperationPath = "/forex-list"

	// /grades-latest-news
	GradesLatestNewsGetOperationPath OperationPath = "/grades-latest-news"

	// /historical-chart/15min
	HistoricalChart15MinGetOperationPath OperationPath = "/historical-chart/15min"

	// /historical-price-eod/full
	HistoricalPriceEodFullGetOperationPath OperationPath = "/historical-price-eod/full"

	// /historical-price-eod/light
	HistoricalPriceEodLightGetOperationPath OperationPath = "/historical-price-eod/light"

	// /income-statement
	IncomeStatementGetOperationPath OperationPath = "/income-statement"

	// /income-statement-bulk
	IncomeStatementBulkGetOperationPath OperationPath = "/income-statement-bulk"

	// /income-statement-ttm
	IncomeStatementTTMGetOperationPath OperationPath = "/income-statement-ttm"

	// /index-constituent-list
	IndexConstituentListGetOperationPath OperationPath = "/index-constituent-list"

	// /index-list
	IndexListGetOperationPath OperationPath = "/index-list"

	// /insider-trading/latest
	InsiderTradingLatestGetOperationPath OperationPath = "/insider-trading/latest"

	// /insider-trading/search
	InsiderTradingSearchGetOperationPath OperationPath = "/insider-trading/search"

	// /key-metrics
	KeyMetricsGetOperationPath OperationPath = "/key-metrics"

	// /key-metrics-ttm
	KeyMetricsTTMGetOperationPath OperationPath = "/key-metrics-ttm"

	// /key-metrics-ttm-bulk
	KeyMetricsTTMBulkGetOperationPath OperationPath = "/key-metrics-ttm-bulk"

	// /market-capitalization
	MarketCapitalizationGetOperationPath OperationPath = "/market-capitalization"

	// /market-capitalization-batch
	MarketCapitalizationBatchGetOperationPath OperationPath = "/market-capitalization-batch"

	// /most-actives
	MostActivesGetOperationPath OperationPath = "/most-actives"

	// /news/general-latest
	NewsGeneralLatestGetOperationPath OperationPath = "/news/general-latest"

	// /news/stock-latest
	NewsStockLatestGetOperationPath OperationPath = "/news/stock-latest"

	// /profile
	ProfileGetOperationPath OperationPath = "/profile"

	// /profile-bulk
	ProfileBulkGetOperationPath OperationPath = "/profile-bulk"

	// /quote
	QuoteGetOperationPath OperationPath = "/quote"

	// /quote-short
	QuoteShortGetOperationPath OperationPath = "/quote-short"

	// /rating-bulk
	RatingBulkGetOperationPath OperationPath = "/rating-bulk"

	// /ratings-snapshot
	RatingsSnapshotGetOperationPath OperationPath = "/ratings-snapshot"

	// /ratios
	RatiosGetOperationPath OperationPath = "/ratios"

	// /ratios-ttm
	RatiosTTMGetOperationPath OperationPath = "/ratios-ttm"

	// /ratios-ttm-bulk
	RatiosTTMBulkGetOperationPath OperationPath = "/ratios-ttm-bulk"

	// /revenue-geographic-segmentation
	RevenueGeographicSegmentationGetOperationPath OperationPath = "/revenue-geographic-segmentation"

	// /revenue-product-segmentation
	RevenueProductSegmentationGetOperationPath OperationPath = "/revenue-product-segmentation"

	// /search-name
	SearchNameGetOperationPath OperationPath = "/search-name"

	// /search-symbol
	SearchSymbolGetOperationPath OperationPath = "/search-symbol"

	// /shares-float
	SharesFloatGetOperationPath OperationPath = "/shares-float"

	// /splits
	SplitsGetOperationPath OperationPath = "/splits"

	// /splits-calendar
	SplitsCalendarGetOperationPath OperationPath = "/splits-calendar"

	// /stock-list
	StockListGetOperationPath OperationPath = "/stock-list"

	// /technical-indicators/rsi
	TechnicalIndicatorsRsiGetOperationPath OperationPath = "/technical-indicators/rsi"

	// /treasury-rates
	TreasuryRatesGetOperationPath OperationPath = "/treasury-rates"
)

type Period 

type Period string

Period Reporting period 

const (
	Annual  Period = "annual"
	FY      Period = "FY"
	Q1      Period = "Q1"
	Q2      Period = "Q2"
	Q3      Period = "Q3"
	Q4      Period = "Q4"
	Quarter Period = "quarter"
)

Defines values for Period.

func (Period) Valid added in v0.1.34 

func (e Period) Valid() bool

Valid indicates whether the value is a known member of the Period enum.

type ProfileBulkGetClientResponse added in v0.1.29 

type ProfileBulkGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]CompanyProfile
}

func ParseProfileBulkGetClientResponse added in v0.1.29 

func ParseProfileBulkGetClientResponse(rsp *http.Response) (*ProfileBulkGetClientResponse, error)

ParseProfileBulkGetClientResponse parses an HTTP response from a ProfileBulkGetWithResponse call

func (ProfileBulkGetClientResponse) ContentType added in v0.1.43 

func (r ProfileBulkGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ProfileBulkGetClientResponse) GetBody added in v0.1.43 

func (r ProfileBulkGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ProfileBulkGetClientResponse) GetJSON200 added in v0.1.43 

func (r ProfileBulkGetClientResponse) GetJSON200() *[]CompanyProfile

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ProfileBulkGetClientResponse) Status added in v0.1.29 

func (r ProfileBulkGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (ProfileBulkGetClientResponse) StatusCode added in v0.1.29 

func (r ProfileBulkGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ProfileBulkGetParams added in v0.1.29 

type ProfileBulkGetParams struct {
	Part string `form:"part" json:"part"`
}

ProfileBulkGetParams defines parameters for ProfileBulkGet.

type ProfileGetClientResponse 

type ProfileGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ProfileGetResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
}

func ParseProfileGetClientResponse 

func ParseProfileGetClientResponse(rsp *http.Response) (*ProfileGetClientResponse, error)

ParseProfileGetClientResponse parses an HTTP response from a ProfileGetWithResponse call

func (ProfileGetClientResponse) ContentType added in v0.1.43 

func (r ProfileGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ProfileGetClientResponse) GetBody added in v0.1.43 

func (r ProfileGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ProfileGetClientResponse) GetJSON200 added in v0.1.43 

func (r ProfileGetClientResponse) GetJSON200() *ProfileGetResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ProfileGetClientResponse) GetJSON401 added in v0.1.43 

func (r ProfileGetClientResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ProfileGetClientResponse) Status 

func (r ProfileGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (ProfileGetClientResponse) StatusCode 

func (r ProfileGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ProfileGetParams 

type ProfileGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

ProfileGetParams defines parameters for ProfileGet.

type ProfileGetResponse 

type ProfileGetResponse = []CompanyProfile

ProfileGetResponse defines model for ProfileGetResponse.

type QuoteGetClientResponse 

type QuoteGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]FullQuote
}

func ParseQuoteGetClientResponse 

func ParseQuoteGetClientResponse(rsp *http.Response) (*QuoteGetClientResponse, error)

ParseQuoteGetClientResponse parses an HTTP response from a QuoteGetWithResponse call

func (QuoteGetClientResponse) ContentType added in v0.1.43 

func (r QuoteGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (QuoteGetClientResponse) GetBody added in v0.1.43 

func (r QuoteGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (QuoteGetClientResponse) GetJSON200 added in v0.1.43 

func (r QuoteGetClientResponse) GetJSON200() *[]FullQuote

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (QuoteGetClientResponse) Status 

func (r QuoteGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (QuoteGetClientResponse) StatusCode 

func (r QuoteGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type QuoteGetParams 

type QuoteGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

QuoteGetParams defines parameters for QuoteGet.

type QuoteShortGetClientResponse 

type QuoteShortGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]ShortQuote
}

func ParseQuoteShortGetClientResponse 

func ParseQuoteShortGetClientResponse(rsp *http.Response) (*QuoteShortGetClientResponse, error)

ParseQuoteShortGetClientResponse parses an HTTP response from a QuoteShortGetWithResponse call

func (QuoteShortGetClientResponse) ContentType added in v0.1.43 

func (r QuoteShortGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (QuoteShortGetClientResponse) GetBody added in v0.1.43 

func (r QuoteShortGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (QuoteShortGetClientResponse) GetJSON200 added in v0.1.43 

func (r QuoteShortGetClientResponse) GetJSON200() *[]ShortQuote

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (QuoteShortGetClientResponse) Status 

func (r QuoteShortGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (QuoteShortGetClientResponse) StatusCode 

func (r QuoteShortGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type QuoteShortGetParams 

type QuoteShortGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

QuoteShortGetParams defines parameters for QuoteShortGet.

type RatingBulkGetClientResponse added in v0.1.29 

type RatingBulkGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]StockRating
}

func ParseRatingBulkGetClientResponse added in v0.1.29 

func ParseRatingBulkGetClientResponse(rsp *http.Response) (*RatingBulkGetClientResponse, error)

ParseRatingBulkGetClientResponse parses an HTTP response from a RatingBulkGetWithResponse call

func (RatingBulkGetClientResponse) ContentType added in v0.1.43 

func (r RatingBulkGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RatingBulkGetClientResponse) GetBody added in v0.1.43 

func (r RatingBulkGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RatingBulkGetClientResponse) GetJSON200 added in v0.1.43 

func (r RatingBulkGetClientResponse) GetJSON200() *[]StockRating

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RatingBulkGetClientResponse) Status added in v0.1.29 

func (r RatingBulkGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (RatingBulkGetClientResponse) StatusCode added in v0.1.29 

func (r RatingBulkGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RatingsSnapshotGetClientResponse 

type RatingsSnapshotGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]StockRating
}

func ParseRatingsSnapshotGetClientResponse 

func ParseRatingsSnapshotGetClientResponse(rsp *http.Response) (*RatingsSnapshotGetClientResponse, error)

ParseRatingsSnapshotGetClientResponse parses an HTTP response from a RatingsSnapshotGetWithResponse call

func (RatingsSnapshotGetClientResponse) ContentType added in v0.1.43 

func (r RatingsSnapshotGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RatingsSnapshotGetClientResponse) GetBody added in v0.1.43 

func (r RatingsSnapshotGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RatingsSnapshotGetClientResponse) GetJSON200 added in v0.1.43 

func (r RatingsSnapshotGetClientResponse) GetJSON200() *[]StockRating

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RatingsSnapshotGetClientResponse) Status 

func (r RatingsSnapshotGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (RatingsSnapshotGetClientResponse) StatusCode 

func (r RatingsSnapshotGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RatingsSnapshotGetParams 

type RatingsSnapshotGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
	Limit  *int   `form:"limit,omitempty" json:"limit,omitempty"`
}

RatingsSnapshotGetParams defines parameters for RatingsSnapshotGet.

type RatiosGetClientResponse 

type RatiosGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]FinancialRatios
}

func ParseRatiosGetClientResponse 

func ParseRatiosGetClientResponse(rsp *http.Response) (*RatiosGetClientResponse, error)

ParseRatiosGetClientResponse parses an HTTP response from a RatiosGetWithResponse call

func (RatiosGetClientResponse) ContentType added in v0.1.43 

func (r RatiosGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RatiosGetClientResponse) GetBody added in v0.1.43 

func (r RatiosGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RatiosGetClientResponse) GetJSON200 added in v0.1.43 

func (r RatiosGetClientResponse) GetJSON200() *[]FinancialRatios

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RatiosGetClientResponse) Status 

func (r RatiosGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (RatiosGetClientResponse) StatusCode 

func (r RatiosGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RatiosGetParams 

type RatiosGetParams struct {
	Symbol string  `form:"symbol" json:"symbol"`
	Limit  *int    `form:"limit,omitempty" json:"limit,omitempty"`
	Period *Period `form:"period,omitempty" json:"period,omitempty"`
}

RatiosGetParams defines parameters for RatiosGet.

type RatiosTTM added in v0.1.13 

type RatiosTTM struct {
	AssetTurnoverTTM                           float64 `json:"assetTurnoverTTM"`
	BookValuePerShareTTM                       float64 `json:"bookValuePerShareTTM"`
	BottomLineProfitMarginTTM                  float64 `json:"bottomLineProfitMarginTTM"`
	CapexPerShareTTM                           float64 `json:"capexPerShareTTM"`
	CapitalExpenditureCoverageRatioTTM         float64 `json:"capitalExpenditureCoverageRatioTTM"`
	CashPerShareTTM                            float64 `json:"cashPerShareTTM"`
	CashRatioTTM                               float64 `json:"cashRatioTTM"`
	ContinuousOperationsProfitMarginTTM        float64 `json:"continuousOperationsProfitMarginTTM"`
	CurrentRatioTTM                            float64 `json:"currentRatioTTM"`
	DebtServiceCoverageRatioTTM                float64 `json:"debtServiceCoverageRatioTTM"`
	DebtToAssetsRatioTTM                       float64 `json:"debtToAssetsRatioTTM"`
	DebtToCapitalRatioTTM                      float64 `json:"debtToCapitalRatioTTM"`
	DebtToEquityRatioTTM                       float64 `json:"debtToEquityRatioTTM"`
	DebtToMarketCapTTM                         float64 `json:"debtToMarketCapTTM"`
	DividendPaidAndCapexCoverageRatioTTM       float64 `json:"dividendPaidAndCapexCoverageRatioTTM"`
	DividendPayoutRatioTTM                     float64 `json:"dividendPayoutRatioTTM"`
	DividendPerShareTTM                        float64 `json:"dividendPerShareTTM"`
	DividendYieldTTM                           float64 `json:"dividendYieldTTM"`
	EbitMarginTTM                              float64 `json:"ebitMarginTTM"`
	EbitdaMarginTTM                            float64 `json:"ebitdaMarginTTM"`
	EbtPerEbitTTM                              float64 `json:"ebtPerEbitTTM"`
	EffectiveTaxRateTTM                        float64 `json:"effectiveTaxRateTTM"`
	EnterpriseValueMultipleTTM                 float64 `json:"enterpriseValueMultipleTTM"`
	EnterpriseValueTTM                         float64 `json:"enterpriseValueTTM"`
	FinancialLeverageRatioTTM                  float64 `json:"financialLeverageRatioTTM"`
	FixedAssetTurnoverTTM                      float64 `json:"fixedAssetTurnoverTTM"`
	ForwardPriceToEarningsGrowthRatioTTM       float64 `json:"forwardPriceToEarningsGrowthRatioTTM"`
	FreeCashFlowOperatingCashFlowRatioTTM      float64 `json:"freeCashFlowOperatingCashFlowRatioTTM"`
	FreeCashFlowPerShareTTM                    float64 `json:"freeCashFlowPerShareTTM"`
	GrossProfitMarginTTM                       float64 `json:"grossProfitMarginTTM"`
	InterestCoverageRatioTTM                   float64 `json:"interestCoverageRatioTTM"`
	InterestDebtPerShareTTM                    float64 `json:"interestDebtPerShareTTM"`
	InventoryTurnoverTTM                       float64 `json:"inventoryTurnoverTTM"`
	LongTermDebtToCapitalRatioTTM              float64 `json:"longTermDebtToCapitalRatioTTM"`
	NetIncomePerEBTTTM                         float64 `json:"netIncomePerEBTTTM"`
	NetIncomePerShareTTM                       float64 `json:"netIncomePerShareTTM"`
	NetProfitMarginTTM                         float64 `json:"netProfitMarginTTM"`
	OperatingCashFlowCoverageRatioTTM          float64 `json:"operatingCashFlowCoverageRatioTTM"`
	OperatingCashFlowPerShareTTM               float64 `json:"operatingCashFlowPerShareTTM"`
	OperatingCashFlowRatioTTM                  float64 `json:"operatingCashFlowRatioTTM"`
	OperatingCashFlowSalesRatioTTM             float64 `json:"operatingCashFlowSalesRatioTTM"`
	OperatingProfitMarginTTM                   float64 `json:"operatingProfitMarginTTM"`
	PayablesTurnoverTTM                        float64 `json:"payablesTurnoverTTM"`
	PretaxProfitMarginTTM                      float64 `json:"pretaxProfitMarginTTM"`
	PriceToBookRatioTTM                        float64 `json:"priceToBookRatioTTM"`
	PriceToEarningsGrowthRatioTTM              float64 `json:"priceToEarningsGrowthRatioTTM"`
	PriceToEarningsRatioTTM                    float64 `json:"priceToEarningsRatioTTM"`
	PriceToFairValueTTM                        float64 `json:"priceToFairValueTTM"`
	PriceToFreeCashFlowRatioTTM                float64 `json:"priceToFreeCashFlowRatioTTM"`
	PriceToOperatingCashFlowRatioTTM           float64 `json:"priceToOperatingCashFlowRatioTTM"`
	PriceToSalesRatioTTM                       float64 `json:"priceToSalesRatioTTM"`
	QuickRatioTTM                              float64 `json:"quickRatioTTM"`
	ReceivablesTurnoverTTM                     float64 `json:"receivablesTurnoverTTM"`
	RevenuePerShareTTM                         float64 `json:"revenuePerShareTTM"`
	ShareholdersEquityPerShareTTM              float64 `json:"shareholdersEquityPerShareTTM"`
	ShortTermOperatingCashFlowCoverageRatioTTM float64 `json:"shortTermOperatingCashFlowCoverageRatioTTM"`
	SolvencyRatioTTM                           float64 `json:"solvencyRatioTTM"`

	// Symbol Example: AAPL
	Symbol                         string  `json:"symbol"`
	TangibleBookValuePerShareTTM   float64 `json:"tangibleBookValuePerShareTTM"`
	WorkingCapitalTurnoverRatioTTM float64 `json:"workingCapitalTurnoverRatioTTM"`
}

RatiosTTM defines model for RatiosTTM.

type RatiosTTMBulkGetClientResponse added in v0.1.29 

type RatiosTTMBulkGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]RatiosTTM
}

func ParseRatiosTTMBulkGetClientResponse added in v0.1.29 

func ParseRatiosTTMBulkGetClientResponse(rsp *http.Response) (*RatiosTTMBulkGetClientResponse, error)

ParseRatiosTTMBulkGetClientResponse parses an HTTP response from a RatiosTTMBulkGetWithResponse call

func (RatiosTTMBulkGetClientResponse) ContentType added in v0.1.43 

func (r RatiosTTMBulkGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RatiosTTMBulkGetClientResponse) GetBody added in v0.1.43 

func (r RatiosTTMBulkGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RatiosTTMBulkGetClientResponse) GetJSON200 added in v0.1.43 

func (r RatiosTTMBulkGetClientResponse) GetJSON200() *[]RatiosTTM

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RatiosTTMBulkGetClientResponse) Status added in v0.1.29 

func (r RatiosTTMBulkGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (RatiosTTMBulkGetClientResponse) StatusCode added in v0.1.29 

func (r RatiosTTMBulkGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RatiosTTMGetClientResponse added in v0.1.13 

type RatiosTTMGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]RatiosTTM
}

func ParseRatiosTTMGetClientResponse added in v0.1.13 

func ParseRatiosTTMGetClientResponse(rsp *http.Response) (*RatiosTTMGetClientResponse, error)

ParseRatiosTTMGetClientResponse parses an HTTP response from a RatiosTTMGetWithResponse call

func (RatiosTTMGetClientResponse) ContentType added in v0.1.43 

func (r RatiosTTMGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RatiosTTMGetClientResponse) GetBody added in v0.1.43 

func (r RatiosTTMGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RatiosTTMGetClientResponse) GetJSON200 added in v0.1.43 

func (r RatiosTTMGetClientResponse) GetJSON200() *[]RatiosTTM

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RatiosTTMGetClientResponse) Status added in v0.1.13 

func (r RatiosTTMGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (RatiosTTMGetClientResponse) StatusCode added in v0.1.13 

func (r RatiosTTMGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RatiosTTMGetParams added in v0.1.13 

type RatiosTTMGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

RatiosTTMGetParams defines parameters for RatiosTTMGet.

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RevenueGeographicSegmentationGetClientResponse 

type RevenueGeographicSegmentationGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]RevenueSegmentation
}

func ParseRevenueGeographicSegmentationGetClientResponse 

func ParseRevenueGeographicSegmentationGetClientResponse(rsp *http.Response) (*RevenueGeographicSegmentationGetClientResponse, error)

ParseRevenueGeographicSegmentationGetClientResponse parses an HTTP response from a RevenueGeographicSegmentationGetWithResponse call

func (RevenueGeographicSegmentationGetClientResponse) ContentType added in v0.1.43 

func (r RevenueGeographicSegmentationGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RevenueGeographicSegmentationGetClientResponse) GetBody added in v0.1.43 

func (r RevenueGeographicSegmentationGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RevenueGeographicSegmentationGetClientResponse) GetJSON200 added in v0.1.43 

func (r RevenueGeographicSegmentationGetClientResponse) GetJSON200() *[]RevenueSegmentation

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RevenueGeographicSegmentationGetClientResponse) Status 

func (r RevenueGeographicSegmentationGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (RevenueGeographicSegmentationGetClientResponse) StatusCode 

func (r RevenueGeographicSegmentationGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RevenueGeographicSegmentationGetParams 

type RevenueGeographicSegmentationGetParams struct {
	Symbol    string  `form:"symbol" json:"symbol"`
	Period    *Period `form:"period,omitempty" json:"period,omitempty"`
	Structure *string `form:"structure,omitempty" json:"structure,omitempty"`
}

RevenueGeographicSegmentationGetParams defines parameters for RevenueGeographicSegmentationGet.

type RevenueProductSegmentationGetClientResponse 

type RevenueProductSegmentationGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]RevenueSegmentation
}

func ParseRevenueProductSegmentationGetClientResponse 

func ParseRevenueProductSegmentationGetClientResponse(rsp *http.Response) (*RevenueProductSegmentationGetClientResponse, error)

ParseRevenueProductSegmentationGetClientResponse parses an HTTP response from a RevenueProductSegmentationGetWithResponse call

func (RevenueProductSegmentationGetClientResponse) ContentType added in v0.1.43 

func (r RevenueProductSegmentationGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RevenueProductSegmentationGetClientResponse) GetBody added in v0.1.43 

func (r RevenueProductSegmentationGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RevenueProductSegmentationGetClientResponse) GetJSON200 added in v0.1.43 

func (r RevenueProductSegmentationGetClientResponse) GetJSON200() *[]RevenueSegmentation

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RevenueProductSegmentationGetClientResponse) Status 

func (r RevenueProductSegmentationGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (RevenueProductSegmentationGetClientResponse) StatusCode 

func (r RevenueProductSegmentationGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RevenueProductSegmentationGetParams 

type RevenueProductSegmentationGetParams struct {
	Symbol    string  `form:"symbol" json:"symbol"`
	Period    *Period `form:"period,omitempty" json:"period,omitempty"`
	Structure *string `form:"structure,omitempty" json:"structure,omitempty"`
}

RevenueProductSegmentationGetParams defines parameters for RevenueProductSegmentationGet.

type RevenueSegmentation 

type RevenueSegmentation struct {
	// Data Example: {"Mac":29984000000,"Service":96169000000,"Wearables, Home and Accessories":37005000000,"iPad":26694000000,"iPhone":201183000000}
	Data map[string]float32 `json:"data"`

	// Date Example: 2024-09-28
	Date openapi_types.Date `json:"date"`

	// FiscalYear Example: 2024
	FiscalYear int `json:"fiscalYear"`

	// Period Example: FY
	Period           string  `json:"period"`
	ReportedCurrency *string `json:"reportedCurrency"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`
}

RevenueSegmentation defines model for RevenueSegmentation.

type SearchNameGetClientResponse 

type SearchNameGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]SearchSymbol
}

func ParseSearchNameGetClientResponse 

func ParseSearchNameGetClientResponse(rsp *http.Response) (*SearchNameGetClientResponse, error)

ParseSearchNameGetClientResponse parses an HTTP response from a SearchNameGetWithResponse call

func (SearchNameGetClientResponse) ContentType added in v0.1.43 

func (r SearchNameGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SearchNameGetClientResponse) GetBody added in v0.1.43 

func (r SearchNameGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SearchNameGetClientResponse) GetJSON200 added in v0.1.43 

func (r SearchNameGetClientResponse) GetJSON200() *[]SearchSymbol

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SearchNameGetClientResponse) Status 

func (r SearchNameGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (SearchNameGetClientResponse) StatusCode 

func (r SearchNameGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchNameGetParams 

type SearchNameGetParams struct {
	SearchSymbol string  `form:"search-symbol" json:"search-symbol"`
	Limit        *int    `form:"limit,omitempty" json:"limit,omitempty"`
	Exchange     *string `form:"exchange,omitempty" json:"exchange,omitempty"`
}

SearchNameGetParams defines parameters for SearchNameGet.

type SearchSymbol 

type SearchSymbol struct {
	// Currency Example: USD
	Currency string `json:"currency"`

	// Exchange Example: NASDAQ
	Exchange string `json:"exchange"`

	// ExchangeFullName Example: NASDAQ Global Select
	ExchangeFullName string `json:"exchangeFullName"`

	// Name Example: Apple Inc.
	Name string `json:"name"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`
}

SearchSymbol defines model for SearchSymbol.

type SearchSymbolGetClientResponse 

type SearchSymbolGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]SearchSymbol
}

func ParseSearchSymbolGetClientResponse 

func ParseSearchSymbolGetClientResponse(rsp *http.Response) (*SearchSymbolGetClientResponse, error)

ParseSearchSymbolGetClientResponse parses an HTTP response from a SearchSymbolGetWithResponse call

func (SearchSymbolGetClientResponse) ContentType added in v0.1.43 

func (r SearchSymbolGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SearchSymbolGetClientResponse) GetBody added in v0.1.43 

func (r SearchSymbolGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SearchSymbolGetClientResponse) GetJSON200 added in v0.1.43 

func (r SearchSymbolGetClientResponse) GetJSON200() *[]SearchSymbol

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SearchSymbolGetClientResponse) Status 

func (r SearchSymbolGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (SearchSymbolGetClientResponse) StatusCode 

func (r SearchSymbolGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchSymbolGetParams 

type SearchSymbolGetParams struct {
	Query    string  `form:"query" json:"query"`
	Limit    *int    `form:"limit,omitempty" json:"limit,omitempty"`
	Exchange *string `form:"exchange,omitempty" json:"exchange,omitempty"`
}

SearchSymbolGetParams defines parameters for SearchSymbolGet.

type SharesFloatGetClientResponse 

type SharesFloatGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]CompanySharesFloat
}

func ParseSharesFloatGetClientResponse 

func ParseSharesFloatGetClientResponse(rsp *http.Response) (*SharesFloatGetClientResponse, error)

ParseSharesFloatGetClientResponse parses an HTTP response from a SharesFloatGetWithResponse call

func (SharesFloatGetClientResponse) ContentType added in v0.1.43 

func (r SharesFloatGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SharesFloatGetClientResponse) GetBody added in v0.1.43 

func (r SharesFloatGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SharesFloatGetClientResponse) GetJSON200 added in v0.1.43 

func (r SharesFloatGetClientResponse) GetJSON200() *[]CompanySharesFloat

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SharesFloatGetClientResponse) Status 

func (r SharesFloatGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (SharesFloatGetClientResponse) StatusCode 

func (r SharesFloatGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SharesFloatGetParams 

type SharesFloatGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
}

SharesFloatGetParams defines parameters for SharesFloatGet.

type ShortQuote 

type ShortQuote struct {
	// Change Example: 4.79
	Change float64 `json:"change"`

	// Price Example: 232.8
	Price float64 `json:"price"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`

	// Volume Example: 44489128
	Volume int `json:"volume"`
}

ShortQuote defines model for ShortQuote.

type SplitEvent added in v0.1.7 

type SplitEvent struct {
	// Date Example: 2025-02-03
	Date openapi_types.Date `json:"date"`

	// Denominator Example: 80
	Denominator float64 `json:"denominator"`

	// Numerator Example: 1
	Numerator float64 `json:"numerator"`
	SplitType string  `json:"splitType"`

	// Symbol Example: EYEN
	Symbol string `json:"symbol"`
}

SplitEvent defines model for SplitEvent.

type SplitsCalendarGetClientResponse added in v0.1.53 

type SplitsCalendarGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]SplitEvent
}

func ParseSplitsCalendarGetClientResponse added in v0.1.53 

func ParseSplitsCalendarGetClientResponse(rsp *http.Response) (*SplitsCalendarGetClientResponse, error)

ParseSplitsCalendarGetClientResponse parses an HTTP response from a SplitsCalendarGetWithResponse call

func (SplitsCalendarGetClientResponse) ContentType added in v0.1.53 

func (r SplitsCalendarGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SplitsCalendarGetClientResponse) GetBody added in v0.1.53 

func (r SplitsCalendarGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SplitsCalendarGetClientResponse) GetJSON200 added in v0.1.53 

func (r SplitsCalendarGetClientResponse) GetJSON200() *[]SplitEvent

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SplitsCalendarGetClientResponse) Status added in v0.1.53 

func (r SplitsCalendarGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (SplitsCalendarGetClientResponse) StatusCode added in v0.1.53 

func (r SplitsCalendarGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SplitsCalendarGetParams added in v0.1.53 

type SplitsCalendarGetParams struct {
	From *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`
	To   *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`
}

SplitsCalendarGetParams defines parameters for SplitsCalendarGet.

type SplitsGetClientResponse added in v0.1.53 

type SplitsGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]SplitEvent
}

func ParseSplitsGetClientResponse added in v0.1.53 

func ParseSplitsGetClientResponse(rsp *http.Response) (*SplitsGetClientResponse, error)

ParseSplitsGetClientResponse parses an HTTP response from a SplitsGetWithResponse call

func (SplitsGetClientResponse) ContentType added in v0.1.53 

func (r SplitsGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SplitsGetClientResponse) GetBody added in v0.1.53 

func (r SplitsGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SplitsGetClientResponse) GetJSON200 added in v0.1.53 

func (r SplitsGetClientResponse) GetJSON200() *[]SplitEvent

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SplitsGetClientResponse) Status added in v0.1.53 

func (r SplitsGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (SplitsGetClientResponse) StatusCode added in v0.1.53 

func (r SplitsGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SplitsGetParams added in v0.1.53 

type SplitsGetParams struct {
	Symbol string `form:"symbol" json:"symbol"`
	Limit  *int   `form:"limit,omitempty" json:"limit,omitempty"`
}

SplitsGetParams defines parameters for SplitsGet.

type StockActivity added in v0.1.54 

type StockActivity struct {
	Change            float64 `json:"change"`
	ChangesPercentage float64 `json:"changesPercentage"`
	Exchange          string  `json:"exchange"`
	Name              string  `json:"name"`
	Price             float64 `json:"price"`
	Symbol            string  `json:"symbol"`
}

StockActivity defines model for StockActivity.

type StockListGetClientResponse added in v0.1.5 

type StockListGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]CompanySymbol
}

func ParseStockListGetClientResponse added in v0.1.5 

func ParseStockListGetClientResponse(rsp *http.Response) (*StockListGetClientResponse, error)

ParseStockListGetClientResponse parses an HTTP response from a StockListGetWithResponse call

func (StockListGetClientResponse) ContentType added in v0.1.43 

func (r StockListGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (StockListGetClientResponse) GetBody added in v0.1.43 

func (r StockListGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (StockListGetClientResponse) GetJSON200 added in v0.1.43 

func (r StockListGetClientResponse) GetJSON200() *[]CompanySymbol

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (StockListGetClientResponse) Status added in v0.1.5 

func (r StockListGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (StockListGetClientResponse) StatusCode added in v0.1.5 

func (r StockListGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StockRating added in v0.1.29 

type StockRating struct {
	// DebtToEquityScore Example: 4
	DebtToEquityScore int `json:"debtToEquityScore"`

	// DiscountedCashFlowScore Example: 3
	DiscountedCashFlowScore int `json:"discountedCashFlowScore"`

	// OverallScore Example: 4
	OverallScore int `json:"overallScore"`

	// PriceToBookScore Example: 1
	PriceToBookScore int `json:"priceToBookScore"`

	// PriceToEarningsScore Example: 2
	PriceToEarningsScore int `json:"priceToEarningsScore"`

	// Rating Example: A-
	Rating string `json:"rating"`

	// ReturnOnAssetsScore Example: 5
	ReturnOnAssetsScore int `json:"returnOnAssetsScore"`

	// ReturnOnEquityScore Example: 5
	ReturnOnEquityScore int `json:"returnOnEquityScore"`

	// Symbol Example: AAPL
	Symbol string `json:"symbol"`
}

StockRating defines model for StockRating.

type TechnicalIndicator added in v0.1.23 

type TechnicalIndicator struct {
	// Close Example: 232.8
	Close float64 `json:"close"`

	// Date Example: date-time
	Date string `json:"date"`

	// High Example: 233.13
	High float64 `json:"high"`

	// Low Example: 226.65
	Low float64 `json:"low"`

	// Open Example: 227.2
	Open float64 `json:"open"`

	// Rsi Example: 231.215
	Rsi *float64 `json:"rsi,omitempty"`

	// Volume Example: 44489128
	Volume float64 `json:"volume"`
}

TechnicalIndicator defines model for TechnicalIndicator.

type TechnicalIndicatorsRsiGetClientResponse added in v0.1.23 

type TechnicalIndicatorsRsiGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]TechnicalIndicator
}

func ParseTechnicalIndicatorsRsiGetClientResponse added in v0.1.23 

func ParseTechnicalIndicatorsRsiGetClientResponse(rsp *http.Response) (*TechnicalIndicatorsRsiGetClientResponse, error)

ParseTechnicalIndicatorsRsiGetClientResponse parses an HTTP response from a TechnicalIndicatorsRsiGetWithResponse call

func (TechnicalIndicatorsRsiGetClientResponse) ContentType added in v0.1.43 

func (r TechnicalIndicatorsRsiGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (TechnicalIndicatorsRsiGetClientResponse) GetBody added in v0.1.43 

func (r TechnicalIndicatorsRsiGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (TechnicalIndicatorsRsiGetClientResponse) GetJSON200 added in v0.1.43 

func (r TechnicalIndicatorsRsiGetClientResponse) GetJSON200() *[]TechnicalIndicator

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (TechnicalIndicatorsRsiGetClientResponse) Status added in v0.1.23 

func (r TechnicalIndicatorsRsiGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (TechnicalIndicatorsRsiGetClientResponse) StatusCode added in v0.1.23 

func (r TechnicalIndicatorsRsiGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TechnicalIndicatorsRsiGetParams added in v0.1.23 

type TechnicalIndicatorsRsiGetParams struct {
	Symbol       string              `form:"symbol" json:"symbol"`
	PeriodLength int                 `form:"periodLength" json:"periodLength"`
	Timeframe    Timeframe           `form:"timeframe" json:"timeframe"`
	From         *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`
	To           *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`
}

TechnicalIndicatorsRsiGetParams defines parameters for TechnicalIndicatorsRsiGet.

type Timeframe added in v0.1.23 

type Timeframe string

Timeframe Time frame 

const (
	N1day Timeframe = "1day"
)

Defines values for Timeframe.

func (Timeframe) Valid added in v0.1.34 

func (e Timeframe) Valid() bool

Valid indicates whether the value is a known member of the Timeframe enum.

type TreasuryRates 

type TreasuryRates struct {
	// Date Example: 2024-02-29
	Date openapi_types.Date `json:"date"`

	// Month1 Example: 5.53
	Month1 float64 `json:"month1"`

	// Month2 Example: 5.5
	Month2 float64 `json:"month2"`

	// Month3 Example: 5.45
	Month3 float64 `json:"month3"`

	// Month6 Example: 5.3
	Month6 float64 `json:"month6"`

	// Year1 Example: 5.01
	Year1 float64 `json:"year1"`

	// Year10 Example: 4.25
	Year10 float64 `json:"year10"`

	// Year2 Example: 4.64
	Year2 float64 `json:"year2"`

	// Year20 Example: 4.51
	Year20 float64 `json:"year20"`

	// Year3 Example: 4.43
	Year3 float64 `json:"year3"`

	// Year30 Example: 4.38
	Year30 float64 `json:"year30"`

	// Year5 Example: 4.26
	Year5 float64 `json:"year5"`

	// Year7 Example: 4.28
	Year7 float64 `json:"year7"`
}

TreasuryRates defines model for TreasuryRates.

type TreasuryRatesGetClientResponse 

type TreasuryRatesGetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]TreasuryRates
}

func ParseTreasuryRatesGetClientResponse 

func ParseTreasuryRatesGetClientResponse(rsp *http.Response) (*TreasuryRatesGetClientResponse, error)

ParseTreasuryRatesGetClientResponse parses an HTTP response from a TreasuryRatesGetWithResponse call

func (TreasuryRatesGetClientResponse) ContentType added in v0.1.43 

func (r TreasuryRatesGetClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (TreasuryRatesGetClientResponse) GetBody added in v0.1.43 

func (r TreasuryRatesGetClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (TreasuryRatesGetClientResponse) GetJSON200 added in v0.1.43 

func (r TreasuryRatesGetClientResponse) GetJSON200() *[]TreasuryRates

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (TreasuryRatesGetClientResponse) Status 

func (r TreasuryRatesGetClientResponse) Status() string

Status returns HTTPResponse.Status

func (TreasuryRatesGetClientResponse) StatusCode 

func (r TreasuryRatesGetClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TreasuryRatesGetParams 

type TreasuryRatesGetParams struct {
	From *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`
	To   *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`
}

TreasuryRatesGetParams defines parameters for TreasuryRatesGet.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.