Safe Haskell	None
Language	Haskell2010

BitMEX.Core

Contents

BitMEXConfig
BitMEXRequest
HasBodyParam
HasOptionalParam
- BitMEXRequest Utils
- Params Utils
  - Swagger CollectionFormat Utils
AuthMethods
Utils
DateTime Formatting
Date Formatting
Byte/Binary Formatting
Lens Type Aliases

Description

Synopsis

data BitMEXConfig = BitMEXConfig {
- configHost :: ByteString
- configUserAgent :: Text
- configLogExecWithContext :: LogExecWithContext
- configLogContext :: LogContext
- configAuthMethods :: [AnyAuthMethod]
- configValidateAuthMethods :: Bool
}
newConfig :: IO BitMEXConfig
addAuthMethod :: AuthMethod auth => BitMEXConfig -> auth -> BitMEXConfig
withStdoutLogging :: BitMEXConfig -> IO BitMEXConfig
withStderrLogging :: BitMEXConfig -> IO BitMEXConfig
withNoLogging :: BitMEXConfig -> BitMEXConfig
data BitMEXRequest req contentType res accept = BitMEXRequest {
- rMethod :: Method
- rUrlPath :: [ByteString]
- rParams :: Params
- rAuthTypes :: [TypeRep]
}
rMethodL :: Lens_' (BitMEXRequest req contentType res accept) Method
rUrlPathL :: Lens_' (BitMEXRequest req contentType res accept) [ByteString]
rParamsL :: Lens_' (BitMEXRequest req contentType res accept) Params
rAuthTypesL :: Lens_' (BitMEXRequest req contentType res accept) [TypeRep]
class HasBodyParam req param where
class HasOptionalParam req param where
data Params = Params {
- paramsQuery :: Query
- paramsHeaders :: RequestHeaders
- paramsBody :: ParamBody
}
paramsQueryL :: Lens_' Params Query
paramsHeadersL :: Lens_' Params RequestHeaders
paramsBodyL :: Lens_' Params ParamBody
data ParamBody
- = ParamBodyNone
- | ParamBodyB ByteString
- | ParamBodyBL ByteString
- | ParamBodyFormUrlEncoded Form
- | ParamBodyMultipartFormData [Part]
_mkRequest :: Method -> [ByteString] -> BitMEXRequest req contentType res accept
_mkParams :: Params
setHeader :: BitMEXRequest req contentType res accept -> [Header] -> BitMEXRequest req contentType res accept
removeHeader :: BitMEXRequest req contentType res accept -> [HeaderName] -> BitMEXRequest req contentType res accept
_setContentTypeHeader :: forall req contentType res accept. MimeType contentType => BitMEXRequest req contentType res accept -> BitMEXRequest req contentType res accept
_setAcceptHeader :: forall req contentType res accept. MimeType accept => BitMEXRequest req contentType res accept -> BitMEXRequest req contentType res accept
setQuery :: BitMEXRequest req contentType res accept -> [QueryItem] -> BitMEXRequest req contentType res accept
addForm :: BitMEXRequest req contentType res accept -> Form -> BitMEXRequest req contentType res accept
_addMultiFormPart :: BitMEXRequest req contentType res accept -> Part -> BitMEXRequest req contentType res accept
_setBodyBS :: BitMEXRequest req contentType res accept -> ByteString -> BitMEXRequest req contentType res accept
_setBodyLBS :: BitMEXRequest req contentType res accept -> ByteString -> BitMEXRequest req contentType res accept
_hasAuthType :: AuthMethod authMethod => BitMEXRequest req contentType res accept -> Proxy authMethod -> BitMEXRequest req contentType res accept
toPath :: ToHttpApiData a => a -> ByteString
toHeader :: ToHttpApiData a => (HeaderName, a) -> [Header]
toForm :: ToHttpApiData v => (ByteString, v) -> Form
toQuery :: ToHttpApiData a => (ByteString, Maybe a) -> [QueryItem]
data CollectionFormat
- = CommaSeparated
- | SpaceSeparated
- | TabSeparated
- | PipeSeparated
- | MultiParamArray
toHeaderColl :: ToHttpApiData a => CollectionFormat -> (HeaderName, [a]) -> [Header]
toFormColl :: ToHttpApiData v => CollectionFormat -> (ByteString, [v]) -> Form
toQueryColl :: ToHttpApiData a => CollectionFormat -> (ByteString, Maybe [a]) -> Query
_toColl :: Traversable f => CollectionFormat -> (f a -> [(b, ByteString)]) -> f [a] -> [(b, ByteString)]
_toCollA :: (Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t ByteString)]) -> f (t [a]) -> [(b, t ByteString)]
_toCollA' :: (Monoid c, Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t c)]) -> (Char -> c) -> f (t [a]) -> [(b, t c)]
class Typeable a => AuthMethod a where
data AnyAuthMethod = AuthMethod a => AnyAuthMethod a
data AuthMethodException = AuthMethodException String
_applyAuthMethods :: BitMEXRequest req contentType res accept -> BitMEXConfig -> IO (BitMEXRequest req contentType res accept)
_omitNulls :: [(Text, Value)] -> Value
_toFormItem :: (ToHttpApiData a, Functor f) => t -> f a -> f (t, [Text])
_emptyToNothing :: Maybe String -> Maybe String
_memptyToNothing :: (Monoid a, Eq a) => Maybe a -> Maybe a
newtype DateTime = DateTime {
- unDateTime :: UTCTime
}
_readDateTime :: (ParseTime t, Monad m, Alternative m) => String -> m t
_showDateTime :: (t ~ UTCTime, FormatTime t) => t -> String
_parseISO8601 :: (ParseTime t, Monad m, Alternative m) => String -> m t
newtype Date = Date {
- unDate :: Day
}
_readDate :: (ParseTime t, Monad m) => String -> m t
_showDate :: FormatTime t => t -> String
newtype ByteArray = ByteArray {
- unByteArray :: ByteString
}
_readByteArray :: Monad m => Text -> m ByteArray
_showByteArray :: ByteArray -> Text
newtype Binary = Binary {
- unBinary :: ByteString
}
_readBinaryBase64 :: Monad m => Text -> m Binary
_showBinaryBase64 :: Binary -> Text
type Lens_' s a = Lens_ s s a a
type Lens_ s t a b = forall (f :: * -> *). Functor f => (a -> f b) -> s -> f t

BitMEXConfig

data BitMEXConfig Source #

Constructors

BitMEXConfig

Fields

configHost :: ByteString
host supplied in the Request
configUserAgent :: Text
user-agent supplied in the Request
configLogExecWithContext :: LogExecWithContext
Run a block using a Logger instance
configLogContext :: LogContext
Configures the logger
configAuthMethods :: [AnyAuthMethod]
List of configured auth methods
configValidateAuthMethods :: Bool
throw exceptions if auth methods are not configured

Instances

Show BitMEXConfig Source #	display the config
Instance details Defined in BitMEX.Core Methods showsPrec :: Int -> BitMEXConfig -> ShowS # show :: BitMEXConfig -> String # showList :: [BitMEXConfig] -> ShowS #

newConfig :: IO BitMEXConfig Source #

constructs a default BitMEXConfig

configHost:

https://localhost/api/v1

configUserAgent:

"swagger-haskell-http-client/1.0.0"

addAuthMethod :: AuthMethod auth => BitMEXConfig -> auth -> BitMEXConfig Source #

updates config use AuthMethod on matching requests

withStdoutLogging :: BitMEXConfig -> IO BitMEXConfig Source #

updates the config to use stdout logging

withStderrLogging :: BitMEXConfig -> IO BitMEXConfig Source #

updates the config to use stderr logging

withNoLogging :: BitMEXConfig -> BitMEXConfig Source #

updates the config to disable logging

BitMEXRequest

data BitMEXRequest req contentType res accept Source #

Represents a request.

Type Variables:

req - request operation
contentType - MimeType associated with request body
res - response model
accept - MimeType associated with response body

Constructors

BitMEXRequest
Fields rMethod :: Method Method of BitMEXRequest rUrlPath :: [ByteString] Endpoint of BitMEXRequest rParams :: Params params of BitMEXRequest rAuthTypes :: [TypeRep] types of auth methods

Instances

Show (BitMEXRequest req contentType res accept) Source #
Instance details Defined in BitMEX.Core Methods showsPrec :: Int -> BitMEXRequest req contentType res accept -> ShowS # show :: BitMEXRequest req contentType res accept -> String # showList :: [BitMEXRequest req contentType res accept] -> ShowS #

rMethodL :: Lens_' (BitMEXRequest req contentType res accept) Method Source #

rMethod Lens

rUrlPathL :: Lens_' (BitMEXRequest req contentType res accept) [ByteString] Source #

rUrlPath Lens

rParamsL :: Lens_' (BitMEXRequest req contentType res accept) Params Source #

rParams Lens

rAuthTypesL :: Lens_' (BitMEXRequest req contentType res accept) [TypeRep] Source #

rParams Lens

HasBodyParam

class HasBodyParam req param where Source #

Designates the body parameter of a request

Methods

setBodyParam :: forall contentType res accept. (Consumes req contentType, MimeRender contentType param) => BitMEXRequest req contentType res accept -> param -> BitMEXRequest req contentType res accept Source #

HasOptionalParam

class HasOptionalParam req param where Source #

Designates the optional parameters of a request

Minimal complete definition

applyOptionalParam | (-&-)

Methods

applyOptionalParam :: BitMEXRequest req contentType res accept -> param -> BitMEXRequest req contentType res accept Source #

Apply an optional parameter to a request

(-&-) :: BitMEXRequest req contentType res accept -> param -> BitMEXRequest req contentType res accept infixl 2 Source #

infix operator / alias for addOptionalParam

Instances

