Safe Haskell	Safe-Inferred
Language	Haskell2010

Web.Binance

Contents

API
Requests
- Exchange Info
- Trade History
Helpers

Description

Request functions & response types for the Binance.US API

Synopsis

data BinanceApiM a
runApi :: BinanceConfig -> BinanceApiM a -> IO a
data BinanceConfig = BinanceConfig {
- bcApiKey :: Text
- bcApiSecret :: Text
}
data BinanceError = BinanceError {
- beCode :: Int
- beMsg :: Text
}
getExchangeInfo :: (MonadHttp m, MonadCatch m) => [Text] -> m (Either BinanceError ExchangeInfo)
newtype ExchangeInfo = ExchangeInfo {
- eiSymbols :: [SymbolDetails]
}
data SymbolDetails = SymbolDetails {
- sdSymbol :: Text
- sdBaseAsset :: Text
- sdBaseAssetPrecision :: Int
- sdQuoteAsset :: Text
- sdQuoteAssetPrecision :: Int
}
getTradeHistory :: (MonadHttp m, MonadReader BinanceConfig m) => Text -> Maybe UTCTime -> Maybe UTCTime -> m [Trade]
data Trade = Trade {
- tSymbol :: Text
- tId :: Integer
- tOrderId :: Integer
- tPrice :: Scientific
- tQuantity :: Scientific
- tQuoteQuantity :: Scientific
- tCommission :: Scientific
- tCommissionAsset :: Text
- tTime :: POSIXTime
- tIsBuyer :: Bool
- tIsMaker :: Bool
- tIsBestMatch :: Bool
}
runSignedRequest :: (MonadHttp m, HttpMethod method, HttpBody body, HttpResponse response, HttpBodyAllowed (AllowsBody method) (ProvidesBody body), MonadReader BinanceConfig m) => method -> Url scheme -> body -> Proxy response -> Option scheme -> m response
mkSignature :: BinanceConfig -> ByteString -> ByteString -> ByteString

API

data BinanceApiM a Source #

The monad in which Binance API requests are run.

Instances

Instances details

MonadIO BinanceApiM Source #
Instance details Defined in Web.Binance Methods liftIO :: IO a -> BinanceApiM a #
Applicative BinanceApiM Source #
Instance details Defined in Web.Binance Methods pure :: a -> BinanceApiM a # (<>) :: BinanceApiM (a -> b) -> BinanceApiM a -> BinanceApiM b # liftA2 :: (a -> b -> c) -> BinanceApiM a -> BinanceApiM b -> BinanceApiM c # (>) :: BinanceApiM a -> BinanceApiM b -> BinanceApiM b # (<*) :: BinanceApiM a -> BinanceApiM b -> BinanceApiM a #
Functor BinanceApiM Source #
Instance details Defined in Web.Binance Methods fmap :: (a -> b) -> BinanceApiM a -> BinanceApiM b # (<$) :: a -> BinanceApiM b -> BinanceApiM a #
Monad BinanceApiM Source #
Instance details Defined in Web.Binance Methods (>>=) :: BinanceApiM a -> (a -> BinanceApiM b) -> BinanceApiM b # (>>) :: BinanceApiM a -> BinanceApiM b -> BinanceApiM b # return :: a -> BinanceApiM a #
MonadCatch BinanceApiM Source #
Instance details Defined in Web.Binance Methods catch :: Exception e => BinanceApiM a -> (e -> BinanceApiM a) -> BinanceApiM a #
MonadThrow BinanceApiM Source #
Instance details Defined in Web.Binance Methods throwM :: Exception e => e -> BinanceApiM a #
MonadHttp BinanceApiM Source #	Use `MonadHttp` from the `Req` instance.
Instance details Defined in Web.Binance Methods handleHttpException :: HttpException -> BinanceApiM a # getHttpConfig :: BinanceApiM HttpConfig #
MonadReader BinanceConfig BinanceApiM Source #
Instance details Defined in Web.Binance Methods ask :: BinanceApiM BinanceConfig # local :: (BinanceConfig -> BinanceConfig) -> BinanceApiM a -> BinanceApiM a # reader :: (BinanceConfig -> a) -> BinanceApiM a #

runApi :: BinanceConfig -> BinanceApiM a -> IO a Source #

Run a series of API requests with the given Config.

data BinanceConfig Source #

Necessary configuration data for making requests to the Binance API.

Constructors

BinanceConfig
Fields bcApiKey :: Text Your API Key bcApiSecret :: Text Your API Key's Secret

Instances

Instances details

