Safe Haskell	Safe-Inferred
Language	Haskell2010

Web.Data.Stooq.API

Description

Here's a simple wrapper around API offered by Stooq.pl. It's capable of returning the latest price for the given instrument. For more information about tickers available, visit the service. Keep in mind that in some situations their ticker convention is different to what's known e.g. from Yahoo Finance e.g.

xxxx.UK: London Stock Exchange (LSE)

xxxx.US: NYSE (OTC market not available, so a lot of ADRs like OGZPY or SBRCY can't be fetched)

xxxx.DE: Deutsche Börse

xxxx.JP: Tokyo Stock Exchange

xxxx: (no exchange code after full stop) Warsaw Stock Exchange (GPW)

Use:

>>> fetch "SPY.US"
Just [StooqPrice {symbol = StooqSymbol "SPY.US", time = ..., ...}]

Synopsis

newtype StooqSymbol = StooqSymbol String
data StooqPrice = StooqPrice {
- symbol :: StooqSymbol
- time :: UTCTime
- open :: Double
- high :: Double
- low :: Double
- close :: Double
- volume :: Int
}
fetchPrice :: StooqSymbol -> IO (Either String [StooqPrice])
fetchPrices :: [StooqSymbol] -> IO (Either String [StooqPrice])
fetch :: String -> IO (Either String [StooqPrice])

Documentation

newtype StooqSymbol Source #

A single-case DU that represents a ticker.

Constructors

StooqSymbol String

Instances

Instances details

Read StooqSymbol Source #
Instance details Defined in Web.Data.Stooq.API Methods readsPrec :: Int -> ReadS StooqSymbol # readList :: ReadS [StooqSymbol] # readPrec :: ReadPrec StooqSymbol # readListPrec :: ReadPrec [StooqSymbol] #
Show StooqSymbol Source #
Instance details Defined in Web.Data.Stooq.API Methods showsPrec :: Int -> StooqSymbol -> ShowS # show :: StooqSymbol -> String # showList :: [StooqSymbol] -> ShowS #
Eq StooqSymbol Source #
Instance details Defined in Web.Data.Stooq.API Methods (==) :: StooqSymbol -> StooqSymbol -> Bool # (/=) :: StooqSymbol -> StooqSymbol -> Bool #
Ord StooqSymbol Source #
Instance details Defined in Web.Data.Stooq.API Methods compare :: StooqSymbol -> StooqSymbol -> Ordering # (<) :: StooqSymbol -> StooqSymbol -> Bool # (<=) :: StooqSymbol -> StooqSymbol -> Bool # (>) :: StooqSymbol -> StooqSymbol -> Bool # (>=) :: StooqSymbol -> StooqSymbol -> Bool # max :: StooqSymbol -> StooqSymbol -> StooqSymbol # min :: StooqSymbol -> StooqSymbol -> StooqSymbol #

data StooqPrice Source #

A type representing market price data returned by Stooq.

Constructors

StooqPrice
Fields symbol :: StooqSymbol time :: UTCTime open :: Double high :: Double low :: Double close :: Double volume :: Int

Instances

Instances details

Show StooqPrice Source #
Instance details Defined in Web.Data.Stooq.API Methods showsPrec :: Int -> StooqPrice -> ShowS # show :: StooqPrice -> String # showList :: [StooqPrice] -> ShowS #

fetchPrice :: StooqSymbol -> IO (Either String [StooqPrice]) Source #

Sends a request for the specified ticker and returns its latest price. Returns Nothing if the response is invalid (this is most likely due to using a non-existent ticker).

fetchPrices :: [StooqSymbol] -> IO (Either String [StooqPrice]) Source #

Sends a request for multiple tickers at once. The function makes only a single HTTP call.

fetch :: String -> IO (Either String [StooqPrice]) Source #

A shorthand around "fetchPrice" that allows to call the function using a plain String, without converting it to a StooqSymbol first.