client

package
v0.0.1 Latest Latest
Warning

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

 Go to latest Published: Mar 25, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client is the Börsdata API client.

func New 

func New(apiKey, version string) *Client

New creates a new Börsdata API client with the given API key.

func NewWithBaseURL 

func NewWithBaseURL(apiKey, baseURL, version string) *Client

NewWithBaseURL creates a new client with a custom base URL (useful for testing).

func (*Client) GetAllReports 

func (c *Client) GetAllReports(insID int64, maxYearCount, maxR12QCount int) (*models.ReportsCompoundResponse, error)

GetAllReports returns all report types (year, r12, quarter) for an instrument.

func (*Client) GetBranches 

func (c *Client) GetBranches() (*models.BranchesResponse, error)

GetBranches returns all branches.

func (*Client) GetBuybackHoldings 

func (c *Client) GetBuybackHoldings(instList string) (*models.BuybackHoldingsResponse, error)

GetBuybackHoldings returns share buybacks for the given instruments.

func (*Client) GetCountries 

func (c *Client) GetCountries() (*models.CountriesResponse, error)

GetCountries returns all countries.

func (*Client) GetDividendCalendar 

func (c *Client) GetDividendCalendar(instList string) (*models.DividendCalendarResponse, error)

GetDividendCalendar returns dividend dates for the given instruments.

func (*Client) GetGlobalInstruments 

func (c *Client) GetGlobalInstruments() (*models.InstrumentsResponse, error)

GetGlobalInstruments returns all global (non-Nordic) instruments. Requires Pro+ API access.

func (*Client) GetGlobalKpiListScreener 

func (c *Client) GetGlobalKpiListScreener(kpiID int, calcGroup, calcType string) (*models.KpisAllCompResponse, error)

GetGlobalKpiListScreener returns a KPI value for all global instruments. Requires Pro+ API access.

func (*Client) GetGlobalLatestStockPrices 

func (c *Client) GetGlobalLatestStockPrices() (*models.StockPricesLastResponse, error)

GetGlobalLatestStockPrices returns the latest stock prices for all global instruments. Requires Pro+ API access.

func (*Client) GetGlobalStockPricesByDate 

func (c *Client) GetGlobalStockPricesByDate(date string) (*models.StockPricesDateResponse, error)

GetGlobalStockPricesByDate returns stock prices for all global instruments on a specific date. Requires Pro+ API access.

func (*Client) GetInsiderHoldings 

func (c *Client) GetInsiderHoldings(instList string) (*models.InsiderHoldingsResponse, error)

GetInsiderHoldings returns insider transactions for the given instruments.

func (*Client) GetInstruments 

func (c *Client) GetInstruments() (*models.InstrumentsResponse, error)

GetInstruments returns all instruments (companies).

func (*Client) GetInstrumentsUpdated 

func (c *Client) GetInstrumentsUpdated() (*models.InstrumentsUpdatedResponse, error)

GetInstrumentsUpdated returns update timestamps for all instruments.

func (*Client) GetKpiHistory 

func (c *Client) GetKpiHistory(insID int64, kpiID int, reportType, priceType string, maxCount int) (*models.KpisHistoryResponse, error)

GetKpiHistory returns KPI history for an instrument and KPI. reportType: year, r12, or quarter priceType: mean, high, low, latest

func (*Client) GetKpiListScreener 

func (c *Client) GetKpiListScreener(kpiID int, calcGroup, calcType string) (*models.KpisAllCompResponse, error)

GetKpiListScreener returns a KPI value for all instruments. calcGroup: 1month, 3month, 1year, 3year, 5year, 7year, 10year, 15year, last, quarter calcType: mean, high, low, sum, latest, count

func (*Client) GetKpiMetadata 

func (c *Client) GetKpiMetadata() (*models.KpisMetadataResponse, error)

GetKpiMetadata returns KPI metadata (names, abbreviations, etc).

func (*Client) GetKpiScreener 

func (c *Client) GetKpiScreener(insID int64, kpiID int, calcGroup, calcType string) (*models.KpiScreenerResponse, error)

GetKpiScreener returns a single KPI value for an instrument. calcGroup: 1month, 3month, 1year, 3year, 5year, 7year, 10year, 15year, last, quarter calcType: mean, high, low, sum, latest, count

func (*Client) GetKpiSummary 

func (c *Client) GetKpiSummary(insID int64, reportType string, maxCount int) (*models.KpisSummaryResponse, error)

GetKpiSummary returns KPI summary for an instrument. reportType: year, r12, or quarter

func (*Client) GetKpisUpdated 

func (c *Client) GetKpisUpdated() (*models.KpisCalcUpdatedResponse, error)

GetKpisUpdated returns update timestamps for KPI calculations.

func (*Client) GetLatestStockPrices 

func (c *Client) GetLatestStockPrices() (*models.StockPricesLastResponse, error)

GetLatestStockPrices returns the latest stock prices for all instruments.

func (*Client) GetMarkets 

func (c *Client) GetMarkets() (*models.MarketsResponse, error)

GetMarkets returns all markets.

func (*Client) GetQuarterlyReports 

func (c *Client) GetQuarterlyReports(insID int64, maxCount int) (*models.ReportsResponse, error)

GetQuarterlyReports returns quarterly reports for an instrument.

func (*Client) GetR12Reports 

func (c *Client) GetR12Reports(insID int64, maxCount int) (*models.ReportsResponse, error)

GetR12Reports returns rolling 12-month reports for an instrument.

func (*Client) GetReportCalendar 

func (c *Client) GetReportCalendar(instList string) (*models.ReportCalendarResponse, error)

GetReportCalendar returns report release dates for the given instruments.

func (*Client) GetReportMetadata 

func (c *Client) GetReportMetadata() (*models.ReportMetadataResponse, error)

GetReportMetadata returns report field metadata.

func (*Client) GetSectors 

func (c *Client) GetSectors() (*models.SectorsResponse, error)

GetSectors returns all sectors.

func (*Client) GetShortHoldings 

func (c *Client) GetShortHoldings() (*models.ShortHoldingsResponse, error)

GetShortHoldings returns short positions for all instruments.

func (*Client) GetStockPrices 

func (c *Client) GetStockPrices(insID int64, maxCount int) (*models.StockPricesResponse, error)

GetStockPrices returns stock prices for an instrument. The API does not support server-side limiting, so results are truncated client-side.

func (*Client) GetStockPricesByDate 

func (c *Client) GetStockPricesByDate(date string) (*models.StockPricesDateResponse, error)

GetStockPricesByDate returns stock prices for all instruments on a specific date.

func (*Client) GetStockPricesDateRange 

func (c *Client) GetStockPricesDateRange(insID int64, from, to string) (*models.StockPricesResponse, error)

GetStockPricesDateRange returns stock prices for an instrument within a date range.

func (*Client) GetStockSplits 

func (c *Client) GetStockSplits() (*models.StockSplitsResponse, error)

GetStockSplits returns all stock splits.

func (*Client) GetTranslationMetadata 

func (c *Client) GetTranslationMetadata() (*models.TranslationMetadataResponse, error)

GetTranslationMetadata returns translation metadata.

func (*Client) GetYearlyReports 

func (c *Client) GetYearlyReports(insID int64, maxCount int) (*models.ReportsResponse, error)

GetYearlyReports returns yearly reports for an instrument.

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.