Read BinanceConfig Source #
Instance details Defined in Web.Binance Methods readsPrec :: Int -> ReadS BinanceConfig # readList :: ReadS [BinanceConfig] # readPrec :: ReadPrec BinanceConfig # readListPrec :: ReadPrec [BinanceConfig] #
Show BinanceConfig Source #
Instance details Defined in Web.Binance Methods showsPrec :: Int -> BinanceConfig -> ShowS # show :: BinanceConfig -> String # showList :: [BinanceConfig] -> ShowS #
Eq BinanceConfig Source #
Instance details Defined in Web.Binance Methods (==) :: BinanceConfig -> BinanceConfig -> Bool # (/=) :: BinanceConfig -> BinanceConfig -> Bool #
Ord BinanceConfig Source #
Instance details Defined in Web.Binance Methods compare :: BinanceConfig -> BinanceConfig -> Ordering # (<) :: BinanceConfig -> BinanceConfig -> Bool # (<=) :: BinanceConfig -> BinanceConfig -> Bool # (>) :: BinanceConfig -> BinanceConfig -> Bool # (>=) :: BinanceConfig -> BinanceConfig -> Bool # max :: BinanceConfig -> BinanceConfig -> BinanceConfig # min :: BinanceConfig -> BinanceConfig -> BinanceConfig #
MonadReader BinanceConfig BinanceApiM Source #
Instance details Defined in Web.Binance Methods ask :: BinanceApiM BinanceConfig # local :: (BinanceConfig -> BinanceConfig) -> BinanceApiM a -> BinanceApiM a # reader :: (BinanceConfig -> a) -> BinanceApiM a #

data BinanceError Source #

Error responses from the API.

Constructors

BinanceError
Fields beCode :: Int beMsg :: Text

Instances

Instances details

FromJSON BinanceError Source #
Instance details Defined in Web.Binance Methods parseJSON :: Value -> Parser BinanceError # parseJSONList :: Value -> Parser [BinanceError] #
Read BinanceError Source #
Instance details Defined in Web.Binance Methods readsPrec :: Int -> ReadS BinanceError # readList :: ReadS [BinanceError] # readPrec :: ReadPrec BinanceError # readListPrec :: ReadPrec [BinanceError] #
Show BinanceError Source #
Instance details Defined in Web.Binance Methods showsPrec :: Int -> BinanceError -> ShowS # show :: BinanceError -> String # showList :: [BinanceError] -> ShowS #
Eq BinanceError Source #
Instance details Defined in Web.Binance Methods (==) :: BinanceError -> BinanceError -> Bool # (/=) :: BinanceError -> BinanceError -> Bool #
Ord BinanceError Source #
Instance details Defined in Web.Binance Methods compare :: BinanceError -> BinanceError -> Ordering # (<) :: BinanceError -> BinanceError -> Bool # (<=) :: BinanceError -> BinanceError -> Bool # (>) :: BinanceError -> BinanceError -> Bool # (>=) :: BinanceError -> BinanceError -> Bool # max :: BinanceError -> BinanceError -> BinanceError # min :: BinanceError -> BinanceError -> BinanceError #

Requests

Exchange Info

getExchangeInfo :: (MonadHttp m, MonadCatch m) => [Text] -> m (Either BinanceError ExchangeInfo) Source #

Get Exchange Information for the Given Symbol. Right now, just returns the requested symbol information.

Returns Left if a passed symbol is invalid.

newtype ExchangeInfo Source #

General information about the exchange. Currently we only parse out the details of requested symbols.

Constructors

ExchangeInfo
Fields eiSymbols :: [SymbolDetails]

Instances

Instances details

FromJSON ExchangeInfo Source #
Instance details Defined in Web.Binance Methods parseJSON :: Value -> Parser ExchangeInfo # parseJSONList :: Value -> Parser [ExchangeInfo] #
Read ExchangeInfo Source #
Instance details Defined in Web.Binance Methods readsPrec :: Int -> ReadS ExchangeInfo # readList :: ReadS [ExchangeInfo] # readPrec :: ReadPrec ExchangeInfo # readListPrec :: ReadPrec [ExchangeInfo] #
Show ExchangeInfo Source #
Instance details Defined in Web.Binance Methods showsPrec :: Int -> ExchangeInfo -> ShowS # show :: ExchangeInfo -> String # showList :: [ExchangeInfo] -> ShowS #
Eq ExchangeInfo Source #
Instance details Defined in Web.Binance Methods (==) :: ExchangeInfo -> ExchangeInfo -> Bool # (/=) :: ExchangeInfo -> ExchangeInfo -> Bool #
Ord ExchangeInfo Source #
Instance details Defined in Web.Binance Methods compare :: ExchangeInfo -> ExchangeInfo -> Ordering # (<) :: ExchangeInfo -> ExchangeInfo -> Bool # (<=) :: ExchangeInfo -> ExchangeInfo -> Bool # (>) :: ExchangeInfo -> ExchangeInfo -> Bool # (>=) :: ExchangeInfo -> ExchangeInfo -> Bool # max :: ExchangeInfo -> ExchangeInfo -> ExchangeInfo # min :: ExchangeInfo -> ExchangeInfo -> ExchangeInfo #