HasOptionalParam UserUpdate Username Source #	Optional Param "username" - Username can only be set once. To reset, email support.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserUpdate contentType res accept -> Username -> BitMEXRequest UserUpdate contentType res accept Source # (-&-) :: BitMEXRequest UserUpdate contentType res accept -> Username -> BitMEXRequest UserUpdate contentType res accept Source #
HasOptionalParam UserUpdate PgpPubKey Source #	Optional Param "pgpPubKey" - PGP Public Key. If specified, automated emails will be sentwith this key.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserUpdate contentType res accept -> PgpPubKey -> BitMEXRequest UserUpdate contentType res accept Source # (-&-) :: BitMEXRequest UserUpdate contentType res accept -> PgpPubKey -> BitMEXRequest UserUpdate contentType res accept Source #
HasOptionalParam UserUpdate OldPassword Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserUpdate contentType res accept -> OldPassword -> BitMEXRequest UserUpdate contentType res accept Source # (-&-) :: BitMEXRequest UserUpdate contentType res accept -> OldPassword -> BitMEXRequest UserUpdate contentType res accept Source #
HasOptionalParam UserUpdate NewPasswordConfirm Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserUpdate contentType res accept -> NewPasswordConfirm -> BitMEXRequest UserUpdate contentType res accept Source # (-&-) :: BitMEXRequest UserUpdate contentType res accept -> NewPasswordConfirm -> BitMEXRequest UserUpdate contentType res accept Source #
HasOptionalParam UserUpdate NewPassword Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserUpdate contentType res accept -> NewPassword -> BitMEXRequest UserUpdate contentType res accept Source # (-&-) :: BitMEXRequest UserUpdate contentType res accept -> NewPassword -> BitMEXRequest UserUpdate contentType res accept Source #
HasOptionalParam UserUpdate Lastname Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserUpdate contentType res accept -> Lastname -> BitMEXRequest UserUpdate contentType res accept Source # (-&-) :: BitMEXRequest UserUpdate contentType res accept -> Lastname -> BitMEXRequest UserUpdate contentType res accept Source #
HasOptionalParam UserUpdate Firstname Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserUpdate contentType res accept -> Firstname -> BitMEXRequest UserUpdate contentType res accept Source # (-&-) :: BitMEXRequest UserUpdate contentType res accept -> Firstname -> BitMEXRequest UserUpdate contentType res accept Source #
HasOptionalParam UserUpdate Country Source #	Optional Param "country" - Country of residence.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserUpdate contentType res accept -> Country -> BitMEXRequest UserUpdate contentType res accept Source # (-&-) :: BitMEXRequest UserUpdate contentType res accept -> Country -> BitMEXRequest UserUpdate contentType res accept Source #
HasOptionalParam UserSavePreferences Overwrite Source #	Optional Param "overwrite" - If true, will overwrite all existing preferences.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserSavePreferences contentType res accept -> Overwrite -> BitMEXRequest UserSavePreferences contentType res accept Source # (-&-) :: BitMEXRequest UserSavePreferences contentType res accept -> Overwrite -> BitMEXRequest UserSavePreferences contentType res accept Source #
HasOptionalParam UserRequestWithdrawal OtpToken Source #	Optional Param "otpToken" - 2FA token. Required if 2FA is enabled on your account.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserRequestWithdrawal contentType res accept -> OtpToken -> BitMEXRequest UserRequestWithdrawal contentType res accept Source # (-&-) :: BitMEXRequest UserRequestWithdrawal contentType res accept -> OtpToken -> BitMEXRequest UserRequestWithdrawal contentType res accept Source #
HasOptionalParam UserRequestWithdrawal Fee Source #	Optional Param "fee" - Network fee for Bitcoin withdrawals. If not specified, a default value will be calculated based on Bitcoin network conditions. You will have a chance to confirm this via email.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserRequestWithdrawal contentType res accept -> Fee -> BitMEXRequest UserRequestWithdrawal contentType res accept Source # (-&-) :: BitMEXRequest UserRequestWithdrawal contentType res accept -> Fee -> BitMEXRequest UserRequestWithdrawal contentType res accept Source #
HasOptionalParam UserRequestEnableTFA ParamType Source #	Optional Param "type" - Two-factor auth type. Supported types: `GA` (Google Authenticator)
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserRequestEnableTFA contentType res accept -> ParamType -> BitMEXRequest UserRequestEnableTFA contentType res accept Source # (-&-) :: BitMEXRequest UserRequestEnableTFA contentType res accept -> ParamType -> BitMEXRequest UserRequestEnableTFA contentType res accept Source #
HasOptionalParam UserMinWithdrawalFee Currency Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserMinWithdrawalFee contentType res accept -> Currency -> BitMEXRequest UserMinWithdrawalFee contentType res accept Source # (-&-) :: BitMEXRequest UserMinWithdrawalFee contentType res accept -> Currency -> BitMEXRequest UserMinWithdrawalFee contentType res accept Source #
HasOptionalParam UserGetWalletSummary Currency Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserGetWalletSummary contentType res accept -> Currency -> BitMEXRequest UserGetWalletSummary contentType res accept Source # (-&-) :: BitMEXRequest UserGetWalletSummary contentType res accept -> Currency -> BitMEXRequest UserGetWalletSummary contentType res accept Source #
HasOptionalParam UserGetWalletHistory Currency Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserGetWalletHistory contentType res accept -> Currency -> BitMEXRequest UserGetWalletHistory contentType res accept Source # (-&-) :: BitMEXRequest UserGetWalletHistory contentType res accept -> Currency -> BitMEXRequest UserGetWalletHistory contentType res accept Source #
HasOptionalParam UserGetWallet Currency Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserGetWallet contentType res accept -> Currency -> BitMEXRequest UserGetWallet contentType res accept Source # (-&-) :: BitMEXRequest UserGetWallet contentType res accept -> Currency -> BitMEXRequest UserGetWallet contentType res accept Source #
HasOptionalParam UserGetMargin Currency Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserGetMargin contentType res accept -> Currency -> BitMEXRequest UserGetMargin contentType res accept Source # (-&-) :: BitMEXRequest UserGetMargin contentType res accept -> Currency -> BitMEXRequest UserGetMargin contentType res accept Source #
HasOptionalParam UserGetDepositAddress Currency Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserGetDepositAddress contentType res accept -> Currency -> BitMEXRequest UserGetDepositAddress contentType res accept Source # (-&-) :: BitMEXRequest UserGetDepositAddress contentType res accept -> Currency -> BitMEXRequest UserGetDepositAddress contentType res accept Source #
HasOptionalParam UserDisableTFA ParamType Source #	Optional Param "type" - Two-factor auth type. Supported types: `GA` (Google Authenticator)
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserDisableTFA contentType res accept -> ParamType -> BitMEXRequest UserDisableTFA contentType res accept Source # (-&-) :: BitMEXRequest UserDisableTFA contentType res accept -> ParamType -> BitMEXRequest UserDisableTFA contentType res accept Source #
HasOptionalParam UserConfirmEnableTFA ParamType Source #	Optional Param "type" - Two-factor auth type. Supported types: `GA` (Google Authenticator), `Yubikey`
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserConfirmEnableTFA contentType res accept -> ParamType -> BitMEXRequest UserConfirmEnableTFA contentType res accept Source # (-&-) :: BitMEXRequest UserConfirmEnableTFA contentType res accept -> ParamType -> BitMEXRequest UserConfirmEnableTFA contentType res accept Source #
HasOptionalParam UserCheckReferralCode ReferralCode Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest UserCheckReferralCode contentType res accept -> ReferralCode -> BitMEXRequest UserCheckReferralCode contentType res accept Source # (-&-) :: BitMEXRequest UserCheckReferralCode contentType res accept -> ReferralCode -> BitMEXRequest UserCheckReferralCode contentType res accept Source #
HasOptionalParam TradeGetBucketed Symbol Source #	Optional Param "symbol" - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGetBucketed contentType res accept -> Symbol -> BitMEXRequest TradeGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest TradeGetBucketed contentType res accept -> Symbol -> BitMEXRequest TradeGetBucketed contentType res accept Source #
HasOptionalParam TradeGetBucketed StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGetBucketed contentType res accept -> StartTime -> BitMEXRequest TradeGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest TradeGetBucketed contentType res accept -> StartTime -> BitMEXRequest TradeGetBucketed contentType res accept Source #
HasOptionalParam TradeGetBucketed Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGetBucketed contentType res accept -> Start -> BitMEXRequest TradeGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest TradeGetBucketed contentType res accept -> Start -> BitMEXRequest TradeGetBucketed contentType res accept Source #
HasOptionalParam TradeGetBucketed Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGetBucketed contentType res accept -> Reverse -> BitMEXRequest TradeGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest TradeGetBucketed contentType res accept -> Reverse -> BitMEXRequest TradeGetBucketed contentType res accept Source #
HasOptionalParam TradeGetBucketed Partial Source #	Optional Param "partial" - If true, will send in-progress (incomplete) bins for the current time period.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGetBucketed contentType res accept -> Partial -> BitMEXRequest TradeGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest TradeGetBucketed contentType res accept -> Partial -> BitMEXRequest TradeGetBucketed contentType res accept Source #
HasOptionalParam TradeGetBucketed Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGetBucketed contentType res accept -> Filter -> BitMEXRequest TradeGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest TradeGetBucketed contentType res accept -> Filter -> BitMEXRequest TradeGetBucketed contentType res accept Source #
HasOptionalParam TradeGetBucketed EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGetBucketed contentType res accept -> EndTime -> BitMEXRequest TradeGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest TradeGetBucketed contentType res accept -> EndTime -> BitMEXRequest TradeGetBucketed contentType res accept Source #
HasOptionalParam TradeGetBucketed Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGetBucketed contentType res accept -> Count -> BitMEXRequest TradeGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest TradeGetBucketed contentType res accept -> Count -> BitMEXRequest TradeGetBucketed contentType res accept Source #
HasOptionalParam TradeGetBucketed Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGetBucketed contentType res accept -> Columns -> BitMEXRequest TradeGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest TradeGetBucketed contentType res accept -> Columns -> BitMEXRequest TradeGetBucketed contentType res accept Source #
HasOptionalParam TradeGetBucketed BinSize Source #	Optional Param "binSize" - Time interval to bucket by. Available options: [1m,5m,1h,1d].
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGetBucketed contentType res accept -> BinSize -> BitMEXRequest TradeGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest TradeGetBucketed contentType res accept -> BinSize -> BitMEXRequest TradeGetBucketed contentType res accept Source #
HasOptionalParam TradeGet Symbol Source #	Optional Param "symbol" - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGet contentType res accept -> Symbol -> BitMEXRequest TradeGet contentType res accept Source # (-&-) :: BitMEXRequest TradeGet contentType res accept -> Symbol -> BitMEXRequest TradeGet contentType res accept Source #
HasOptionalParam TradeGet StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGet contentType res accept -> StartTime -> BitMEXRequest TradeGet contentType res accept Source # (-&-) :: BitMEXRequest TradeGet contentType res accept -> StartTime -> BitMEXRequest TradeGet contentType res accept Source #
HasOptionalParam TradeGet Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGet contentType res accept -> Start -> BitMEXRequest TradeGet contentType res accept Source # (-&-) :: BitMEXRequest TradeGet contentType res accept -> Start -> BitMEXRequest TradeGet contentType res accept Source #
HasOptionalParam TradeGet Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGet contentType res accept -> Reverse -> BitMEXRequest TradeGet contentType res accept Source # (-&-) :: BitMEXRequest TradeGet contentType res accept -> Reverse -> BitMEXRequest TradeGet contentType res accept Source #
HasOptionalParam TradeGet Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGet contentType res accept -> Filter -> BitMEXRequest TradeGet contentType res accept Source # (-&-) :: BitMEXRequest TradeGet contentType res accept -> Filter -> BitMEXRequest TradeGet contentType res accept Source #
HasOptionalParam TradeGet EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGet contentType res accept -> EndTime -> BitMEXRequest TradeGet contentType res accept Source # (-&-) :: BitMEXRequest TradeGet contentType res accept -> EndTime -> BitMEXRequest TradeGet contentType res accept Source #
HasOptionalParam TradeGet Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGet contentType res accept -> Count -> BitMEXRequest TradeGet contentType res accept Source # (-&-) :: BitMEXRequest TradeGet contentType res accept -> Count -> BitMEXRequest TradeGet contentType res accept Source #
HasOptionalParam TradeGet Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest TradeGet contentType res accept -> Columns -> BitMEXRequest TradeGet contentType res accept Source # (-&-) :: BitMEXRequest TradeGet contentType res accept -> Columns -> BitMEXRequest TradeGet contentType res accept Source #
HasOptionalParam SettlementGet Symbol Source #	Optional Param "symbol" - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest SettlementGet contentType res accept -> Symbol -> BitMEXRequest SettlementGet contentType res accept Source # (-&-) :: BitMEXRequest SettlementGet contentType res accept -> Symbol -> BitMEXRequest SettlementGet contentType res accept Source #
HasOptionalParam SettlementGet StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest SettlementGet contentType res accept -> StartTime -> BitMEXRequest SettlementGet contentType res accept Source # (-&-) :: BitMEXRequest SettlementGet contentType res accept -> StartTime -> BitMEXRequest SettlementGet contentType res accept Source #
HasOptionalParam SettlementGet Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest SettlementGet contentType res accept -> Start -> BitMEXRequest SettlementGet contentType res accept Source # (-&-) :: BitMEXRequest SettlementGet contentType res accept -> Start -> BitMEXRequest SettlementGet contentType res accept Source #
HasOptionalParam SettlementGet Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest SettlementGet contentType res accept -> Reverse -> BitMEXRequest SettlementGet contentType res accept Source # (-&-) :: BitMEXRequest SettlementGet contentType res accept -> Reverse -> BitMEXRequest SettlementGet contentType res accept Source #
HasOptionalParam SettlementGet Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest SettlementGet contentType res accept -> Filter -> BitMEXRequest SettlementGet contentType res accept Source # (-&-) :: BitMEXRequest SettlementGet contentType res accept -> Filter -> BitMEXRequest SettlementGet contentType res accept Source #
HasOptionalParam SettlementGet EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest SettlementGet contentType res accept -> EndTime -> BitMEXRequest SettlementGet contentType res accept Source # (-&-) :: BitMEXRequest SettlementGet contentType res accept -> EndTime -> BitMEXRequest SettlementGet contentType res accept Source #
HasOptionalParam SettlementGet Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest SettlementGet contentType res accept -> Count -> BitMEXRequest SettlementGet contentType res accept Source # (-&-) :: BitMEXRequest SettlementGet contentType res accept -> Count -> BitMEXRequest SettlementGet contentType res accept Source #
HasOptionalParam SettlementGet Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest SettlementGet contentType res accept -> Columns -> BitMEXRequest SettlementGet contentType res accept Source # (-&-) :: BitMEXRequest SettlementGet contentType res accept -> Columns -> BitMEXRequest SettlementGet contentType res accept Source #
HasOptionalParam SchemaGet Model Source #	Optional Param "model" - Optional model filter. If omitted, will return all models.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest SchemaGet contentType res accept -> Model -> BitMEXRequest SchemaGet contentType res accept Source # (-&-) :: BitMEXRequest SchemaGet contentType res accept -> Model -> BitMEXRequest SchemaGet contentType res accept Source #
HasOptionalParam QuoteGetBucketed Symbol Source #	Optional Param "symbol" - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGetBucketed contentType res accept -> Symbol -> BitMEXRequest QuoteGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest QuoteGetBucketed contentType res accept -> Symbol -> BitMEXRequest QuoteGetBucketed contentType res accept Source #
HasOptionalParam QuoteGetBucketed StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGetBucketed contentType res accept -> StartTime -> BitMEXRequest QuoteGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest QuoteGetBucketed contentType res accept -> StartTime -> BitMEXRequest QuoteGetBucketed contentType res accept Source #
HasOptionalParam QuoteGetBucketed Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGetBucketed contentType res accept -> Start -> BitMEXRequest QuoteGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest QuoteGetBucketed contentType res accept -> Start -> BitMEXRequest QuoteGetBucketed contentType res accept Source #
HasOptionalParam QuoteGetBucketed Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGetBucketed contentType res accept -> Reverse -> BitMEXRequest QuoteGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest QuoteGetBucketed contentType res accept -> Reverse -> BitMEXRequest QuoteGetBucketed contentType res accept Source #
HasOptionalParam QuoteGetBucketed Partial Source #	Optional Param "partial" - If true, will send in-progress (incomplete) bins for the current time period.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGetBucketed contentType res accept -> Partial -> BitMEXRequest QuoteGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest QuoteGetBucketed contentType res accept -> Partial -> BitMEXRequest QuoteGetBucketed contentType res accept Source #
HasOptionalParam QuoteGetBucketed Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGetBucketed contentType res accept -> Filter -> BitMEXRequest QuoteGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest QuoteGetBucketed contentType res accept -> Filter -> BitMEXRequest QuoteGetBucketed contentType res accept Source #
HasOptionalParam QuoteGetBucketed EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGetBucketed contentType res accept -> EndTime -> BitMEXRequest QuoteGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest QuoteGetBucketed contentType res accept -> EndTime -> BitMEXRequest QuoteGetBucketed contentType res accept Source #
HasOptionalParam QuoteGetBucketed Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGetBucketed contentType res accept -> Count -> BitMEXRequest QuoteGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest QuoteGetBucketed contentType res accept -> Count -> BitMEXRequest QuoteGetBucketed contentType res accept Source #
HasOptionalParam QuoteGetBucketed Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGetBucketed contentType res accept -> Columns -> BitMEXRequest QuoteGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest QuoteGetBucketed contentType res accept -> Columns -> BitMEXRequest QuoteGetBucketed contentType res accept Source #
HasOptionalParam QuoteGetBucketed BinSize Source #	Optional Param "binSize" - Time interval to bucket by. Available options: [1m,5m,1h,1d].
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGetBucketed contentType res accept -> BinSize -> BitMEXRequest QuoteGetBucketed contentType res accept Source # (-&-) :: BitMEXRequest QuoteGetBucketed contentType res accept -> BinSize -> BitMEXRequest QuoteGetBucketed contentType res accept Source #
HasOptionalParam QuoteGet Symbol Source #	Optional Param "symbol" - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGet contentType res accept -> Symbol -> BitMEXRequest QuoteGet contentType res accept Source # (-&-) :: BitMEXRequest QuoteGet contentType res accept -> Symbol -> BitMEXRequest QuoteGet contentType res accept Source #
HasOptionalParam QuoteGet StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGet contentType res accept -> StartTime -> BitMEXRequest QuoteGet contentType res accept Source # (-&-) :: BitMEXRequest QuoteGet contentType res accept -> StartTime -> BitMEXRequest QuoteGet contentType res accept Source #
HasOptionalParam QuoteGet Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGet contentType res accept -> Start -> BitMEXRequest QuoteGet contentType res accept Source # (-&-) :: BitMEXRequest QuoteGet contentType res accept -> Start -> BitMEXRequest QuoteGet contentType res accept Source #
HasOptionalParam QuoteGet Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGet contentType res accept -> Reverse -> BitMEXRequest QuoteGet contentType res accept Source # (-&-) :: BitMEXRequest QuoteGet contentType res accept -> Reverse -> BitMEXRequest QuoteGet contentType res accept Source #
HasOptionalParam QuoteGet Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGet contentType res accept -> Filter -> BitMEXRequest QuoteGet contentType res accept Source # (-&-) :: BitMEXRequest QuoteGet contentType res accept -> Filter -> BitMEXRequest QuoteGet contentType res accept Source #
HasOptionalParam QuoteGet EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGet contentType res accept -> EndTime -> BitMEXRequest QuoteGet contentType res accept Source # (-&-) :: BitMEXRequest QuoteGet contentType res accept -> EndTime -> BitMEXRequest QuoteGet contentType res accept Source #
HasOptionalParam QuoteGet Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGet contentType res accept -> Count -> BitMEXRequest QuoteGet contentType res accept Source # (-&-) :: BitMEXRequest QuoteGet contentType res accept -> Count -> BitMEXRequest QuoteGet contentType res accept Source #
HasOptionalParam QuoteGet Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest QuoteGet contentType res accept -> Columns -> BitMEXRequest QuoteGet contentType res accept Source # (-&-) :: BitMEXRequest QuoteGet contentType res accept -> Columns -> BitMEXRequest QuoteGet contentType res accept Source #
HasOptionalParam PositionIsolateMargin Enabled Source #	Optional Param "enabled" - True for isolated margin, false for cross margin.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest PositionIsolateMargin contentType res accept -> Enabled -> BitMEXRequest PositionIsolateMargin contentType res accept Source # (-&-) :: BitMEXRequest PositionIsolateMargin contentType res accept -> Enabled -> BitMEXRequest PositionIsolateMargin contentType res accept Source #
HasOptionalParam PositionGet Filter Source #	Optional Param "filter" - Table filter. For example, send {"symbol": "XBTUSD"}.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest PositionGet contentType res accept -> Filter -> BitMEXRequest PositionGet contentType res accept Source # (-&-) :: BitMEXRequest PositionGet contentType res accept -> Filter -> BitMEXRequest PositionGet contentType res accept Source #
HasOptionalParam PositionGet Count Source #	Optional Param "count" - Number of rows to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest PositionGet contentType res accept -> Count -> BitMEXRequest PositionGet contentType res accept Source # (-&-) :: BitMEXRequest PositionGet contentType res accept -> Count -> BitMEXRequest PositionGet contentType res accept Source #
HasOptionalParam PositionGet Columns Source #	Optional Param "columns" - Which columns to fetch. For example, send ["columnName"].
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest PositionGet contentType res accept -> Columns -> BitMEXRequest PositionGet contentType res accept Source # (-&-) :: BitMEXRequest PositionGet contentType res accept -> Columns -> BitMEXRequest PositionGet contentType res accept Source #
HasOptionalParam OrderBookGetL2 Depth Source #	Optional Param "depth" - Orderbook depth per side. Send 0 for full depth.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderBookGetL2 contentType res accept -> Depth -> BitMEXRequest OrderBookGetL2 contentType res accept Source # (-&-) :: BitMEXRequest OrderBookGetL2 contentType res accept -> Depth -> BitMEXRequest OrderBookGetL2 contentType res accept Source #
HasOptionalParam OrderBookGet Depth Source #	Optional Param "depth" - Orderbook depth.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderBookGet contentType res accept -> Depth -> BitMEXRequest OrderBookGet contentType res accept Source # (-&-) :: BitMEXRequest OrderBookGet contentType res accept -> Depth -> BitMEXRequest OrderBookGet contentType res accept Source #
HasOptionalParam OrderNewBulk Orders Source #	Optional Param "orders" - An array of orders.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNewBulk contentType res accept -> Orders -> BitMEXRequest OrderNewBulk contentType res accept Source # (-&-) :: BitMEXRequest OrderNewBulk contentType res accept -> Orders -> BitMEXRequest OrderNewBulk contentType res accept Source #
HasOptionalParam OrderNew TimeInForce Source #	Optional Param "timeInForce" - Time in force. Valid options: Day, GoodTillCancel, ImmediateOrCancel, FillOrKill. Defaults to `GoodTillCancel` for `Limit`, `StopLimit`, `LimitIfTouched`, and `MarketWithLeftOverAsLimit` orders.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> TimeInForce -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> TimeInForce -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew StopPx Source #	Optional Param "stopPx" - Optional trigger price for `Stop`, `StopLimit`, `MarketIfTouched`, and `LimitIfTouched` orders. Use a price below the current price for stop-sell orders and buy-if-touched orders. Use `execInst` of `MarkPrice` or `LastPrice` to define the current price used for triggering.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> StopPx -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> StopPx -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew StopPrice Source #	Optional Param "stopPrice" - Deprecated: use `stopPx`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> StopPrice -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> StopPrice -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew SimpleOrderQty Source #	Optional Param "simpleOrderQty" - Order quantity in units of the underlying instrument (i.e. Bitcoin).
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> SimpleOrderQty -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> SimpleOrderQty -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew Side Source #	Optional Param "side" - Order side. Valid options: Buy, Sell. Defaults to `Buy` unless `orderQty` or `simpleOrderQty` is negative.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> Side -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> Side -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew Quantity Source #	Optional Param "quantity" - Deprecated: use `orderQty`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> Quantity -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> Quantity -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew Price Source #	Optional Param "price" - Optional limit price for `Limit`, `StopLimit`, and `LimitIfTouched` orders.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> Price -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> Price -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew PegPriceType Source #	Optional Param "pegPriceType" - Optional peg price type. Valid options: LastPeg, MidPricePeg, MarketPeg, PrimaryPeg, TrailingStopPeg.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> PegPriceType -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> PegPriceType -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew PegOffsetValue Source #	Optional Param "pegOffsetValue" - Optional trailing offset from the current price for `Stop`, `StopLimit`, `MarketIfTouched`, and `LimitIfTouched` orders; use a negative offset for stop-sell orders and buy-if-touched orders. Optional offset from the peg price for `Pegged` orders.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> PegOffsetValue -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> PegOffsetValue -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew ParamType Source #	Optional Param "type" - Deprecated: use `ordType`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> ParamType -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> ParamType -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew ParamText Source #	Optional Param "text" - Optional order annotation. e.g. 'Take profit'.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> ParamText -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> ParamText -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew OrderQty Source #	Optional Param "orderQty" - Order quantity in units of the instrument (i.e. contracts).
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> OrderQty -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> OrderQty -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew OrdType Source #	Optional Param "ordType" - Order type. Valid options: Market, Limit, Stop, StopLimit, MarketIfTouched, LimitIfTouched, MarketWithLeftOverAsLimit, Pegged. Defaults to `Limit` when `price` is specified. Defaults to `Stop` when `stopPx` is specified. Defaults to `StopLimit` when `price` and `stopPx` are specified.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> OrdType -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> OrdType -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew ExecInst Source #	Optional Param "execInst" - Optional execution instructions. Valid options: ParticipateDoNotInitiate, AllOrNone, MarkPrice, IndexPrice, LastPrice, Close, ReduceOnly, Fixed. `AllOrNone` instruction requires `displayQty` to be 0. `MarkPrice`, `IndexPrice` or `LastPrice` instruction valid for `Stop`, `StopLimit`, `MarketIfTouched`, and `LimitIfTouched` orders.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> ExecInst -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> ExecInst -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew DisplayQty Source #	Optional Param "displayQty" - Optional quantity to display in the book. Use 0 for a fully hidden order.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> DisplayQty -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> DisplayQty -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew ContingencyType Source #	Optional Param "contingencyType" - Optional contingency type for use with `clOrdLinkID`. Valid options: OneCancelsTheOther, OneTriggersTheOther, OneUpdatesTheOtherAbsolute, OneUpdatesTheOtherProportional.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> ContingencyType -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> ContingencyType -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew ClOrdLinkId Source #	Optional Param "clOrdLinkID" - Optional Client Order Link ID for contingent orders.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> ClOrdLinkId -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> ClOrdLinkId -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderNew ClOrdId Source #	Optional Param "clOrdID" - Optional Client Order ID. This clOrdID will come back on the order and any related executions.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderNew contentType res accept -> ClOrdId -> BitMEXRequest OrderNew contentType res accept Source # (-&-) :: BitMEXRequest OrderNew contentType res accept -> ClOrdId -> BitMEXRequest OrderNew contentType res accept Source #
HasOptionalParam OrderGetOrders Symbol Source #	Optional Param "symbol" - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderGetOrders contentType res accept -> Symbol -> BitMEXRequest OrderGetOrders contentType res accept Source # (-&-) :: BitMEXRequest OrderGetOrders contentType res accept -> Symbol -> BitMEXRequest OrderGetOrders contentType res accept Source #
HasOptionalParam OrderGetOrders StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderGetOrders contentType res accept -> StartTime -> BitMEXRequest OrderGetOrders contentType res accept Source # (-&-) :: BitMEXRequest OrderGetOrders contentType res accept -> StartTime -> BitMEXRequest OrderGetOrders contentType res accept Source #
HasOptionalParam OrderGetOrders Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderGetOrders contentType res accept -> Start -> BitMEXRequest OrderGetOrders contentType res accept Source # (-&-) :: BitMEXRequest OrderGetOrders contentType res accept -> Start -> BitMEXRequest OrderGetOrders contentType res accept Source #
HasOptionalParam OrderGetOrders Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderGetOrders contentType res accept -> Reverse -> BitMEXRequest OrderGetOrders contentType res accept Source # (-&-) :: BitMEXRequest OrderGetOrders contentType res accept -> Reverse -> BitMEXRequest OrderGetOrders contentType res accept Source #
HasOptionalParam OrderGetOrders Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderGetOrders contentType res accept -> Filter -> BitMEXRequest OrderGetOrders contentType res accept Source # (-&-) :: BitMEXRequest OrderGetOrders contentType res accept -> Filter -> BitMEXRequest OrderGetOrders contentType res accept Source #
HasOptionalParam OrderGetOrders EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderGetOrders contentType res accept -> EndTime -> BitMEXRequest OrderGetOrders contentType res accept Source # (-&-) :: BitMEXRequest OrderGetOrders contentType res accept -> EndTime -> BitMEXRequest OrderGetOrders contentType res accept Source #
HasOptionalParam OrderGetOrders Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderGetOrders contentType res accept -> Count -> BitMEXRequest OrderGetOrders contentType res accept Source # (-&-) :: BitMEXRequest OrderGetOrders contentType res accept -> Count -> BitMEXRequest OrderGetOrders contentType res accept Source #
HasOptionalParam OrderGetOrders Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderGetOrders contentType res accept -> Columns -> BitMEXRequest OrderGetOrders contentType res accept Source # (-&-) :: BitMEXRequest OrderGetOrders contentType res accept -> Columns -> BitMEXRequest OrderGetOrders contentType res accept Source #
HasOptionalParam OrderClosePosition Price Source #	Optional Param "price" - Optional limit price.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderClosePosition contentType res accept -> Price -> BitMEXRequest OrderClosePosition contentType res accept Source # (-&-) :: BitMEXRequest OrderClosePosition contentType res accept -> Price -> BitMEXRequest OrderClosePosition contentType res accept Source #
HasOptionalParam OrderCancelAll Symbol Source #	Optional Param "symbol" - Optional symbol. If provided, only cancels orders for that symbol.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderCancelAll contentType res accept -> Symbol -> BitMEXRequest OrderCancelAll contentType res accept Source # (-&-) :: BitMEXRequest OrderCancelAll contentType res accept -> Symbol -> BitMEXRequest OrderCancelAll contentType res accept Source #
HasOptionalParam OrderCancelAll ParamText Source #	Optional Param "text" - Optional cancellation annotation. e.g. 'Spread Exceeded'
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderCancelAll contentType res accept -> ParamText -> BitMEXRequest OrderCancelAll contentType res accept Source # (-&-) :: BitMEXRequest OrderCancelAll contentType res accept -> ParamText -> BitMEXRequest OrderCancelAll contentType res accept Source #
HasOptionalParam OrderCancelAll Filter Source #	Optional Param "filter" - Optional filter for cancellation. Use to only cancel some orders, e.g. `{"side": "Buy"}`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderCancelAll contentType res accept -> Filter -> BitMEXRequest OrderCancelAll contentType res accept Source # (-&-) :: BitMEXRequest OrderCancelAll contentType res accept -> Filter -> BitMEXRequest OrderCancelAll contentType res accept Source #
HasOptionalParam OrderCancel ParamText Source #	Optional Param "text" - Optional cancellation annotation. e.g. 'Spread Exceeded'.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderCancel contentType res accept -> ParamText -> BitMEXRequest OrderCancel contentType res accept Source # (-&-) :: BitMEXRequest OrderCancel contentType res accept -> ParamText -> BitMEXRequest OrderCancel contentType res accept Source #
HasOptionalParam OrderCancel OrderId Source #	Optional Param "orderID" - Order ID(s).
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderCancel contentType res accept -> OrderId -> BitMEXRequest OrderCancel contentType res accept Source # (-&-) :: BitMEXRequest OrderCancel contentType res accept -> OrderId -> BitMEXRequest OrderCancel contentType res accept Source #
HasOptionalParam OrderCancel ClOrdId Source #	Optional Param "clOrdID" - Client Order ID(s). See POST /order.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderCancel contentType res accept -> ClOrdId -> BitMEXRequest OrderCancel contentType res accept Source # (-&-) :: BitMEXRequest OrderCancel contentType res accept -> ClOrdId -> BitMEXRequest OrderCancel contentType res accept Source #
HasOptionalParam OrderAmendBulk Orders Source #	Optional Param "orders" - An array of orders.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderAmendBulk contentType res accept -> Orders -> BitMEXRequest OrderAmendBulk contentType res accept Source # (-&-) :: BitMEXRequest OrderAmendBulk contentType res accept -> Orders -> BitMEXRequest OrderAmendBulk contentType res accept Source #
HasOptionalParam OrderAmend StopPx Source #	Optional Param "stopPx" - Optional trigger price for `Stop`, `StopLimit`, `MarketIfTouched`, and `LimitIfTouched` orders. Use a price below the current price for stop-sell orders and buy-if-touched orders.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderAmend contentType res accept -> StopPx -> BitMEXRequest OrderAmend contentType res accept Source # (-&-) :: BitMEXRequest OrderAmend contentType res accept -> StopPx -> BitMEXRequest OrderAmend contentType res accept Source #
HasOptionalParam OrderAmend SimpleOrderQty Source #	Optional Param "simpleOrderQty" - Optional order quantity in units of the underlying instrument (i.e. Bitcoin).
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderAmend contentType res accept -> SimpleOrderQty -> BitMEXRequest OrderAmend contentType res accept Source # (-&-) :: BitMEXRequest OrderAmend contentType res accept -> SimpleOrderQty -> BitMEXRequest OrderAmend contentType res accept Source #
HasOptionalParam OrderAmend SimpleLeavesQty Source #	Optional Param "simpleLeavesQty" - Optional leaves quantity in units of the underlying instrument (i.e. Bitcoin). Useful for amending partially filled orders.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderAmend contentType res accept -> SimpleLeavesQty -> BitMEXRequest OrderAmend contentType res accept Source # (-&-) :: BitMEXRequest OrderAmend contentType res accept -> SimpleLeavesQty -> BitMEXRequest OrderAmend contentType res accept Source #
HasOptionalParam OrderAmend Price Source #	Optional Param "price" - Optional limit price for `Limit`, `StopLimit`, and `LimitIfTouched` orders.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderAmend contentType res accept -> Price -> BitMEXRequest OrderAmend contentType res accept Source # (-&-) :: BitMEXRequest OrderAmend contentType res accept -> Price -> BitMEXRequest OrderAmend contentType res accept Source #
HasOptionalParam OrderAmend PegOffsetValue Source #	Optional Param "pegOffsetValue" - Optional trailing offset from the current price for `Stop`, `StopLimit`, `MarketIfTouched`, and `LimitIfTouched` orders; use a negative offset for stop-sell orders and buy-if-touched orders. Optional offset from the peg price for `Pegged` orders.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderAmend contentType res accept -> PegOffsetValue -> BitMEXRequest OrderAmend contentType res accept Source # (-&-) :: BitMEXRequest OrderAmend contentType res accept -> PegOffsetValue -> BitMEXRequest OrderAmend contentType res accept Source #
HasOptionalParam OrderAmend ParamText Source #	Optional Param "text" - Optional amend annotation. e.g. 'Adjust skew'.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderAmend contentType res accept -> ParamText -> BitMEXRequest OrderAmend contentType res accept Source # (-&-) :: BitMEXRequest OrderAmend contentType res accept -> ParamText -> BitMEXRequest OrderAmend contentType res accept Source #
HasOptionalParam OrderAmend OrigClOrdId Source #	Optional Param "origClOrdID" - Client Order ID. See POST /order.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderAmend contentType res accept -> OrigClOrdId -> BitMEXRequest OrderAmend contentType res accept Source # (-&-) :: BitMEXRequest OrderAmend contentType res accept -> OrigClOrdId -> BitMEXRequest OrderAmend contentType res accept Source #
HasOptionalParam OrderAmend OrderQty Source #	Optional Param "orderQty" - Optional order quantity in units of the instrument (i.e. contracts).
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderAmend contentType res accept -> OrderQty -> BitMEXRequest OrderAmend contentType res accept Source # (-&-) :: BitMEXRequest OrderAmend contentType res accept -> OrderQty -> BitMEXRequest OrderAmend contentType res accept Source #
HasOptionalParam OrderAmend OrderId Source #	Optional Param "orderID" - Order ID
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderAmend contentType res accept -> OrderId -> BitMEXRequest OrderAmend contentType res accept Source # (-&-) :: BitMEXRequest OrderAmend contentType res accept -> OrderId -> BitMEXRequest OrderAmend contentType res accept Source #
HasOptionalParam OrderAmend LeavesQty Source #	Optional Param "leavesQty" - Optional leaves quantity in units of the instrument (i.e. contracts). Useful for amending partially filled orders.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderAmend contentType res accept -> LeavesQty -> BitMEXRequest OrderAmend contentType res accept Source # (-&-) :: BitMEXRequest OrderAmend contentType res accept -> LeavesQty -> BitMEXRequest OrderAmend contentType res accept Source #
HasOptionalParam OrderAmend ClOrdId Source #	Optional Param "clOrdID" - Optional new Client Order ID, requires `origClOrdID`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest OrderAmend contentType res accept -> ClOrdId -> BitMEXRequest OrderAmend contentType res accept Source # (-&-) :: BitMEXRequest OrderAmend contentType res accept -> ClOrdId -> BitMEXRequest OrderAmend contentType res accept Source #
HasOptionalParam LiquidationGet Symbol Source #	Optional Param "symbol" - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest LiquidationGet contentType res accept -> Symbol -> BitMEXRequest LiquidationGet contentType res accept Source # (-&-) :: BitMEXRequest LiquidationGet contentType res accept -> Symbol -> BitMEXRequest LiquidationGet contentType res accept Source #
HasOptionalParam LiquidationGet StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest LiquidationGet contentType res accept -> StartTime -> BitMEXRequest LiquidationGet contentType res accept Source # (-&-) :: BitMEXRequest LiquidationGet contentType res accept -> StartTime -> BitMEXRequest LiquidationGet contentType res accept Source #
HasOptionalParam LiquidationGet Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest LiquidationGet contentType res accept -> Start -> BitMEXRequest LiquidationGet contentType res accept Source # (-&-) :: BitMEXRequest LiquidationGet contentType res accept -> Start -> BitMEXRequest LiquidationGet contentType res accept Source #
HasOptionalParam LiquidationGet Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest LiquidationGet contentType res accept -> Reverse -> BitMEXRequest LiquidationGet contentType res accept Source # (-&-) :: BitMEXRequest LiquidationGet contentType res accept -> Reverse -> BitMEXRequest LiquidationGet contentType res accept Source #
HasOptionalParam LiquidationGet Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest LiquidationGet contentType res accept -> Filter -> BitMEXRequest LiquidationGet contentType res accept Source # (-&-) :: BitMEXRequest LiquidationGet contentType res accept -> Filter -> BitMEXRequest LiquidationGet contentType res accept Source #
HasOptionalParam LiquidationGet EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest LiquidationGet contentType res accept -> EndTime -> BitMEXRequest LiquidationGet contentType res accept Source # (-&-) :: BitMEXRequest LiquidationGet contentType res accept -> EndTime -> BitMEXRequest LiquidationGet contentType res accept Source #
HasOptionalParam LiquidationGet Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest LiquidationGet contentType res accept -> Count -> BitMEXRequest LiquidationGet contentType res accept Source # (-&-) :: BitMEXRequest LiquidationGet contentType res accept -> Count -> BitMEXRequest LiquidationGet contentType res accept Source #
HasOptionalParam LiquidationGet Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest LiquidationGet contentType res accept -> Columns -> BitMEXRequest LiquidationGet contentType res accept Source # (-&-) :: BitMEXRequest LiquidationGet contentType res accept -> Columns -> BitMEXRequest LiquidationGet contentType res accept Source #
HasOptionalParam LeaderboardGet Method Source #	Optional Param "method" - Ranking type. Options: "notional", "ROE"
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest LeaderboardGet contentType res accept -> Method -> BitMEXRequest LeaderboardGet contentType res accept Source # (-&-) :: BitMEXRequest LeaderboardGet contentType res accept -> Method -> BitMEXRequest LeaderboardGet contentType res accept Source #
HasOptionalParam InsuranceGet Symbol Source #	Optional Param "symbol" - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InsuranceGet contentType res accept -> Symbol -> BitMEXRequest InsuranceGet contentType res accept Source # (-&-) :: BitMEXRequest InsuranceGet contentType res accept -> Symbol -> BitMEXRequest InsuranceGet contentType res accept Source #
HasOptionalParam InsuranceGet StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InsuranceGet contentType res accept -> StartTime -> BitMEXRequest InsuranceGet contentType res accept Source # (-&-) :: BitMEXRequest InsuranceGet contentType res accept -> StartTime -> BitMEXRequest InsuranceGet contentType res accept Source #
HasOptionalParam InsuranceGet Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InsuranceGet contentType res accept -> Start -> BitMEXRequest InsuranceGet contentType res accept Source # (-&-) :: BitMEXRequest InsuranceGet contentType res accept -> Start -> BitMEXRequest InsuranceGet contentType res accept Source #
HasOptionalParam InsuranceGet Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InsuranceGet contentType res accept -> Reverse -> BitMEXRequest InsuranceGet contentType res accept Source # (-&-) :: BitMEXRequest InsuranceGet contentType res accept -> Reverse -> BitMEXRequest InsuranceGet contentType res accept Source #
HasOptionalParam InsuranceGet Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InsuranceGet contentType res accept -> Filter -> BitMEXRequest InsuranceGet contentType res accept Source # (-&-) :: BitMEXRequest InsuranceGet contentType res accept -> Filter -> BitMEXRequest InsuranceGet contentType res accept Source #
HasOptionalParam InsuranceGet EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InsuranceGet contentType res accept -> EndTime -> BitMEXRequest InsuranceGet contentType res accept Source # (-&-) :: BitMEXRequest InsuranceGet contentType res accept -> EndTime -> BitMEXRequest InsuranceGet contentType res accept Source #
HasOptionalParam InsuranceGet Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InsuranceGet contentType res accept -> Count -> BitMEXRequest InsuranceGet contentType res accept Source # (-&-) :: BitMEXRequest InsuranceGet contentType res accept -> Count -> BitMEXRequest InsuranceGet contentType res accept Source #
HasOptionalParam InsuranceGet Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InsuranceGet contentType res accept -> Columns -> BitMEXRequest InsuranceGet contentType res accept Source # (-&-) :: BitMEXRequest InsuranceGet contentType res accept -> Columns -> BitMEXRequest InsuranceGet contentType res accept Source #
HasOptionalParam InstrumentGetCompositeIndex Symbol Source #	Optional Param "symbol" - The composite index symbol.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Symbol -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Symbol -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source #
HasOptionalParam InstrumentGetCompositeIndex StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> StartTime -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> StartTime -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source #
HasOptionalParam InstrumentGetCompositeIndex Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Start -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Start -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source #
HasOptionalParam InstrumentGetCompositeIndex Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Reverse -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Reverse -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source #
HasOptionalParam InstrumentGetCompositeIndex Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Filter -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Filter -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source #
HasOptionalParam InstrumentGetCompositeIndex EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> EndTime -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> EndTime -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source #
HasOptionalParam InstrumentGetCompositeIndex Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Count -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Count -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source #
HasOptionalParam InstrumentGetCompositeIndex Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Columns -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Columns -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source #
HasOptionalParam InstrumentGetCompositeIndex Account Source #
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Account -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGetCompositeIndex contentType res accept -> Account -> BitMEXRequest InstrumentGetCompositeIndex contentType res accept Source #
HasOptionalParam InstrumentGet Symbol Source #	Optional Param "symbol" - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGet contentType res accept -> Symbol -> BitMEXRequest InstrumentGet contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGet contentType res accept -> Symbol -> BitMEXRequest InstrumentGet contentType res accept Source #
HasOptionalParam InstrumentGet StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGet contentType res accept -> StartTime -> BitMEXRequest InstrumentGet contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGet contentType res accept -> StartTime -> BitMEXRequest InstrumentGet contentType res accept Source #
HasOptionalParam InstrumentGet Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGet contentType res accept -> Start -> BitMEXRequest InstrumentGet contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGet contentType res accept -> Start -> BitMEXRequest InstrumentGet contentType res accept Source #
HasOptionalParam InstrumentGet Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGet contentType res accept -> Reverse -> BitMEXRequest InstrumentGet contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGet contentType res accept -> Reverse -> BitMEXRequest InstrumentGet contentType res accept Source #
HasOptionalParam InstrumentGet Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGet contentType res accept -> Filter -> BitMEXRequest InstrumentGet contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGet contentType res accept -> Filter -> BitMEXRequest InstrumentGet contentType res accept Source #
HasOptionalParam InstrumentGet EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGet contentType res accept -> EndTime -> BitMEXRequest InstrumentGet contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGet contentType res accept -> EndTime -> BitMEXRequest InstrumentGet contentType res accept Source #
HasOptionalParam InstrumentGet Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGet contentType res accept -> Count -> BitMEXRequest InstrumentGet contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGet contentType res accept -> Count -> BitMEXRequest InstrumentGet contentType res accept Source #
HasOptionalParam InstrumentGet Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest InstrumentGet contentType res accept -> Columns -> BitMEXRequest InstrumentGet contentType res accept Source # (-&-) :: BitMEXRequest InstrumentGet contentType res accept -> Columns -> BitMEXRequest InstrumentGet contentType res accept Source #
HasOptionalParam FundingGet Symbol Source #	Optional Param "symbol" - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest FundingGet contentType res accept -> Symbol -> BitMEXRequest FundingGet contentType res accept Source # (-&-) :: BitMEXRequest FundingGet contentType res accept -> Symbol -> BitMEXRequest FundingGet contentType res accept Source #
HasOptionalParam FundingGet StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest FundingGet contentType res accept -> StartTime -> BitMEXRequest FundingGet contentType res accept Source # (-&-) :: BitMEXRequest FundingGet contentType res accept -> StartTime -> BitMEXRequest FundingGet contentType res accept Source #
HasOptionalParam FundingGet Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest FundingGet contentType res accept -> Start -> BitMEXRequest FundingGet contentType res accept Source # (-&-) :: BitMEXRequest FundingGet contentType res accept -> Start -> BitMEXRequest FundingGet contentType res accept Source #
HasOptionalParam FundingGet Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest FundingGet contentType res accept -> Reverse -> BitMEXRequest FundingGet contentType res accept Source # (-&-) :: BitMEXRequest FundingGet contentType res accept -> Reverse -> BitMEXRequest FundingGet contentType res accept Source #
HasOptionalParam FundingGet Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest FundingGet contentType res accept -> Filter -> BitMEXRequest FundingGet contentType res accept Source # (-&-) :: BitMEXRequest FundingGet contentType res accept -> Filter -> BitMEXRequest FundingGet contentType res accept Source #
HasOptionalParam FundingGet EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest FundingGet contentType res accept -> EndTime -> BitMEXRequest FundingGet contentType res accept Source # (-&-) :: BitMEXRequest FundingGet contentType res accept -> EndTime -> BitMEXRequest FundingGet contentType res accept Source #
HasOptionalParam FundingGet Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest FundingGet contentType res accept -> Count -> BitMEXRequest FundingGet contentType res accept Source # (-&-) :: BitMEXRequest FundingGet contentType res accept -> Count -> BitMEXRequest FundingGet contentType res accept Source #
HasOptionalParam FundingGet Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest FundingGet contentType res accept -> Columns -> BitMEXRequest FundingGet contentType res accept Source # (-&-) :: BitMEXRequest FundingGet contentType res accept -> Columns -> BitMEXRequest FundingGet contentType res accept Source #
HasOptionalParam ExecutionGetTradeHistory Symbol Source #	Optional Param "symbol" - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> Symbol -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> Symbol -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source #
HasOptionalParam ExecutionGetTradeHistory StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> StartTime -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> StartTime -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source #
HasOptionalParam ExecutionGetTradeHistory Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> Start -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> Start -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source #
HasOptionalParam ExecutionGetTradeHistory Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> Reverse -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> Reverse -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source #
HasOptionalParam ExecutionGetTradeHistory Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> Filter -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> Filter -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source #
HasOptionalParam ExecutionGetTradeHistory EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> EndTime -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> EndTime -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source #
HasOptionalParam ExecutionGetTradeHistory Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> Count -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> Count -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source #
HasOptionalParam ExecutionGetTradeHistory Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> Columns -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGetTradeHistory contentType res accept -> Columns -> BitMEXRequest ExecutionGetTradeHistory contentType res accept Source #
HasOptionalParam ExecutionGet Symbol Source #	Optional Param "symbol" - Instrument symbol. Send a bare series (e.g. XBU) to get data for the nearest expiring contract in that series. You can also send a timeframe, e.g. `XBU:monthly`. Timeframes are `daily`, `weekly`, `monthly`, `quarterly`, and `biquarterly`.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGet contentType res accept -> Symbol -> BitMEXRequest ExecutionGet contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGet contentType res accept -> Symbol -> BitMEXRequest ExecutionGet contentType res accept Source #
HasOptionalParam ExecutionGet StartTime Source #	Optional Param "startTime" - Starting date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGet contentType res accept -> StartTime -> BitMEXRequest ExecutionGet contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGet contentType res accept -> StartTime -> BitMEXRequest ExecutionGet contentType res accept Source #
HasOptionalParam ExecutionGet Start Source #	Optional Param "start" - Starting point for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGet contentType res accept -> Start -> BitMEXRequest ExecutionGet contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGet contentType res accept -> Start -> BitMEXRequest ExecutionGet contentType res accept Source #
HasOptionalParam ExecutionGet Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGet contentType res accept -> Reverse -> BitMEXRequest ExecutionGet contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGet contentType res accept -> Reverse -> BitMEXRequest ExecutionGet contentType res accept Source #
HasOptionalParam ExecutionGet Filter Source #	Optional Param "filter" - Generic table filter. Send JSON keyvalue pairs, such as `{"key": "value"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https:www.bitmex.comapp/restAPI#timestamp-filters) for more details.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGet contentType res accept -> Filter -> BitMEXRequest ExecutionGet contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGet contentType res accept -> Filter -> BitMEXRequest ExecutionGet contentType res accept Source #
HasOptionalParam ExecutionGet EndTime Source #	Optional Param "endTime" - Ending date filter for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGet contentType res accept -> EndTime -> BitMEXRequest ExecutionGet contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGet contentType res accept -> EndTime -> BitMEXRequest ExecutionGet contentType res accept Source #
HasOptionalParam ExecutionGet Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGet contentType res accept -> Count -> BitMEXRequest ExecutionGet contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGet contentType res accept -> Count -> BitMEXRequest ExecutionGet contentType res accept Source #
HasOptionalParam ExecutionGet Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns. Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ExecutionGet contentType res accept -> Columns -> BitMEXRequest ExecutionGet contentType res accept Source # (-&-) :: BitMEXRequest ExecutionGet contentType res accept -> Columns -> BitMEXRequest ExecutionGet contentType res accept Source #
HasOptionalParam ChatNew ChannelId Source #	Optional Param "channelID" - Channel to post to. Default 1 (English).
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ChatNew contentType res accept -> ChannelId -> BitMEXRequest ChatNew contentType res accept Source # (-&-) :: BitMEXRequest ChatNew contentType res accept -> ChannelId -> BitMEXRequest ChatNew contentType res accept Source #
HasOptionalParam ChatGet Start Source #	Optional Param "start" - Starting ID for results.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ChatGet contentType res accept -> Start -> BitMEXRequest ChatGet contentType res accept Source # (-&-) :: BitMEXRequest ChatGet contentType res accept -> Start -> BitMEXRequest ChatGet contentType res accept Source #
HasOptionalParam ChatGet Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ChatGet contentType res accept -> Reverse -> BitMEXRequest ChatGet contentType res accept Source # (-&-) :: BitMEXRequest ChatGet contentType res accept -> Reverse -> BitMEXRequest ChatGet contentType res accept Source #
HasOptionalParam ChatGet Count Source #	Optional Param "count" - Number of results to fetch.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ChatGet contentType res accept -> Count -> BitMEXRequest ChatGet contentType res accept Source # (-&-) :: BitMEXRequest ChatGet contentType res accept -> Count -> BitMEXRequest ChatGet contentType res accept Source #
HasOptionalParam ChatGet ChannelId Source #	Optional Param "channelID" - Channel id. GET chatchannels for ids. Leave blank for all.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest ChatGet contentType res accept -> ChannelId -> BitMEXRequest ChatGet contentType res accept Source # (-&-) :: BitMEXRequest ChatGet contentType res accept -> ChannelId -> BitMEXRequest ChatGet contentType res accept Source #
HasOptionalParam AnnouncementGet Columns Source #	Optional Param "columns" - Array of column names to fetch. If omitted, will return all columns.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest AnnouncementGet contentType res accept -> Columns -> BitMEXRequest AnnouncementGet contentType res accept Source # (-&-) :: BitMEXRequest AnnouncementGet contentType res accept -> Columns -> BitMEXRequest AnnouncementGet contentType res accept Source #
HasOptionalParam APIKeyNew Token Source #	Optional Param "token" - OTP Token (YubiKey, Google Authenticator)
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest APIKeyNew contentType res accept -> Token -> BitMEXRequest APIKeyNew contentType res accept Source # (-&-) :: BitMEXRequest APIKeyNew contentType res accept -> Token -> BitMEXRequest APIKeyNew contentType res accept Source #
HasOptionalParam APIKeyNew Permissions Source #	Optional Param "permissions" - Key Permissions. All keys can read margin and position data. Additional permissions must be added. Available: ["order", "orderCancel", "withdraw"].
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest APIKeyNew contentType res accept -> Permissions -> BitMEXRequest APIKeyNew contentType res accept Source # (-&-) :: BitMEXRequest APIKeyNew contentType res accept -> Permissions -> BitMEXRequest APIKeyNew contentType res accept Source #
HasOptionalParam APIKeyNew Name Source #	Optional Param "name" - Key name. This name is for reference only.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest APIKeyNew contentType res accept -> Name -> BitMEXRequest APIKeyNew contentType res accept Source # (-&-) :: BitMEXRequest APIKeyNew contentType res accept -> Name -> BitMEXRequest APIKeyNew contentType res accept Source #
HasOptionalParam APIKeyNew Enabled Source #	Optional Param "enabled" - Set to true to enable this key on creation. Otherwise, it must be explicitly enabled via apiKeyenable.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest APIKeyNew contentType res accept -> Enabled -> BitMEXRequest APIKeyNew contentType res accept Source # (-&-) :: BitMEXRequest APIKeyNew contentType res accept -> Enabled -> BitMEXRequest APIKeyNew contentType res accept Source #
HasOptionalParam APIKeyNew Cidr Source #	Optional Param "cidr" - CIDR block to restrict this key to. To restrict to a single address, append "32", e.g. 207.39.29.2232. Leave blank or set to 0.0.0.00 to allow all IPs. Only one block may be set. <a href="http:software77.netcidr-101.html">More on CIDR blocks/a
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest APIKeyNew contentType res accept -> Cidr -> BitMEXRequest APIKeyNew contentType res accept Source # (-&-) :: BitMEXRequest APIKeyNew contentType res accept -> Cidr -> BitMEXRequest APIKeyNew contentType res accept Source #
HasOptionalParam APIKeyGet Reverse Source #	Optional Param "reverse" - If true, will sort results newest first.
Instance details Defined in BitMEX.API Methods applyOptionalParam :: BitMEXRequest APIKeyGet contentType res accept -> Reverse -> BitMEXRequest APIKeyGet contentType res accept Source # (-&-) :: BitMEXRequest APIKeyGet contentType res accept -> Reverse -> BitMEXRequest APIKeyGet contentType res accept Source #

