The bitx-bitcoin package

[ Tags: bitcoin, bsd3, finance, library, web ] [ Propose Tags ]

Haskell bindings to the BitX REST API, as described here: https://bitx.co/api.

Note that since this library interfaces directly with a financial API, great care must be taken in its use. In particular, the author cannot be held accountable for any financial losses as a result of programming error, whether that error is in your code, the code of the author of this library, or BitX's code. This is just common sense.

If you need to make sure that nothing funny happens in the code, apart from reading the source yourself, you should also perform a few test transations with very small denominations, as I will strive to do every time before releasing a new version.

For a very small usage example, see Network.Bitcoin.BitX.Public.


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.2.0.0, 0.2.0.1, 0.2.0.2, 0.3.0.0, 0.4.0.0, 0.4.0.1, 0.5.0.0, 0.5.0.1, 0.6.0.0, 0.7.0.0, 0.7.0.1, 0.7.0.2, 0.8.0.0, 0.9.0.0, 0.9.0.1, 0.10.0.0, 0.11.0.0, 0.11.0.1, 0.12.0.0 (info)
Change log CHANGES
Dependencies aeson (>=0.8), base (>=4.5 && <5), bytestring, http-client (>=0.4.6.1), http-client-tls, http-types, microlens, microlens-th, network, QuickCheck (>=2.8), scientific, split (>=0.2.0.0), text, time [details]
License BSD3
Author Tebello Thejane
Maintainer Tebello Thejane <zyxoas+hackage@gmail.com>
Category Web, Bitcoin, Finance
Home page https://github.com/tebello-thejane/bitx-haskell
Source repo head: git clone git://github.com/tebello-thejane/bitx-haskell.git
Uploaded Tue Feb 23 07:16:11 UTC 2016 by tebello_thejane
Distributions LTSHaskell:0.11.0.1, NixOS:0.12.0.0, Stackage:0.12.0.0, openSUSE:0.11.0.1
Downloads 4294 total (168 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2016-02-23 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for bitx-bitcoin-0.7.0.0

[back to package description]

Build Status Hackage BSD3

(Hopefully useful) Haskell bindings to the BitX bitcoin exchange's API.

As a minimal example, to get the current selling price (in South African Rand) of bitcoin on the BitX exchange, do the following:

{-# LANGUAGE DataKinds #-}

import Control.Lens ((^.))
import Network.Bitcoin.BitX (BitXAPIResponse(..), getTicker, CcyPair(..))
import qualified Network.Bitcoin.BitX as BitX
import Data.Text (unpack)
import Network.HTTP.Types.Status (Status(..))
import Network.HTTP.Client (responseStatus)

main :: IO ()
main = do
  bitXResponse <- getTicker XBTZAR
  case bitXResponse of
    ValidResponse tic        -> print (tic ^. BitX.ask)
    ErrorResponse err        ->
        error $ "BitX error received: \"" ++ unpack (err ^. BitX.error) ++ "\""
    ExceptionResponse ex     ->
        error $ "Exception was thrown: \"" ++ show ex ++ "\""
    UnparseableResponse resp ->
        error $ "Bad HTTP response; HTTP status code was: \"" ++ (show . statusCode . responseStatus $ resp) ++ "\""

Note that the code snippet above depends on http-types, text, http-client, lens (or any lens-compatible package, such as microlens), and finally bitx-bitcoin.

This library is known to work on Windows, but if you wish to use it then you will have to do a bit more work due to the Network library not building on Windows out of the box. See this blog post by Neil Mitchell.