models

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: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BranchV1 

type BranchV1 struct {
	ID       int    `json:"id"`
	Name     string `json:"name"`
	SectorID int    `json:"sectorId"`
}

BranchV1 represents an industry branch (sub-sector) with its ID, name, and parent sector ID.

type BranchesResponse 

type BranchesResponse struct {
	Branches []BranchV1 `json:"branches"`
}

BranchesResponse is the top-level response from the branches metadata endpoint.

type BuybackHoldingsResponse 

type BuybackHoldingsResponse struct {
	List []BuybackRespV1 `json:"list"`
}

BuybackHoldingsResponse is the top-level response from the buyback holdings endpoint.

type BuybackRespV1 

type BuybackRespV1 struct {
	InsID  int64          `json:"insId"`
	Values []BuybackRowV1 `json:"values"`
	Error  string         `json:"error"`
}

BuybackRespV1 represents share buyback data for a single instrument.

type BuybackRowV1 

type BuybackRowV1 struct {
	Change     int64   `json:"change"`
	ChangeProc float64 `json:"changeProc"`
	Price      float64 `json:"price"`
	Currency   string  `json:"currency"`
	Shares     int64   `json:"shares"`
	SharesProc float64 `json:"sharesProc"`
	Date       string  `json:"date"`
}

BuybackRowV1 represents a single share buyback entry with share change, price, and date.

type CountriesResponse 

type CountriesResponse struct {
	Countries []CountryV1 `json:"countries"`
}

CountriesResponse is the top-level response from the countries metadata endpoint.

type CountryV1 

type CountryV1 struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
}

CountryV1 represents a country with its ID and name.

type DividendCalendarRespV1 

type DividendCalendarRespV1 struct {
	InsID  int64            `json:"insId"`
	Values []DividendDateV1 `json:"values"`
	Error  string           `json:"error"`
}

DividendCalendarRespV1 represents the dividend calendar for a single instrument, containing upcoming dividend dates.

type DividendCalendarResponse 

type DividendCalendarResponse struct {
	List []DividendCalendarRespV1 `json:"list"`
}

DividendCalendarResponse is the top-level response from the dividend calendar endpoint.

type DividendDateV1 

type DividendDateV1 struct {
	AmountPaid            float64 `json:"amountPaid"`
	CurrencyShortName     string  `json:"currencyShortName"`
	DistributionFrequency int     `json:"distributionFrequency"`
	ExcludingDate         string  `json:"excludingDate"`
	DividendType          int     `json:"dividendType"`
}

DividendDateV1 represents a single dividend payment entry with amount, currency, ex-date, and distribution frequency.

type InsiderHoldingsResponse 

type InsiderHoldingsResponse struct {
	List []InsiderRespV1 `json:"list"`
}

InsiderHoldingsResponse is the top-level response from the insider holdings endpoint.

type InsiderRespV1 

type InsiderRespV1 struct {
	InsID  int64          `json:"insId"`
	Values []InsiderRowV1 `json:"values"`
	Error  string         `json:"error"`
}

InsiderRespV1 represents insider transactions for a single instrument.

type InsiderRowV1 

type InsiderRowV1 struct {
	Misc             bool    `json:"misc"`
	OwnerName        string  `json:"ownerName"`
	OwnerPosition    string  `json:"ownerPosition"`
	EquityProgram    bool    `json:"equityProgram"`
	Shares           int64   `json:"shares"`
	Price            float64 `json:"price"`
	Amount           float64 `json:"amount"`
	Currency         string  `json:"currency"`
	TransactionType  int     `json:"transactionType"`
	VerificationDate string  `json:"verificationDate"`
	TransactionDate  string  `json:"transactionDate"`
}

InsiderRowV1 represents a single insider transaction with owner details, share count, price, and transaction date.

type InstrumentUpdatedV1 

type InstrumentUpdatedV1 struct {
	InsID       int64  `json:"insId"`
	UpdatedDate string `json:"updatedDate"`
}

InstrumentUpdatedV1 represents the last update timestamp for an instrument.

type InstrumentV1 

type InstrumentV1 struct {
	InsID        int64  `json:"insId"`
	Name         string `json:"name"`
	URLName      string `json:"urlName"`
	Instrument   int    `json:"instrument"`
	ISIN         string `json:"isin"`
	Ticker       string `json:"ticker"`
	Yahoo        string `json:"yahoo"`
	SectorID     int    `json:"sectorId"`
	MarketID     int    `json:"marketId"`
	BranchID     int    `json:"branchId"`
	CountryID    int    `json:"countryId"`
	ListingDate  string `json:"listingDate"`
	StockPriceID int64  `json:"stockPriceId"`
}