data Params Source #

Request Params

Constructors

Params
Fields paramsQuery :: Query paramsHeaders :: RequestHeaders paramsBody :: ParamBody

Instances

Show Params Source #
Instance details Defined in BitMEX.Core Methods showsPrec :: Int -> Params -> ShowS # show :: Params -> String # showList :: [Params] -> ShowS #

paramsQueryL :: Lens_' Params Query Source #

paramsQuery Lens

paramsHeadersL :: Lens_' Params RequestHeaders Source #

paramsHeaders Lens

paramsBodyL :: Lens_' Params ParamBody Source #

paramsBody Lens

data ParamBody Source #

Request Body

Constructors

ParamBodyNone
ParamBodyB ByteString
ParamBodyBL ByteString
ParamBodyFormUrlEncoded Form
ParamBodyMultipartFormData [Part]

Instances

Show ParamBody Source #
Instance details Defined in BitMEX.Core Methods showsPrec :: Int -> ParamBody -> ShowS # show :: ParamBody -> String # showList :: [ParamBody] -> ShowS #

BitMEXRequest Utils

_mkRequest Source #

Arguments

:: Method	Method
-> [ByteString]	Endpoint
-> BitMEXRequest req contentType res accept	req: Request Type, res: Response Type

_mkParams :: Params Source #

