Copyright	(c) Owen Shepherd 2022
License	MIT
Maintainer	owen@owen.cafe
Safe Haskell	None
Language	Haskell2010

SimFin.Types.StatementQuery

Description

Synopsis

data StatementQuery = StatementQuery {
- stockRefs :: NonEmpty StockRef
- periods :: [FiscalPeriod]
- years :: [Int]
- start :: Maybe Day
- end :: Maybe Day
- ttm :: Bool
- asReported :: Bool
- shares :: Bool
}
data StatementQueryFree = StatementQueryFree {
- stockRef :: StockRef
- period :: FiscalPeriod
- year :: Int
- ttm :: Bool
}
statementQueryToQueryParams :: StatementQuery -> [QueryParam]
statementQueryFreeToQueryParams :: StatementQueryFree -> [QueryParam]

Documentation

data StatementQuery Source #

This represents all options the statement endpoint supports, minus the "statement" parameter itself, which is set by simply calling the right function. Some of these parameters are only available to SimFin+ users. For free users, please use StatementQueryFree. If you provide a zero-length list for any field, the query parameter will be omitted, and the API will try to return all relevant available statements.

Constructors

StatementQuery
Fields stockRefs :: NonEmpty StockRef periods :: [FiscalPeriod] years :: [Int] start :: Maybe Day end :: Maybe Day ttm :: Bool asReported :: Bool shares :: Bool

Instances

Instances details

Show StatementQuery Source #
Instance details Defined in SimFin.Types.StatementQuery Methods showsPrec :: Int -> StatementQuery -> ShowS # show :: StatementQuery -> String # showList :: [StatementQuery] -> ShowS #

data StatementQueryFree Source #

This is a subset of the StatementQuery type, which models the parameters available to non-SimFin+ users.

Constructors

StatementQueryFree
Fields stockRef :: StockRef period :: FiscalPeriod year :: Int ttm :: Bool

statementQueryToQueryParams :: StatementQuery -> [QueryParam] Source #

Turn a StatementQuery into query parameters for the SimFin "statements" endpoint.

statementQueryFreeToQueryParams :: StatementQueryFree -> [QueryParam] Source #

Turn a StatementQueryFree into query parameters for the SimFin "statements" endpoint.