Documentation

The state of a single market, identified by the currency pair. As usual, the ask/sell price is the price of the last filled ask order, and the bid/buy price is the price of the last filled bid order. Necessarily bid <= ask.

type Ticker =
    [record|
        {ask :: Scientific,
         timestamp :: UTCTime,
         bid :: Scientific,
         rolling24HourVolume :: Scientific,
         lastTrade :: Scientific,
         pair :: CcyPair} |]
 

A currency pair

The current state of the publically accessible orderbook. Bid orders are requests to buy, ask orders are requests to sell.

type Orderbook =
    [record|
        {timestamp :: UTCTime,
         bids :: [Bid],
         asks :: [Ask]} |]
 

A single placed order in the orderbook

type Order =
    [record|
        {volume :: Scientific,
         price :: Scientific} |]
 

Convenient type alias for a bid order

Convenient type alias for an ask order

An auth type used by all private API calls, after authorisation.

type BitXAuth =
    [record|
        {id :: Text,
         secret :: Text} |]
 

A recently placed (private) order, containing a lot more information than is available on the public order book.

type PrivateOrder =
    [record|
        {base :: Scientific,
         counter :: Scientific,
         creationTimestamp :: UTCTime,
         expirationTimestamp :: UTCTime,
         feeBase :: Scientific,
         feeCounter :: Scientific,
         limitPrice :: Scientific,
         limitVolume :: Scientific,
         id :: OrderID,
         pair :: CcyPair,
         state :: RequestStatus,
         type :: OrderType } |]
 

The type of a placed order.

The state of a (private) placed request -- either an order or a withdrawal request.

A request to place an order.

type OrderRequest =
    [record|
        {pair :: CcyPair,
         type :: OrderType,
         volume :: Scientific,
         price :: Scientific } |]
 

A possible error which the BitX API might return, instead of returning the requested data. Note that as yet there is no exhaustive list of error codes available, so comparisons will have to be done via Text comparisons (as opposed to typed pattern matching). Sorry...

type BitXError =
    [record|
        {error :: Text,
         errorCode :: Text} |]
 

A recently placed (private) order, containing a lot more information than is available on the public order book, together with details of any trades which have (partially) filled it.

type PrivateOrderWithTrades =
    [record|
        {base :: Scientific,
         counter :: Scientific,
         creationTimestamp :: UTCTime,
         expirationTimestamp :: UTCTime,
         feeBase :: Scientific,
         feeCounter :: Scientific,
         limitPrice :: Scientific,
         limitVolume :: Scientific,
         id :: OrderID,
         pair :: CcyPair,
         state :: RequestStatus,
         type :: OrderType,
         trades :: [Trade] } |]
 

A trade-able asset. Essentially, a currency.

The current balance of a private account.

type Balance =
    [record|
        {id :: AccountID,
         asset :: Asset,
         balance :: Scientific,
         reserved :: Scientific,
         unconfirmed :: Scientific } |]
 

A registered address for an acocunt.

type FundingAddress =
    [record|
        {asset :: Asset,
         address :: Text,
         totalReceived :: Scientific,
         totalUnconfirmed :: Scientific} |]
 

The state of a request to withdraw from an account.

type WithdrawalRequest =
    [record|
        {status :: RequestStatus,
         id :: Text } |]
 

A request to withdraw from an account.

type NewWithdrawal =
    [record|
        {type :: WithdrawalType,
         amount :: Scientific } |]
 

The type of a withdrawal request.

A request to send bitcoin to a bitcoin address or email address.

type BitcoinSendRequest =
    [record|
        {amount :: Scientific,
         currency :: Asset,
         address :: Text,
         description :: Maybe Text,
         message :: Maybe Text} |]
 

A request to lock in a quote.

type QuoteRequest =
    [record|
        {type :: QuoteType,
         pair :: CcyPair,
         baseAmount :: Scientific} |]
 

A temporarily locked in quote.

type OrderQuote =
    [record|
        {id :: Text,
         type :: QuoteType,
         pair :: CcyPair,
         baseAmount :: Scientific,
         counterAmount :: Scientific,
         createdAt :: UTCTime,
         expiresAt :: UTCTime,
         discarded :: Bool,
         exercised :: Bool} |]
 

A transaction on a private user account.

type Transaction =
    [record|
        {rowIndex :: Int,
         timestamp :: UTCTime,
         balance :: Scientific,
         available :: Scientific,
         balanceDelta :: Scientific,
         availableDelta :: Scientific,
         currency :: Asset,
         description :: Text}|]
 

A registered account.

type Account =
    [record|
        {id :: Text,
         name :: Text,
         currency :: Asset} |]