setHeader :: BitMEXRequest req contentType res accept -> [Header] -> BitMEXRequest req contentType res accept Source #

removeHeader :: BitMEXRequest req contentType res accept -> [HeaderName] -> BitMEXRequest req contentType res accept Source #

_setContentTypeHeader :: forall req contentType res accept. MimeType contentType => BitMEXRequest req contentType res accept -> BitMEXRequest req contentType res accept Source #

_setAcceptHeader :: forall req contentType res accept. MimeType accept => BitMEXRequest req contentType res accept -> BitMEXRequest req contentType res accept Source #

setQuery :: BitMEXRequest req contentType res accept -> [QueryItem] -> BitMEXRequest req contentType res accept Source #

addForm :: BitMEXRequest req contentType res accept -> Form -> BitMEXRequest req contentType res accept Source #

_addMultiFormPart :: BitMEXRequest req contentType res accept -> Part -> BitMEXRequest req contentType res accept Source #

_setBodyBS :: BitMEXRequest req contentType res accept -> ByteString -> BitMEXRequest req contentType res accept Source #

_setBodyLBS :: BitMEXRequest req contentType res accept -> ByteString -> BitMEXRequest req contentType res accept Source #

_hasAuthType :: AuthMethod authMethod => BitMEXRequest req contentType res accept -> Proxy authMethod -> BitMEXRequest req contentType res accept Source #