InstrumentV1 represents a financial instrument (stock) with identifiers, ticker, ISIN, and classification IDs.

type InstrumentsResponse 

type InstrumentsResponse struct {
	Instruments []InstrumentV1 `json:"instruments"`
}

InstrumentsResponse is the top-level response from the instruments listing endpoint.

type InstrumentsUpdatedResponse 

type InstrumentsUpdatedResponse struct {
	Instruments []InstrumentUpdatedV1 `json:"instruments"`
}

InstrumentsUpdatedResponse is the top-level response from the instruments updated endpoint.

type KpiAllCompV1 

type KpiAllCompV1 struct {
	I int64   `json:"i"` // Instrument ID
	N float64 `json:"n"` // Value
}

KpiAllCompV1 represents a KPI value for a single instrument in an all-companies screener response.

type KpiHistoryV1 

type KpiHistoryV1 struct {
	Y int     `json:"y"` // Year
	P int     `json:"p"` // Period
	V float64 `json:"v"` // Value
}

KpiHistoryV1 represents a historical KPI data point with year, period, and value.

type KpiMetadataV1 

type KpiMetadataV1 struct {
	KpiID          int    `json:"kpiId"`
	NameSv         string `json:"nameSv"`
	NameEn         string `json:"nameEn"`
	AbbreviationSv string `json:"abbreviationSv"`
	AbbreviationEn string `json:"abbreviationEn"`
	IsString       bool   `json:"isString"`
}

KpiMetadataV1 represents metadata for a KPI, including its ID, Swedish/English names, and abbreviations.

type KpiScreenerResponse 

type KpiScreenerResponse struct {
	KpiID       int              `json:"kpiId"`
	Group       string           `json:"group"`
	Calculation string           `json:"calculation"`
	Value       KpiScreenerValue `json:"value"`
}

KpiScreenerResponse is the top-level response from the KPI screener endpoint, containing the KPI ID, group, calculation method, and value.

type KpiScreenerValue 

type KpiScreenerValue struct {
	I int64    `json:"i"`
	N float64  `json:"n"`
	S *float64 `json:"s"`
}

KpiScreenerValue represents a single KPI screener value for one instrument. API returns: {"kpiId":2,"group":"1year","calculation":"mean","value":{"i":2,"n":20.95,"s":null}}

type KpiV1 

type KpiV1 struct {
	I int64   `json:"i"` // Instrument ID
	N int     `json:"n"` // KPI ID
	V float64 `json:"v"` // Value
}

KpiV1 represents a single KPI value for an instrument, used in screener and list screener responses.

type KpisAllCompResponse 

type KpisAllCompResponse struct {
	Values []KpiAllCompV1 `json:"values"`
}

KpisAllCompResponse is the top-level response from the KPI all-companies screener endpoint.

type KpisCalcUpdatedResponse 

type KpisCalcUpdatedResponse struct {
	Instruments []KpisCalcUpdatedV1 `json:"instruments"`
}

KpisCalcUpdatedResponse is the top-level response from the KPI calculation updated endpoint.

type KpisCalcUpdatedV1 

type KpisCalcUpdatedV1 struct {
	InsID       int64  `json:"insId"`
	UpdatedDate string `json:"updatedDate"`
}

KpisCalcUpdatedV1 represents the last KPI calculation update timestamp for an instrument.

type KpisHistoryResponse 

type KpisHistoryResponse struct {
	Values []KpiHistoryV1 `json:"values"`
}

KpisHistoryResponse is the top-level response from the KPI history endpoint.

type KpisMetadataResponse 

type KpisMetadataResponse struct {
	KpiHistoryMetadatas []KpiMetadataV1 `json:"kpiHistoryMetadatas"`
}

KpisMetadataResponse is the top-level response from the KPI metadata endpoint.

type KpisResponse 

type KpisResponse struct {
	Values []KpiV1 `json:"values"`
}

KpisResponse is the top-level response for KPI list screener queries.

type KpisSummaryGroupV1 

type KpisSummaryGroupV1 struct {
	KpiID  int                  `json:"KpiId"`
	Values []KpisSummaryValueV1 `json:"values"`
}

KpisSummaryGroupV1 represents a group of KPI summary values for a specific KPI ID.

type KpisSummaryResponse 

type KpisSummaryResponse struct {
	Instrument int                  `json:"instrument"`
	ReportType string               `json:"reportType"`
	Kpis       []KpisSummaryGroupV1 `json:"kpis"`
}