data SymbolDetails Source #

The asset pairs for a trade symbol, along with Binance's precisions for each asset.

Constructors

SymbolDetails
Fields sdSymbol :: Text sdBaseAsset :: Text sdBaseAssetPrecision :: Int sdQuoteAsset :: Text sdQuoteAssetPrecision :: Int

Instances

Instances details

FromJSON SymbolDetails Source #
Instance details Defined in Web.Binance Methods parseJSON :: Value -> Parser SymbolDetails # parseJSONList :: Value -> Parser [SymbolDetails] #
Read SymbolDetails Source #
Instance details Defined in Web.Binance Methods readsPrec :: Int -> ReadS SymbolDetails # readList :: ReadS [SymbolDetails] # readPrec :: ReadPrec SymbolDetails # readListPrec :: ReadPrec [SymbolDetails] #
Show SymbolDetails Source #
Instance details Defined in Web.Binance Methods showsPrec :: Int -> SymbolDetails -> ShowS # show :: SymbolDetails -> String # showList :: [SymbolDetails] -> ShowS #
Eq SymbolDetails Source #
Instance details Defined in Web.Binance Methods (==) :: SymbolDetails -> SymbolDetails -> Bool # (/=) :: SymbolDetails -> SymbolDetails -> Bool #
Ord SymbolDetails Source #
Instance details Defined in Web.Binance Methods compare :: SymbolDetails -> SymbolDetails -> Ordering # (<) :: SymbolDetails -> SymbolDetails -> Bool # (<=) :: SymbolDetails -> SymbolDetails -> Bool # (>) :: SymbolDetails -> SymbolDetails -> Bool # (>=) :: SymbolDetails -> SymbolDetails -> Bool # max :: SymbolDetails -> SymbolDetails -> SymbolDetails # min :: SymbolDetails -> SymbolDetails -> SymbolDetails #

Trade History

getTradeHistory Source #

Arguments

:: (MonadHttp m, MonadReader BinanceConfig m)
=> Text	Full symbol/pair of trades to fetch, e.g. `BNBUSD`.
-> Maybe UTCTime	Start of time range
-> Maybe UTCTime	End of time range
-> m [Trade]

Get Trade History for the Given Symbol.

data Trade Source #

A single trade made on Binance.

Constructors

Trade

Fields

tSymbol :: Text
Full symbol of the trade - base asset & quote asset
tId :: Integer
Trade's ID number
tOrderId :: Integer
Order ID number from which the Trade was made
tPrice :: Scientific
tQuantity :: Scientific
tQuoteQuantity :: Scientific
The total amount spent/received during the trade. Note that we do not use this value in our exports, as Binance truncates it & loses a fraction of the amount. You probably want to do tQuantity * tPrice instead.
tCommission :: Scientific
tCommissionAsset :: Text
tTime :: POSIXTime
tIsBuyer :: Bool
tIsMaker :: Bool
tIsBestMatch :: Bool

Instances

Instances details

FromJSON Trade Source #
Instance details Defined in Web.Binance Methods parseJSON :: Value -> Parser Trade # parseJSONList :: Value -> Parser [Trade] #
Read Trade Source #
Instance details Defined in Web.Binance Methods readsPrec :: Int -> ReadS Trade # readList :: ReadS [Trade] # readPrec :: ReadPrec Trade # readListPrec :: ReadPrec [Trade] #
Show Trade Source #
Instance details Defined in Web.Binance Methods showsPrec :: Int -> Trade -> ShowS # show :: Trade -> String # showList :: [Trade] -> ShowS #
Eq Trade Source #
Instance details Defined in Web.Binance Methods (==) :: Trade -> Trade -> Bool # (/=) :: Trade -> Trade -> Bool #
Ord Trade Source #
Instance details Defined in Web.Binance Methods compare :: Trade -> Trade -> Ordering # (<) :: Trade -> Trade -> Bool # (<=) :: Trade -> Trade -> Bool # (>) :: Trade -> Trade -> Bool # (>=) :: Trade -> Trade -> Bool # max :: Trade -> Trade -> Trade # min :: Trade -> Trade -> Trade #

Helpers

runSignedRequest :: (MonadHttp m, HttpMethod method, HttpBody body, HttpResponse response, HttpBodyAllowed (AllowsBody method) (ProvidesBody body), MonadReader BinanceConfig m) => method -> Url scheme -> body -> Proxy response -> Option scheme -> m response Source #

Run a request for a SIGNED endpoint by inserting the signature into the query string before making the request.

mkSignature Source #

Arguments

:: BinanceConfig	API Credentials
-> ByteString	Query parameters (with no leading `?`)
-> ByteString	Request body
-> ByteString

Generate a HMAC Crpto.Hash.SHA256 signature for a SIGNED api request.