Params Utils

toPath :: ToHttpApiData a => a -> ByteString Source #

toHeader :: ToHttpApiData a => (HeaderName, a) -> [Header] Source #

toForm :: ToHttpApiData v => (ByteString, v) -> Form Source #

toQuery :: ToHttpApiData a => (ByteString, Maybe a) -> [QueryItem] Source #

Swagger `CollectionFormat` Utils

data CollectionFormat Source #

Determines the format of the array if type array is used.

Constructors

CommaSeparated	CSV format for multiple parameters.
SpaceSeparated	Also called SSV
TabSeparated	Also called TSV
PipeSeparated	`value1\|value2\|value2`
MultiParamArray	Using multiple GET parameters, e.g. `foo=bar&foo=baz`. This is valid only for parameters in "query" (`Query`) or "formData" (`Form`)

toHeaderColl :: ToHttpApiData a => CollectionFormat -> (HeaderName, [a]) -> [Header] Source #

toFormColl :: ToHttpApiData v => CollectionFormat -> (ByteString, [v]) -> Form Source #

toQueryColl :: ToHttpApiData a => CollectionFormat -> (ByteString, Maybe [a]) -> Query Source #

_toColl :: Traversable f => CollectionFormat -> (f a -> [(b, ByteString)]) -> f [a] -> [(b, ByteString)] Source #