KpisSummaryResponse is the top-level response from the KPI summary endpoint for a single instrument.

type KpisSummaryValueV1 

type KpisSummaryValueV1 struct {
	Y int     `json:"y"`
	P int     `json:"p"`
	V float64 `json:"v"`
}

KpisSummaryValueV1 represents a single KPI summary data point.

type MarketV1 

type MarketV1 struct {
	ID           int    `json:"id"`
	Name         string `json:"name"`
	CountryID    int    `json:"countryId"`
	IsIndex      bool   `json:"isIndex"`
	ExchangeName string `json:"exchangeName"`
}

MarketV1 represents a stock market/exchange with its country, name, and whether it is an index.

type MarketsResponse 

type MarketsResponse struct {
	Markets []MarketV1 `json:"markets"`
}

MarketsResponse is the top-level response from the markets metadata endpoint.

type ReportCalendarDateV1 

type ReportCalendarDateV1 struct {
	ReleaseDate string `json:"releaseDate"`
	ReportType  string `json:"reportType"`
}

ReportCalendarDateV1 represents a single report release date entry with the date and report type (e.g. Q1, Q2, annual).

type ReportCalendarRespV1 

type ReportCalendarRespV1 struct {
	InsID  int64                  `json:"insId"`
	Values []ReportCalendarDateV1 `json:"values"`
	Error  string                 `json:"error"`
}

ReportCalendarRespV1 represents the report calendar for a single instrument, containing upcoming report release dates.

type ReportCalendarResponse 

type ReportCalendarResponse struct {
	List []ReportCalendarRespV1 `json:"list"`
}

ReportCalendarResponse is the top-level response from the report calendar endpoint.

type ReportMetadataResponse 

type ReportMetadataResponse struct {
	ReportMetadatas []ReportMetadataV1 `json:"reportMetadatas"`
}

ReportMetadataResponse is the top-level response from the report metadata endpoint.

type ReportMetadataV1 

type ReportMetadataV1 struct {
	ReportID int    `json:"reportId"`
	NameSv   string `json:"nameSv"`
	NameEn   string `json:"nameEn"`
}

ReportMetadataV1 represents metadata for a financial report field, including its Swedish and English names.

type ReportV1 

type ReportV1 struct {
	Year                      int     `json:"year"`
	Period                    int     `json:"period"`
	Revenues                  float64 `json:"revenues"`
	Gross_Income              float64 `json:"gross_Income"`
	Operating_Income          float64 `json:"operating_Income"`
	Profit_Before_Tax         float64 `json:"profit_Before_Tax"`
	Profit_To_Equity_Holders  float64 `json:"profit_To_Equity_Holders"`
	Earnings_Per_Share        float64 `json:"earnings_Per_Share"`
	NumberOfShares            float64 `json:"numberOfShares"`
	Dividend                  float64 `json:"dividend"`
	IntangibleAssets          float64 `json:"intangibleAssets"`
	TangibleAssets            float64 `json:"tangibleAssets"`
	FinancialAssets           float64 `json:"financialAssets"`
	NonCurrentAssets          float64 `json:"nonCurrentAssets"`
	CashAndEquivalents        float64 `json:"cashAndEquivalents"`
	CurrentAssets             float64 `json:"currentAssets"`
	TotalAssets               float64 `json:"totalAssets"`
	TotalEquity               float64 `json:"totalEquity"`
	NonCurrentLiabilities     float64 `json:"nonCurrentLiabilities"`
	CurrentLiabilities        float64 `json:"currentLiabilities"`
	TotalLiabilitiesAndEquity float64 `json:"totalLiabilitiesAndEquity"`
	Net_Debt                  float64 `json:"net_Debt"`
	ReportStartDate           string  `json:"report_Start_Date"`
	ReportEndDate             string  `json:"report_End_Date"`
	Currency                  string  `json:"currency"`
}

ReportV1 represents a financial report with income statement, balance sheet, and share data for a given period.

type ReportsCompoundResponse 

type ReportsCompoundResponse struct {
	ReportsYear    []ReportV1 `json:"reportsYear"`
	ReportsR12     []ReportV1 `json:"reportsR12"`
	ReportsQuarter []ReportV1 `json:"reportsQuarter"`
}

ReportsCompoundResponse is the top-level response when requesting all report types at once (yearly, R12, and quarterly).

type ReportsResponse 

type ReportsResponse struct {
	Reports []ReportV1 `json:"reports"`
}

