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

SimFin.Types.PricesQuery

Description

Synopsis

data PricesQuery = PricesQuery {
- stockRefs :: NonEmpty StockRef
- start :: Maybe Day
- end :: Maybe Day
- asReported :: Bool
}
type PricesQueryFree = StockRef
pricesQueryToQueryParams :: PricesQuery -> [QueryParam]
pricesQueryFreeToQueryParams :: PricesQueryFree -> [QueryParam]

Documentation

data PricesQuery Source #

This represents all options the prices endpoint supports. Some of these parameters are only available to SimFin+ users. For free users, please use PricesQueryFree.

Constructors

PricesQuery
Fields stockRefs :: NonEmpty StockRef start :: Maybe Day end :: Maybe Day asReported :: Bool

Instances

Instances details

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

type PricesQueryFree = StockRef Source #

Represents all the parameters available to free users.

pricesQueryToQueryParams :: PricesQuery -> [QueryParam] Source #

Turn a PricesQuery into query parameters for the SimFin "prices" endpoint.

pricesQueryFreeToQueryParams :: PricesQueryFree -> [QueryParam] Source #

Turn a PricesQueryFree into query parameters for the SimFin "prices" endpoint.