_toCollA :: (Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t ByteString)]) -> f (t [a]) -> [(b, t ByteString)] Source #

_toCollA' :: (Monoid c, Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t c)]) -> (Char -> c) -> f (t [a]) -> [(b, t c)] Source #

AuthMethods

class Typeable a => AuthMethod a where Source #

Provides a method to apply auth methods to requests

Minimal complete definition

applyAuthMethod

Methods

applyAuthMethod :: BitMEXConfig -> a -> BitMEXRequest req contentType res accept -> IO (BitMEXRequest req contentType res accept) Source #

Instances

AuthMethod AnyAuthMethod Source #
Instance details Defined in BitMEX.Core Methods applyAuthMethod :: BitMEXConfig -> AnyAuthMethod -> BitMEXRequest req contentType res accept -> IO (BitMEXRequest req contentType res accept) Source #
AuthMethod AuthApiKeyApiSignature Source #
Instance details Defined in BitMEX.API Methods applyAuthMethod :: BitMEXConfig -> AuthApiKeyApiSignature -> BitMEXRequest req contentType res accept -> IO (BitMEXRequest req contentType res accept) Source #
AuthMethod AuthApiKeyApiNonce Source #
Instance details Defined in BitMEX.API Methods applyAuthMethod :: BitMEXConfig -> AuthApiKeyApiNonce -> BitMEXRequest req contentType res accept -> IO (BitMEXRequest req contentType res accept) Source #
AuthMethod AuthApiKeyApiKey Source #
Instance details Defined in BitMEX.API Methods applyAuthMethod :: BitMEXConfig -> AuthApiKeyApiKey -> BitMEXRequest req contentType res accept -> IO (BitMEXRequest req contentType res accept) Source #

