financialmodelingprep

README

Financial Modeling Prep Go SDK

Go SDK for Financial Modeling Prep API:

https://site.financialmodelingprep.com/developer/

Documentation

Index

• Constants
• func Ordered() []string
• type Client
  • func NewClient(apiKey string) *Client
  • func (c *Client) GetIncomeStatement(symbol, period string, limit uint) (*http.Response, error)
• type IncomeStatement
  • func (is *IncomeStatement) CalendarYearInt() (int, error)
• type IncomeStatementOpts
• type IncomeStatements
  • func IncomeStatementParse(r io.Reader) (IncomeStatements, error)
  • func IncomeStatementsParseBytes(data []byte) (IncomeStatements, error)
  • func IncomeStatementsReadFile(filename string) (IncomeStatements, error)
  • func (iss IncomeStatements) ChartAnnual() (chart.Chart, error)
  • func (iss IncomeStatements) FinancialsMatrixAnnual() ([][]int, error)
  • func (iss IncomeStatements) Periods(dedupe bool) []string
  • func (iss IncomeStatements) TimeSeriesSetAnnual() (*timeseries.TimeSeriesSet, error)

Constants

const (
	ServerURL                    = "https://financialmodelingprep.com"
	IncomeStatementURL           = "api/v3/income-statement"
	IncomeStatementURLFormat     = "api/v3/income-statement/%s"
	QueryParamAPIKey             = "apikey"
	QueryParamPeriod             = "period"
	QueryParamPeriodValueAnnual  = "annual"
	QueryParamPeriodValueQuarter = "quarter"
	QueryParamLimit              = "limit"
	QueryParamLimitExample       = uint(100)
)

const (
	Revenue                          = "Revenue"
	CostOfRevenue                    = "Cost of Revenue"
	ResearchAndDevelopmentExpenses   = "Research and Development Expenses"
	GeneralAndAdministrativeExpenses = "General and Administrative Expenses"
	SellingAndMarketingExpenses      = "Selling and Marketing Expenses"
	OtherExpenses                    = "Other Expenses"
	OperatingExpenses                = "Operating Expenses"
	InterestExpense                  = "InterestExpense"
	DepreciationAndAmortization      = "Depreciation and Amortization"
)

const PeriodFY = "FY"

Functions

func Ordered

func Ordered() []string

Types

type Client

type Client struct {
	*httpsimple.Client
}

func NewClient

func NewClient(apiKey string) *Client

func (*Client) GetIncomeStatement

func (c *Client) GetIncomeStatement(symbol, period string, limit uint) (*http.Response, error)

type IncomeStatement

type IncomeStatement struct {
	CalendarYear                     string  `json:"calendarYear"`
	Date                             string  `json:"date"`
	FillingDate                      string  `json:"fillingDate"`
	Period                           string  `json:"period'`
	Symbol                           string  `json:"symbol"`
	Revenue                          float64 `json:"revenue"`
	CostOfRevenue                    float64 `json:"costOfRevenue"`
	GrossProfit                      float64 `json:"grossProfit"`
	ResearchAndDevelopmentExpenses   float64 `json:"researchAndDevelopmentExpenses"`
	GeneralAndAdministrativeExpenses float64 `json:"generalAndAdministrativeExpenses"`
	SellingAndMarketingExpenses      float64 `json:"sellingAndMarketingExpenses"`
	OtherExpenses                    float64 `json:"otherExpenses"`
	OperatingExpenses                float64 `json:"operatingExpenses"`
	CostAndExpenses                  float64 `json:"costAndExpenses"`
	InterestIncome                   float64 `json:"interestIncome"`
	InterestExpense                  float64 `json:"interestExpense"`
	DepreciationAndAmortization      float64 `json:"depreciationAndAmortization"`
	EBITDA                           float64 `json:"ebitda"`
	EBITDAratio                      float64 `json:"ebitdaratio"`
	OperatingIncome                  float64 `json:"operatingIncome"`
	OperatingIncomeRatio             float64 `json:"operatingIncomeRatio"`
	TotalOtherIncomeExpensesNet      float64 `json:"totalOtherIncomeExpensesNet"`
	IncomeBeforeTax                  float64 `json:"incomeBeforeTax"`
	IncomeBeforeTaxRatio             float64 `json:"incomeBeforeTaxRatio"`
	IncomeTaxExpense                 float64 `json:"incomeTaxExpense"`
	NetIncome                        float64 `json:"netIncome"`
}

func (*IncomeStatement) CalendarYearInt

func (is *IncomeStatement) CalendarYearInt() (int, error)

type IncomeStatementOpts

type IncomeStatementOpts struct {
	APIKEY string `url:"apikey"`
	Limit  uint   `url:"limit"`
	Period string `url:"period"`
}

type IncomeStatements

type IncomeStatements []IncomeStatement

func IncomeStatementParse

func IncomeStatementParse(r io.Reader) (IncomeStatements, error)

func IncomeStatementsParseBytes

func IncomeStatementsParseBytes(data []byte) (IncomeStatements, error)

func IncomeStatementsReadFile

func IncomeStatementsReadFile(filename string) (IncomeStatements, error)

func (IncomeStatements) ChartAnnual

func (iss IncomeStatements) ChartAnnual() (chart.Chart, error)

func (IncomeStatements) FinancialsMatrixAnnual

func (iss IncomeStatements) FinancialsMatrixAnnual() ([][]int, error)

func (IncomeStatements) Periods

func (iss IncomeStatements) Periods(dedupe bool) []string

func (IncomeStatements) TimeSeriesSetAnnual

func (iss IncomeStatements) TimeSeriesSetAnnual() (*timeseries.TimeSeriesSet, error)