ReportsResponse is the top-level response for single-type report queries (yearly, R12, or quarterly).

type SectorV1 

type SectorV1 struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
}

SectorV1 represents an industry sector with its ID and name.

type SectorsResponse 

type SectorsResponse struct {
	Sectors []SectorV1 `json:"sectors"`
}

SectorsResponse is the top-level response from the sectors metadata endpoint.

type ShortHoldingsResponse 

type ShortHoldingsResponse struct {
	List []ShortsRespV1 `json:"list"`
}

ShortHoldingsResponse is the top-level response from the short holdings endpoint.

type ShortsRespV1 

type ShortsRespV1 struct {
	InsID               int64    `json:"insId"`
	ShortsProc          *float64 `json:"shortsProc"`
	ShortsHolders       *float64 `json:"shortsHolders"`
	ShortsAvgProc       *float64 `json:"shortsAvgProc"`
	ShortsMilj          *float64 `json:"shortsMilj"`
	ShortsAvgMilj       *float64 `json:"shortsAvgMilj"`
	LastTransactionDate *string  `json:"lastTransactionDate"`
	DtcSum              *float64 `json:"dtcSum"`
	DtcAvg              *float64 `json:"dtcAvg"`
	Trend1w             float64  `json:"trend1w"`
	Trend1m             float64  `json:"trend1m"`
	Trend3m             float64  `json:"trend3m"`
	Trend6m             float64  `json:"trend6m"`
}

ShortsRespV1 represents short position summary for a single instrument.

type StockPriceDateV1 

type StockPriceDateV1 struct {
	I int64   `json:"i"` // Instrument ID
	D string  `json:"d"` // Date
	C float64 `json:"c"` // Close
	H float64 `json:"h"` // High
	L float64 `json:"l"` // Low
	O float64 `json:"o"` // Open
	V int64   `json:"v"` // Volume
}

StockPriceDateV1 represents a stock price for an instrument on a specific date, including the instrument ID and OHLCV data.

type StockPriceLastV1 

type StockPriceLastV1 struct {
	I int64   `json:"i"` // Instrument ID
	D string  `json:"d"` // Date
	C float64 `json:"c"` // Close
	H float64 `json:"h"` // High
	L float64 `json:"l"` // Low
	O float64 `json:"o"` // Open
	V int64   `json:"v"` // Volume
}

StockPriceLastV1 represents the latest stock price for an instrument, including the instrument ID and OHLCV data.

type StockPriceV1 

type StockPriceV1 struct {
	D string  `json:"d"` // Date
	C float64 `json:"c"` // Close
	H float64 `json:"h"` // High
	L float64 `json:"l"` // Low
	O float64 `json:"o"` // Open
	V int64   `json:"v"` // Volume
}

StockPriceV1 represents a daily stock price entry with OHLCV data for a single instrument.

type StockPricesDateResponse 

type StockPricesDateResponse struct {
	StockPricesList []StockPriceDateV1 `json:"stockPricesList"`
}

StockPricesDateResponse is the top-level response from the stock prices by date endpoint.

type StockPricesLastResponse 

type StockPricesLastResponse struct {
	StockPricesList []StockPriceLastV1 `json:"stockPricesList"`
}

StockPricesLastResponse is the top-level response from the latest stock prices endpoint.

type StockPricesResponse 

type StockPricesResponse struct {
	StockPricesList []StockPriceV1 `json:"stockPricesList"`
}

StockPricesResponse is the top-level response from the stock prices endpoint for a single instrument.

type StockSplitV1 

type StockSplitV1 struct {
	InsID     int64   `json:"insId"`
	SplitDate string  `json:"splitDate"`
	SplitType string  `json:"splitType"`
	Ratio     float64 `json:"ratio"`
}

StockSplitV1 represents a stock split event with the split date, type, and ratio.

type StockSplitsResponse 

type StockSplitsResponse struct {
	StockSplits []StockSplitV1 `json:"stockSplitList"`
}

StockSplitsResponse is the top-level response from the stock splits endpoint.

type TranslationMetadataResponse 

type TranslationMetadataResponse struct {
	TranslationMetadatas []TranslationMetadataV1 `json:"translationMetadatas"`
}

TranslationMetadataResponse is the top-level response from the translation metadata endpoint.

type TranslationMetadataV1 

type TranslationMetadataV1 struct {
	TranslationKey string `json:"translationKey"`
	NameSv         string `json:"nameSv"`
	NameEn         string `json:"nameEn"`
}

TranslationMetadataV1 represents a translation entry with a key and its Swedish and English values.

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.