data AnyAuthMethod Source #

An existential wrapper for any AuthMethod

Constructors

AuthMethod a => AnyAuthMethod a

Instances

AuthMethod AnyAuthMethod Source #
Instance details Defined in BitMEX.Core Methods applyAuthMethod :: BitMEXConfig -> AnyAuthMethod -> BitMEXRequest req contentType res accept -> IO (BitMEXRequest req contentType res accept) Source #

data AuthMethodException Source #

indicates exceptions related to AuthMethods

Constructors

AuthMethodException String

Instances

Show AuthMethodException Source #
Instance details Defined in BitMEX.Core Methods showsPrec :: Int -> AuthMethodException -> ShowS # show :: AuthMethodException -> String # showList :: [AuthMethodException] -> ShowS #
Exception AuthMethodException Source #
Instance details Defined in BitMEX.Core Methods toException :: AuthMethodException -> SomeException # fromException :: SomeException -> Maybe AuthMethodException # displayException :: AuthMethodException -> String #

_applyAuthMethods :: BitMEXRequest req contentType res accept -> BitMEXConfig -> IO (BitMEXRequest req contentType res accept) Source #

apply all matching AuthMethods in config to request

Utils

_omitNulls :: [(Text, Value)] -> Value Source #

Removes Null fields. (OpenAPI-Specification 2.0 does not allow Null in JSON)

_toFormItem :: (ToHttpApiData a, Functor f) => t -> f a -> f (t, [Text]) Source #

Encodes fields using WH.toQueryParam

_emptyToNothing :: Maybe String -> Maybe String Source #

Collapse (Just "") to Nothing

_memptyToNothing :: (Monoid a, Eq a) => Maybe a -> Maybe a Source #

Collapse (Just mempty) to Nothing

DateTime Formatting

newtype DateTime Source #

Constructors

DateTime
Fields unDateTime :: UTCTime

Instances

Eq DateTime Source #
Instance details Defined in BitMEX.Core Methods (==) :: DateTime -> DateTime -> Bool # (/=) :: DateTime -> DateTime -> Bool #
Data DateTime Source #
Instance details Defined in BitMEX.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DateTime -> c DateTime # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DateTime # toConstr :: DateTime -> Constr # dataTypeOf :: DateTime -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DateTime) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DateTime) # gmapT :: (forall b. Data b => b -> b) -> DateTime -> DateTime # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DateTime -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DateTime -> r # gmapQ :: (forall d. Data d => d -> u) -> DateTime -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DateTime -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime #
Ord DateTime Source #
Instance details Defined in BitMEX.Core Methods compare :: DateTime -> DateTime -> Ordering # (<) :: DateTime -> DateTime -> Bool # (<=) :: DateTime -> DateTime -> Bool # (>) :: DateTime -> DateTime -> Bool # (>=) :: DateTime -> DateTime -> Bool # max :: DateTime -> DateTime -> DateTime # min :: DateTime -> DateTime -> DateTime #
Show DateTime Source #
Instance details Defined in BitMEX.Core Methods showsPrec :: Int -> DateTime -> ShowS # show :: DateTime -> String # showList :: [DateTime] -> ShowS #
ToJSON DateTime Source #
Instance details Defined in BitMEX.Core Methods toJSON :: DateTime -> Value # toEncoding :: DateTime -> Encoding # toJSONList :: [DateTime] -> Value # toEncodingList :: [DateTime] -> Encoding #
FromJSON DateTime Source #
Instance details Defined in BitMEX.Core Methods parseJSON :: Value -> Parser DateTime # parseJSONList :: Value -> Parser [DateTime] #
NFData DateTime Source #
Instance details Defined in BitMEX.Core Methods rnf :: DateTime -> () #
ToHttpApiData DateTime Source #
Instance details Defined in BitMEX.Core Methods toUrlPiece :: DateTime -> Text # toEncodedUrlPiece :: DateTime -> Builder # toHeader :: DateTime -> ByteString # toQueryParam :: DateTime -> Text #
FromHttpApiData DateTime Source #
Instance details Defined in BitMEX.Core Methods parseUrlPiece :: Text -> Either Text DateTime # parseHeader :: ByteString -> Either Text DateTime # parseQueryParam :: Text -> Either Text DateTime #
FormatTime DateTime Source #
Instance details Defined in BitMEX.Core Methods formatCharacter :: Char -> Maybe (TimeLocale -> Maybe NumericPadOption -> Maybe Int -> DateTime -> String) #
ParseTime DateTime Source #
Instance details Defined in BitMEX.Core Methods buildTime :: TimeLocale -> [(Char, String)] -> Maybe DateTime #
MimeRender MimeMultipartFormData DateTime Source #
Instance details Defined in BitMEX.Core Methods mimeRender :: Proxy MimeMultipartFormData -> DateTime -> ByteString Source # mimeRender' :: MimeMultipartFormData -> DateTime -> ByteString Source #

_readDateTime :: (ParseTime t, Monad m, Alternative m) => String -> m t Source #

_parseISO8601

_showDateTime :: (t ~ UTCTime, FormatTime t) => t -> String Source #

TI.formatISO8601Millis

_parseISO8601 :: (ParseTime t, Monad m, Alternative m) => String -> m t Source #

parse an ISO8601 date-time string

Date Formatting

newtype Date Source #

Constructors

Date
Fields unDate :: Day

Instances

Enum Date Source #
Instance details Defined in BitMEX.Core Methods succ :: Date -> Date # pred :: Date -> Date # toEnum :: Int -> Date # fromEnum :: Date -> Int # enumFrom :: Date -> [Date] # enumFromThen :: Date -> Date -> [Date] # enumFromTo :: Date -> Date -> [Date] # enumFromThenTo :: Date -> Date -> Date -> [Date] #
Eq Date Source #
Instance details Defined in BitMEX.Core Methods (==) :: Date -> Date -> Bool # (/=) :: Date -> Date -> Bool #
Data Date Source #
Instance details Defined in BitMEX.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Date -> c Date # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Date # toConstr :: Date -> Constr # dataTypeOf :: Date -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Date) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Date) # gmapT :: (forall b. Data b => b -> b) -> Date -> Date # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQ :: (forall d. Data d => d -> u) -> Date -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Date -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date #
Ord Date Source #
Instance details Defined in BitMEX.Core Methods compare :: Date -> Date -> Ordering # (<) :: Date -> Date -> Bool # (<=) :: Date -> Date -> Bool # (>) :: Date -> Date -> Bool # (>=) :: Date -> Date -> Bool # max :: Date -> Date -> Date # min :: Date -> Date -> Date #
Show Date Source #
Instance details Defined in BitMEX.Core Methods showsPrec :: Int -> Date -> ShowS # show :: Date -> String # showList :: [Date] -> ShowS #
Ix Date Source #
Instance details Defined in BitMEX.Core Methods range :: (Date, Date) -> [Date] # index :: (Date, Date) -> Date -> Int # unsafeIndex :: (Date, Date) -> Date -> Int inRange :: (Date, Date) -> Date -> Bool # rangeSize :: (Date, Date) -> Int # unsafeRangeSize :: (Date, Date) -> Int
ToJSON Date Source #
Instance details Defined in BitMEX.Core Methods toJSON :: Date -> Value # toEncoding :: Date -> Encoding # toJSONList :: [Date] -> Value # toEncodingList :: [Date] -> Encoding #
FromJSON Date Source #
Instance details Defined in BitMEX.Core Methods parseJSON :: Value -> Parser Date # parseJSONList :: Value -> Parser [Date] #
NFData Date Source #
Instance details Defined in BitMEX.Core Methods rnf :: Date -> () #
ToHttpApiData Date Source #
Instance details Defined in BitMEX.Core Methods toUrlPiece :: Date -> Text # toEncodedUrlPiece :: Date -> Builder # toHeader :: Date -> ByteString # toQueryParam :: Date -> Text #
FromHttpApiData Date Source #
Instance details Defined in BitMEX.Core Methods parseUrlPiece :: Text -> Either Text Date # parseHeader :: ByteString -> Either Text Date # parseQueryParam :: Text -> Either Text Date #
FormatTime Date Source #
Instance details Defined in BitMEX.Core Methods formatCharacter :: Char -> Maybe (TimeLocale -> Maybe NumericPadOption -> Maybe Int -> Date -> String) #
ParseTime Date Source #
Instance details Defined in BitMEX.Core Methods buildTime :: TimeLocale -> [(Char, String)] -> Maybe Date #
MimeRender MimeMultipartFormData Date Source #
Instance details Defined in BitMEX.Core Methods mimeRender :: Proxy MimeMultipartFormData -> Date -> ByteString Source # mimeRender' :: MimeMultipartFormData -> Date -> ByteString Source #

_readDate :: (ParseTime t, Monad m) => String -> m t Source #

TI.parseTimeM True TI.defaultTimeLocale "%Y-%m-%d"

_showDate :: FormatTime t => t -> String Source #

TI.formatTime TI.defaultTimeLocale "%Y-%m-%d"

Byte/Binary Formatting

newtype ByteArray Source #

base64 encoded characters

Constructors

ByteArray
Fields unByteArray :: ByteString

Instances

Eq ByteArray Source #
Instance details Defined in BitMEX.Core Methods (==) :: ByteArray -> ByteArray -> Bool # (/=) :: ByteArray -> ByteArray -> Bool #
Data ByteArray Source #
Instance details Defined in BitMEX.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ByteArray -> c ByteArray # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ByteArray # toConstr :: ByteArray -> Constr # dataTypeOf :: ByteArray -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ByteArray) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ByteArray) # gmapT :: (forall b. Data b => b -> b) -> ByteArray -> ByteArray # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ByteArray -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ByteArray -> r # gmapQ :: (forall d. Data d => d -> u) -> ByteArray -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ByteArray -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray #
Ord ByteArray Source #
Instance details Defined in BitMEX.Core Methods compare :: ByteArray -> ByteArray -> Ordering # (<) :: ByteArray -> ByteArray -> Bool # (<=) :: ByteArray -> ByteArray -> Bool # (>) :: ByteArray -> ByteArray -> Bool # (>=) :: ByteArray -> ByteArray -> Bool # max :: ByteArray -> ByteArray -> ByteArray # min :: ByteArray -> ByteArray -> ByteArray #
Show ByteArray Source #
Instance details Defined in BitMEX.Core Methods showsPrec :: Int -> ByteArray -> ShowS # show :: ByteArray -> String # showList :: [ByteArray] -> ShowS #
ToJSON ByteArray Source #
Instance details Defined in BitMEX.Core Methods toJSON :: ByteArray -> Value # toEncoding :: ByteArray -> Encoding # toJSONList :: [ByteArray] -> Value # toEncodingList :: [ByteArray] -> Encoding #
FromJSON ByteArray Source #
Instance details Defined in BitMEX.Core Methods parseJSON :: Value -> Parser ByteArray # parseJSONList :: Value -> Parser [ByteArray] #
NFData ByteArray Source #
Instance details Defined in BitMEX.Core Methods rnf :: ByteArray -> () #
ToHttpApiData ByteArray Source #
Instance details Defined in BitMEX.Core Methods toUrlPiece :: ByteArray -> Text # toEncodedUrlPiece :: ByteArray -> Builder # toHeader :: ByteArray -> ByteString # toQueryParam :: ByteArray -> Text #
FromHttpApiData ByteArray Source #
Instance details Defined in BitMEX.Core Methods parseUrlPiece :: Text -> Either Text ByteArray # parseHeader :: ByteString -> Either Text ByteArray # parseQueryParam :: Text -> Either Text ByteArray #
MimeRender MimeMultipartFormData ByteArray Source #
Instance details Defined in BitMEX.Core Methods mimeRender :: Proxy MimeMultipartFormData -> ByteArray -> ByteString Source # mimeRender' :: MimeMultipartFormData -> ByteArray -> ByteString Source #

_readByteArray :: Monad m => Text -> m ByteArray Source #

read base64 encoded characters

_showByteArray :: ByteArray -> Text Source #

show base64 encoded characters

newtype Binary Source #

any sequence of octets

Constructors

Binary
Fields unBinary :: ByteString

Instances

Eq Binary Source #
Instance details Defined in BitMEX.Core Methods (==) :: Binary -> Binary -> Bool # (/=) :: Binary -> Binary -> Bool #
Data Binary Source #
Instance details Defined in BitMEX.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Binary -> c Binary # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Binary # toConstr :: Binary -> Constr # dataTypeOf :: Binary -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Binary) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Binary) # gmapT :: (forall b. Data b => b -> b) -> Binary -> Binary # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Binary -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Binary -> r # gmapQ :: (forall d. Data d => d -> u) -> Binary -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Binary -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Binary -> m Binary # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Binary -> m Binary # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Binary -> m Binary #
Ord Binary Source #
Instance details Defined in BitMEX.Core Methods compare :: Binary -> Binary -> Ordering # (<) :: Binary -> Binary -> Bool # (<=) :: Binary -> Binary -> Bool # (>) :: Binary -> Binary -> Bool # (>=) :: Binary -> Binary -> Bool # max :: Binary -> Binary -> Binary # min :: Binary -> Binary -> Binary #
Show Binary Source #
Instance details Defined in BitMEX.Core Methods showsPrec :: Int -> Binary -> ShowS # show :: Binary -> String # showList :: [Binary] -> ShowS #
ToJSON Binary Source #
Instance details Defined in BitMEX.Core Methods toJSON :: Binary -> Value # toEncoding :: Binary -> Encoding # toJSONList :: [Binary] -> Value # toEncodingList :: [Binary] -> Encoding #
FromJSON Binary Source #
Instance details Defined in BitMEX.Core Methods parseJSON :: Value -> Parser Binary # parseJSONList :: Value -> Parser [Binary] #
NFData Binary Source #
Instance details Defined in BitMEX.Core Methods rnf :: Binary -> () #
ToHttpApiData Binary Source #
Instance details Defined in BitMEX.Core Methods toUrlPiece :: Binary -> Text # toEncodedUrlPiece :: Binary -> Builder # toHeader :: Binary -> ByteString # toQueryParam :: Binary -> Text #
FromHttpApiData Binary Source #
Instance details Defined in BitMEX.Core Methods parseUrlPiece :: Text -> Either Text Binary # parseHeader :: ByteString -> Either Text Binary # parseQueryParam :: Text -> Either Text Binary #
MimeRender MimeMultipartFormData Binary Source #
Instance details Defined in BitMEX.Core Methods mimeRender :: Proxy MimeMultipartFormData -> Binary -> ByteString Source # mimeRender' :: MimeMultipartFormData -> Binary -> ByteString Source #

_readBinaryBase64 :: Monad m => Text -> m Binary Source #

_showBinaryBase64 :: Binary -> Text Source #

Lens Type Aliases

type Lens_' s a = Lens_ s s a a Source #

type Lens_ s t a b = forall (f :: * -> *). Functor f => (a -> f b) -> s -> f t Source #

BitMEXConfig

BitMEXRequest

HasBodyParam

HasOptionalParam

BitMEXRequest Utils

Params Utils

Swagger CollectionFormat Utils

AuthMethods

Utils

DateTime Formatting

Date Formatting

Byte/Binary Formatting

Lens Type Aliases

Swagger `CollectionFormat` Utils