haskell-bitmex-rest-0.1.0.0: Auto-generated bitmex API Client

Safe HaskellNone
LanguageHaskell2010

BitMEX.API

Contents

Description

 
Synopsis

Operations

APIKey

aPIKeyDisable

aPIKeyDisable Source #

Arguments

:: Consumes APIKeyDisable contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> ApiKeyId

"apiKeyId" - API Key ID (public component).

-> BitMEXRequest APIKeyDisable contentType APIKey accept 
POST /apiKey/disable

Disable an API Key.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data APIKeyDisable Source #

Instances
Produces APIKeyDisable MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces APIKeyDisable MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces APIKeyDisable MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces APIKeyDisable MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces APIKeyDisable MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes APIKeyDisable MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes APIKeyDisable MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

aPIKeyEnable

aPIKeyEnable Source #

Arguments

:: Consumes APIKeyEnable contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> ApiKeyId

"apiKeyId" - API Key ID (public component).

-> BitMEXRequest APIKeyEnable contentType APIKey accept 
POST /apiKey/enable

Enable an API Key.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data APIKeyEnable Source #

Instances
Produces APIKeyEnable MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces APIKeyEnable MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces APIKeyEnable MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces APIKeyEnable MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces APIKeyEnable MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes APIKeyEnable MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes APIKeyEnable MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

aPIKeyGet

aPIKeyGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest APIKeyGet MimeNoContent [APIKey] accept 
GET /apiKey

Get your API Keys.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data APIKeyGet Source #

Instances
Produces APIKeyGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces APIKeyGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces APIKeyGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces APIKeyGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces APIKeyGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes APIKeyGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes APIKeyGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

aPIKeyNew

aPIKeyNew Source #

Arguments

:: Consumes APIKeyNew contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> BitMEXRequest APIKeyNew contentType APIKey accept 
POST /apiKey

Create a new API Key.

API Keys can also be created via this Python script See the API Key Documentation for more information on capabilities.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data APIKeyNew Source #

Instances
Produces APIKeyNew MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces APIKeyNew MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces APIKeyNew MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces APIKeyNew MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces APIKeyNew MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes APIKeyNew MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes APIKeyNew MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

aPIKeyRemove

aPIKeyRemove Source #

Arguments

:: Consumes APIKeyRemove contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> ApiKeyId

"apiKeyId" - API Key ID (public component).

-> BitMEXRequest APIKeyRemove contentType InlineResponse200 accept 
DELETE /apiKey

Remove an API Key.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data APIKeyRemove Source #

Instances
Produces APIKeyRemove MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces APIKeyRemove MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces APIKeyRemove MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces APIKeyRemove MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces APIKeyRemove MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes APIKeyRemove MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes APIKeyRemove MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Announcement

announcementGet

announcementGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest AnnouncementGet MimeNoContent [Announcement] accept 
GET /announcement

Get site announcements.

data AnnouncementGet Source #

Instances
Produces AnnouncementGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces AnnouncementGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces AnnouncementGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces AnnouncementGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces AnnouncementGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes AnnouncementGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes AnnouncementGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

announcementGetUrgent

announcementGetUrgent Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest AnnouncementGetUrgent MimeNoContent [Announcement] accept 
GET /announcement/urgent

Get urgent (banner) announcements.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data AnnouncementGetUrgent Source #

Instances
Produces AnnouncementGetUrgent MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces AnnouncementGetUrgent MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces AnnouncementGetUrgent MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces AnnouncementGetUrgent MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces AnnouncementGetUrgent MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes AnnouncementGetUrgent MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes AnnouncementGetUrgent MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Chat

chatGet

chatGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest ChatGet MimeNoContent [Chat] accept 
GET /chat

Get chat messages.

data ChatGet Source #

Instances
Produces ChatGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces ChatGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces ChatGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces ChatGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces ChatGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes ChatGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes ChatGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

chatGetChannels

chatGetChannels Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest ChatGetChannels MimeNoContent [ChatChannels] accept 
GET /chat/channels

Get available channels.

data ChatGetChannels Source #

Instances
Produces ChatGetChannels MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces ChatGetChannels MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces ChatGetChannels MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces ChatGetChannels MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces ChatGetChannels MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes ChatGetChannels MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes ChatGetChannels MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

chatGetConnected

chatGetConnected Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest ChatGetConnected MimeNoContent ConnectedUsers accept 
GET /chat/connected

Get connected users.

Returns an array with browser users in the first position and API users (bots) in the second position.

data ChatGetConnected Source #

Instances
Produces ChatGetConnected MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces ChatGetConnected MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces ChatGetConnected MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces ChatGetConnected MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces ChatGetConnected MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes ChatGetConnected MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes ChatGetConnected MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

chatNew

chatNew Source #

Arguments

:: Consumes ChatNew contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Message

"message"

-> BitMEXRequest ChatNew contentType Chat accept 
POST /chat

Send a chat message.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data ChatNew Source #

Instances
Produces ChatNew MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces ChatNew MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces ChatNew MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces ChatNew MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces ChatNew MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes ChatNew MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes ChatNew MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

Execution

executionGet

executionGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest ExecutionGet MimeNoContent [Execution] accept 
GET /execution

Get all raw executions for your account.

This returns all raw transactions, which includes order opening and cancelation, and order status changes. It can be quite noisy. More focused information is available at `/execution/tradeHistory`. You may also use the filter param to target your query. Specify an array as a filter value, such as `{"execType": ["Settlement", "Trade"]}` to filter on multiple values. See the FIX Spec for explanations of these fields.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data ExecutionGet Source #

Instances
Produces ExecutionGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces ExecutionGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces ExecutionGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces ExecutionGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces ExecutionGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes ExecutionGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes ExecutionGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

executionGetTradeHistory

executionGetTradeHistory Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest ExecutionGetTradeHistory MimeNoContent [Execution] accept 
GET /execution/tradeHistory

Get all balance-affecting executions. This includes each trade, insurance charge, and settlement.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data ExecutionGetTradeHistory Source #

Instances
Produces ExecutionGetTradeHistory MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces ExecutionGetTradeHistory MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces ExecutionGetTradeHistory MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces ExecutionGetTradeHistory MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces ExecutionGetTradeHistory MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes ExecutionGetTradeHistory MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes ExecutionGetTradeHistory MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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

HasOptionalParam ExecutionGetTradeHistory StartTime Source #

Optional Param "startTime" - Starting date filter for results.

Instance details

Defined in BitMEX.API

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

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

HasOptionalParam ExecutionGetTradeHistory EndTime Source #

Optional Param "endTime" - Ending date filter for results.

Instance details

Defined in BitMEX.API

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

Funding

fundingGet

fundingGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest FundingGet MimeNoContent [Funding] accept 
GET /funding

Get funding history.

data FundingGet Source #

Instances
Produces FundingGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces FundingGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces FundingGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces FundingGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces FundingGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes FundingGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes FundingGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

Instrument

instrumentGet

instrumentGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest InstrumentGet MimeNoContent [Instrument] accept 
GET /instrument

Get instruments.

This returns all instruments and indices, including those that have settled or are unlisted. Use this endpoint if you want to query for individual instruments or use a complex filter. Use `/instrument/active` to return active instruments, or use a filter like `{"state": "Open"}`.

data InstrumentGet Source #

Instances
Produces InstrumentGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces InstrumentGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces InstrumentGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces InstrumentGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces InstrumentGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes InstrumentGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes InstrumentGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

instrumentGetActive

instrumentGetActive Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest InstrumentGetActive MimeNoContent [Instrument] accept 
GET /instrument/active

Get all active instruments and instruments that have expired in <24hrs.

data InstrumentGetActive Source #

Instances
Produces InstrumentGetActive MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces InstrumentGetActive MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces InstrumentGetActive MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces InstrumentGetActive MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces InstrumentGetActive MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes InstrumentGetActive MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes InstrumentGetActive MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

instrumentGetActiveAndIndices

instrumentGetActiveAndIndices Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest InstrumentGetActiveAndIndices MimeNoContent [Instrument] accept 
GET /instrument/activeAndIndices

Helper method. Gets all active instruments and all indices. This is a join of the result of indices and active.

data InstrumentGetActiveAndIndices Source #

Instances
Produces InstrumentGetActiveAndIndices MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces InstrumentGetActiveAndIndices MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces InstrumentGetActiveAndIndices MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces InstrumentGetActiveAndIndices MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces InstrumentGetActiveAndIndices MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes InstrumentGetActiveAndIndices MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes InstrumentGetActiveAndIndices MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

instrumentGetActiveIntervals

instrumentGetActiveIntervals Source #

GET /instrument/activeIntervals

Return all active contract series and interval pairs.

This endpoint is useful for determining which pairs are live. It returns two arrays of strings. The first is intervals, such as `["BVOL:daily", "BVOL:weekly", "XBU:daily", "XBU:monthly", ...]`. These identifiers are usable in any query's symbol param. The second array is the current resolution of these intervals. Results are mapped at the same index.

data InstrumentGetActiveIntervals Source #

Instances
Produces InstrumentGetActiveIntervals MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces InstrumentGetActiveIntervals MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces InstrumentGetActiveIntervals MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces InstrumentGetActiveIntervals MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces InstrumentGetActiveIntervals MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes InstrumentGetActiveIntervals MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes InstrumentGetActiveIntervals MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

instrumentGetCompositeIndex

instrumentGetCompositeIndex Source #

GET /instrument/compositeIndex

Show constituent parts of an index.

Composite indices are built from multiple external price sources. Use this endpoint to get the underlying prices of an index. For example, send a symbol of `.XBT` to get the ticks and weights of the constituent exchanges that build the ".XBT" index. A tick with reference `"BMI"` and weight null is the composite index tick.

data InstrumentGetCompositeIndex Source #

Instances
Produces InstrumentGetCompositeIndex MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces InstrumentGetCompositeIndex MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces InstrumentGetCompositeIndex MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces InstrumentGetCompositeIndex MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces InstrumentGetCompositeIndex MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes InstrumentGetCompositeIndex MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes InstrumentGetCompositeIndex MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

HasOptionalParam InstrumentGetCompositeIndex Symbol Source #

Optional Param "symbol" - The composite index symbol.

Instance details

Defined in BitMEX.API

HasOptionalParam InstrumentGetCompositeIndex StartTime Source #

Optional Param "startTime" - Starting date filter for results.

Instance details

Defined in BitMEX.API

HasOptionalParam InstrumentGetCompositeIndex Start Source #

Optional Param "start" - Starting point for results.

Instance details

Defined in BitMEX.API

HasOptionalParam InstrumentGetCompositeIndex Reverse Source #

Optional Param "reverse" - If true, will sort results newest first.

Instance details

Defined in BitMEX.API

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

HasOptionalParam InstrumentGetCompositeIndex EndTime Source #

Optional Param "endTime" - Ending date filter for results.

Instance details

Defined in BitMEX.API

HasOptionalParam InstrumentGetCompositeIndex Count Source #

Optional Param "count" - Number of results to fetch.

Instance details

Defined in BitMEX.API

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

HasOptionalParam InstrumentGetCompositeIndex Account Source # 
Instance details

Defined in BitMEX.API

instrumentGetIndices

instrumentGetIndices Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest InstrumentGetIndices MimeNoContent [Instrument] accept 
GET /instrument/indices

Get all price indices.

data InstrumentGetIndices Source #

Instances
Produces InstrumentGetIndices MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces InstrumentGetIndices MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces InstrumentGetIndices MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces InstrumentGetIndices MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces InstrumentGetIndices MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes InstrumentGetIndices MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes InstrumentGetIndices MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Insurance

insuranceGet

insuranceGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest InsuranceGet MimeNoContent [Insurance] accept 
GET /insurance

Get insurance fund history.

data InsuranceGet Source #

Instances
Produces InsuranceGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces InsuranceGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces InsuranceGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces InsuranceGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces InsuranceGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes InsuranceGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes InsuranceGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

Leaderboard

leaderboardGet

leaderboardGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest LeaderboardGet MimeNoContent [Leaderboard] accept 
GET /leaderboard

Get current leaderboard.

data LeaderboardGet Source #

Instances
Produces LeaderboardGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces LeaderboardGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces LeaderboardGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces LeaderboardGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces LeaderboardGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes LeaderboardGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes LeaderboardGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

Liquidation

liquidationGet

liquidationGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest LiquidationGet MimeNoContent [Liquidation] accept 
GET /liquidation

Get liquidation orders.

data LiquidationGet Source #

Instances
Produces LiquidationGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces LiquidationGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces LiquidationGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces LiquidationGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces LiquidationGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes LiquidationGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes LiquidationGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

Notification

notificationGet

notificationGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest NotificationGet MimeNoContent [Notification] accept 
GET /notification

Get your current notifications.

This is an upcoming feature and currently does not return data.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data NotificationGet Source #

Instances
Produces NotificationGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces NotificationGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces NotificationGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces NotificationGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces NotificationGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes NotificationGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes NotificationGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Order

orderAmend

orderAmend Source #

Arguments

:: Consumes OrderAmend contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> BitMEXRequest OrderAmend contentType Order accept 
PUT /order

Amend the quantity or price of an open order.

Send an orderID or origClOrdID to identify the order you wish to amend. Both order quantity and price can be amended. Only one qty field can be used to amend. Use the leavesQty field to specify how much of the order you wish to remain open. This can be useful if you want to adjust your position's delta by a certain amount, regardless of how much of the order has already filled. Use the simpleOrderQty and simpleLeavesQty fields to specify order size in Bitcoin, rather than contracts. These fields will round up to the nearest contract. Like order placement, amending can be done in bulk. Simply send a request to `PUT apiv1orderbulk` with a JSON body of the shape: `{"orders": [{...}, {...}]}`, each object containing the fields used in this endpoint.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data OrderAmend Source #

Instances
Produces OrderAmend MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces OrderAmend MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces OrderAmend MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces OrderAmend MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces OrderAmend MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes OrderAmend MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes OrderAmend MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

orderAmendBulk

orderAmendBulk Source #

Arguments

:: Consumes OrderAmendBulk contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> BitMEXRequest OrderAmendBulk contentType [Order] accept 
PUT /order/bulk

Amend multiple orders for the same symbol.

Similar to POST amend, but with multiple orders. `applicationjson` only. Ratelimited at 50%.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data OrderAmendBulk Source #

Instances
Produces OrderAmendBulk MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces OrderAmendBulk MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces OrderAmendBulk MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces OrderAmendBulk MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces OrderAmendBulk MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes OrderAmendBulk MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes OrderAmendBulk MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

orderCancel

orderCancel Source #

Arguments

:: Consumes OrderCancel contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> BitMEXRequest OrderCancel contentType [Order] accept 
DELETE /order

Cancel order(s). Send multiple order IDs to cancel in bulk.

Either an orderID or a clOrdID must be provided.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data OrderCancel Source #

Instances
Produces OrderCancel MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces OrderCancel MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces OrderCancel MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces OrderCancel MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces OrderCancel MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes OrderCancel MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes OrderCancel MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

orderCancelAll

orderCancelAll Source #

Arguments

:: Consumes OrderCancelAll contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> BitMEXRequest OrderCancelAll contentType Value accept 
DELETE /order/all

Cancels all of your orders.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data OrderCancelAll Source #

Instances
Produces OrderCancelAll MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces OrderCancelAll MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces OrderCancelAll MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces OrderCancelAll MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces OrderCancelAll MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes OrderCancelAll MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes OrderCancelAll MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

orderCancelAllAfter

orderCancelAllAfter Source #

Arguments

:: Consumes OrderCancelAllAfter contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Timeout

"timeout" - Timeout in ms. Set to 0 to cancel this timer.

-> BitMEXRequest OrderCancelAllAfter contentType Value accept 
POST /order/cancelAllAfter

Automatically cancel all your orders after a specified timeout.

Useful as a dead-man's switch to ensure your orders are canceled in case of an outage. If called repeatedly, the existing offset will be canceled and a new one will be inserted in its place. Example usage: call this route at 15s intervals with an offset of 60000 (60s). If this route is not called within 60 seconds, all your orders will be automatically canceled. This is also available via WebSocket.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data OrderCancelAllAfter Source #

Instances
Produces OrderCancelAllAfter MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces OrderCancelAllAfter MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces OrderCancelAllAfter MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces OrderCancelAllAfter MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces OrderCancelAllAfter MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes OrderCancelAllAfter MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes OrderCancelAllAfter MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

orderClosePosition

orderClosePosition Source #

Arguments

:: Consumes OrderClosePosition contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Symbol

"symbol" - Symbol of position to close.

-> BitMEXRequest OrderClosePosition contentType Order accept 
POST /order/closePosition

Close a position. [Deprecated, use POST /order with execInst: Close]

If no price is specified, a market order will be submitted to close the whole of your position. This will also close all other open orders in this symbol.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data OrderClosePosition Source #

Instances
Produces OrderClosePosition MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces OrderClosePosition MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces OrderClosePosition MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces OrderClosePosition MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces OrderClosePosition MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes OrderClosePosition MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes OrderClosePosition MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

orderGetOrders

orderGetOrders Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest OrderGetOrders MimeNoContent [Order] accept 
GET /order

Get your orders.

To get open orders only, send {"open": true} in the filter param. See href="http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_D_68.html"the FIX Spec/a for explanations of these fields.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data OrderGetOrders Source #

Instances
Produces OrderGetOrders MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces OrderGetOrders MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces OrderGetOrders MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces OrderGetOrders MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces OrderGetOrders MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes OrderGetOrders MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes OrderGetOrders MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

orderNew

orderNew Source #

Arguments

:: Consumes OrderNew contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Symbol

"symbol" - Instrument symbol. e.g. XBTUSD.

-> BitMEXRequest OrderNew contentType Order accept 
POST /order

Create a new order.

#############!OrderOrder_newBulk) if you need to place multiple orders at the same time. Bulk orders require fewer risk checks in the trading engine and thus are ratelimited at **110** the normal rate. You can also improve your reactivity to market movements while staying under your ratelimit by using the [Amend](#!OrderOrder_amend) and [Amend Bulk](#!OrderOrder_amendBulk) endpoints. This allows you to stay in the market and avoids the cancelreplace cycle. #### Tracking Your Orders If you want to keep track of order IDs yourself, set a unique clOrdID per order. This clOrdID will come back as a property on the order and any related executions (including on the WebSocket), and can be used to get or cancel the order. Max length is 36 characters.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data OrderNew Source #

Instances
Produces OrderNew MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces OrderNew MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces OrderNew MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces OrderNew MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces OrderNew MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes OrderNew MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes OrderNew MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

orderNewBulk

orderNewBulk Source #

Arguments

:: Consumes OrderNewBulk contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> BitMEXRequest OrderNewBulk contentType [Order] accept 
POST /order/bulk

Create multiple new orders for the same symbol.

This endpoint is used for placing bulk orders. Valid order types are Market, Limit, Stop, StopLimit, MarketIfTouched, LimitIfTouched, MarketWithLeftOverAsLimit, and Pegged. Each individual order object in the array should have the same properties as an individual POST order call. This endpoint is much faster for getting many orders into the book at once. Because it reduces load on BitMEX systems, this endpoint is ratelimited at `ceil(0.1 * orders)`. Submitting 10 orders via a bulk order call will only count as 1 request, 15 as 2, 32 as 4, and so on. For now, only `applicationjson` is supported on this endpoint.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data OrderNewBulk Source #

Instances
Produces OrderNewBulk MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces OrderNewBulk MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces OrderNewBulk MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces OrderNewBulk MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces OrderNewBulk MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes OrderNewBulk MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes OrderNewBulk MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

OrderBook

orderBookGet

orderBookGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> Symbol

"symbol" - Instrument symbol. Send a series (e.g. XBT) to get data for the nearest contract in that series.

-> BitMEXRequest OrderBookGet MimeNoContent [OrderBook] accept 
GET /orderBook

Get current orderbook [deprecated, use orderBookL2].

data OrderBookGet Source #

Instances
Produces OrderBookGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces OrderBookGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces OrderBookGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces OrderBookGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces OrderBookGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes OrderBookGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes OrderBookGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

orderBookGetL2

orderBookGetL2 Source #

Arguments

:: Accept accept

request accept (MimeType)

-> Symbol

"symbol" - Instrument symbol. Send a series (e.g. XBT) to get data for the nearest contract in that series.

-> BitMEXRequest OrderBookGetL2 MimeNoContent [OrderBookL2] accept 
GET /orderBook/L2

Get current orderbook in vertical format.

data OrderBookGetL2 Source #

Instances
Produces OrderBookGetL2 MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces OrderBookGetL2 MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces OrderBookGetL2 MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces OrderBookGetL2 MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces OrderBookGetL2 MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes OrderBookGetL2 MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes OrderBookGetL2 MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

Position

positionGet

positionGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest PositionGet MimeNoContent [Position] accept 
GET /position

Get your positions.

See href="http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_AP_6580.html"the FIX Spec/a for explanations of these fields.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data PositionGet Source #

Instances
Produces PositionGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces PositionGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces PositionGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces PositionGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces PositionGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes PositionGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes PositionGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

positionIsolateMargin

positionIsolateMargin Source #

Arguments

:: Consumes PositionIsolateMargin contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Symbol

"symbol" - Position symbol to isolate.

-> BitMEXRequest PositionIsolateMargin contentType Position accept 
POST /position/isolate

Enable isolated margin or cross margin per-position.

Users can switch isolate margin per-position. This function allows switching margin isolation (aka fixed margin) on and off.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data PositionIsolateMargin Source #

Instances
Produces PositionIsolateMargin MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces PositionIsolateMargin MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces PositionIsolateMargin MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces PositionIsolateMargin MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces PositionIsolateMargin MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes PositionIsolateMargin MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes PositionIsolateMargin MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

positionTransferIsolatedMargin

positionTransferIsolatedMargin Source #

Arguments

:: Consumes PositionTransferIsolatedMargin contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Symbol

"symbol" - Symbol of position to isolate.

-> Amount

"amount" - Amount to transfer, in Satoshis. May be negative.

-> BitMEXRequest PositionTransferIsolatedMargin contentType Position accept 
POST /position/transferMargin

Transfer equity in or out of a position.

When margin is isolated on a position, use this function to add or remove margin from the position. Note that you cannot remove margin below the initial margin threshold.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data PositionTransferIsolatedMargin Source #

Instances
Produces PositionTransferIsolatedMargin MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces PositionTransferIsolatedMargin MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces PositionTransferIsolatedMargin MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces PositionTransferIsolatedMargin MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces PositionTransferIsolatedMargin MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes PositionTransferIsolatedMargin MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes PositionTransferIsolatedMargin MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

positionUpdateLeverage

positionUpdateLeverage Source #

Arguments

:: Consumes PositionUpdateLeverage contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Symbol

"symbol" - Symbol of position to adjust.

-> Leverage

"leverage" - Leverage value. Send a number between 0.01 and 100 to enable isolated margin with a fixed leverage. Send 0 to enable cross margin.

-> BitMEXRequest PositionUpdateLeverage contentType Position accept 
POST /position/leverage

Choose leverage for a position.

Users can choose an isolated leverage. This will automatically enable isolated margin.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data PositionUpdateLeverage Source #

Instances
Produces PositionUpdateLeverage MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces PositionUpdateLeverage MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces PositionUpdateLeverage MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces PositionUpdateLeverage MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces PositionUpdateLeverage MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes PositionUpdateLeverage MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes PositionUpdateLeverage MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

positionUpdateRiskLimit

positionUpdateRiskLimit Source #

Arguments

:: Consumes PositionUpdateRiskLimit contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Symbol

"symbol" - Symbol of position to isolate.

-> RiskLimit

"riskLimit" - New Risk Limit, in Satoshis.

-> BitMEXRequest PositionUpdateRiskLimit contentType Position accept 
POST /position/riskLimit

Update your risk limit.

Risk Limits limit the size of positions you can trade at various margin levels. Larger positions require more margin. Please see the Risk Limit documentation for more details.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data PositionUpdateRiskLimit Source #

Instances
Produces PositionUpdateRiskLimit MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces PositionUpdateRiskLimit MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces PositionUpdateRiskLimit MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces PositionUpdateRiskLimit MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces PositionUpdateRiskLimit MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes PositionUpdateRiskLimit MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes PositionUpdateRiskLimit MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Quote

quoteGet

quoteGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest QuoteGet MimeNoContent [Quote] accept 
GET /quote

Get Quotes.

data QuoteGet Source #

Instances
Produces QuoteGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces QuoteGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces QuoteGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces QuoteGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces QuoteGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes QuoteGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes QuoteGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

quoteGetBucketed

quoteGetBucketed Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest QuoteGetBucketed MimeNoContent [Quote] accept 
GET /quote/bucketed

Get previous quotes in time buckets.

data QuoteGetBucketed Source #

Instances
Produces QuoteGetBucketed MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces QuoteGetBucketed MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces QuoteGetBucketed MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces QuoteGetBucketed MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces QuoteGetBucketed MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes QuoteGetBucketed MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes QuoteGetBucketed MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

Schema

schemaGet

schemaGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest SchemaGet MimeNoContent Value accept 
GET /schema

Get model schemata for data objects returned by this API.

data SchemaGet Source #

Instances
Produces SchemaGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces SchemaGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces SchemaGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces SchemaGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces SchemaGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes SchemaGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes SchemaGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

schemaWebsocketHelp

schemaWebsocketHelp Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest SchemaWebsocketHelp MimeNoContent Value accept 
GET /schema/websocketHelp

Returns help text & subject list for websocket usage.

data SchemaWebsocketHelp Source #

Instances
Produces SchemaWebsocketHelp MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces SchemaWebsocketHelp MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces SchemaWebsocketHelp MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces SchemaWebsocketHelp MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces SchemaWebsocketHelp MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes SchemaWebsocketHelp MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes SchemaWebsocketHelp MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Settlement

settlementGet

settlementGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest SettlementGet MimeNoContent [Settlement] accept 
GET /settlement

Get settlement history.

data SettlementGet Source #

Instances
Produces SettlementGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces SettlementGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces SettlementGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces SettlementGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces SettlementGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes SettlementGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes SettlementGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

Stats

statsGet

statsGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest StatsGet MimeNoContent [Stats] accept 
GET /stats

Get exchange-wide and per-series turnover and volume statistics.

data StatsGet Source #

Instances
Produces StatsGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces StatsGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces StatsGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces StatsGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces StatsGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes StatsGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes StatsGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

statsHistory2

statsHistory2 Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest StatsHistory2 MimeNoContent [StatsHistory] accept 
GET /stats/history

Get historical exchange-wide and per-series turnover and volume statistics.

data StatsHistory2 Source #

Instances
Produces StatsHistory2 MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces StatsHistory2 MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces StatsHistory2 MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces StatsHistory2 MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces StatsHistory2 MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes StatsHistory2 MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes StatsHistory2 MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

statsHistoryUSD

statsHistoryUSD Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest StatsHistoryUSD MimeNoContent [StatsUSD] accept 
GET /stats/historyUSD

Get a summary of exchange statistics in USD.

data StatsHistoryUSD Source #

Instances
Produces StatsHistoryUSD MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces StatsHistoryUSD MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces StatsHistoryUSD MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces StatsHistoryUSD MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces StatsHistoryUSD MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes StatsHistoryUSD MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes StatsHistoryUSD MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Trade

tradeGet

tradeGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest TradeGet MimeNoContent [Trade] accept 
GET /trade

Get Trades.

Please note that indices (symbols starting with .) post trades at intervals to the trade feed. These have a size of 0 and are used only to indicate a changing price. See the FIX Spec for explanations of these fields.

data TradeGet Source #

Instances
Produces TradeGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces TradeGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces TradeGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces TradeGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces TradeGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes TradeGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes TradeGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

tradeGetBucketed

tradeGetBucketed Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest TradeGetBucketed MimeNoContent [TradeBin] accept 
GET /trade/bucketed

Get previous trades in time buckets.

data TradeGetBucketed Source #

Instances
Produces TradeGetBucketed MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces TradeGetBucketed MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces TradeGetBucketed MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces TradeGetBucketed MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces TradeGetBucketed MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes TradeGetBucketed MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes TradeGetBucketed MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

User

userCancelWithdrawal

userCancelWithdrawal Source #

Arguments

:: Consumes UserCancelWithdrawal contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Token

"token"

-> BitMEXRequest UserCancelWithdrawal contentType Transaction accept 
POST /user/cancelWithdrawal

Cancel a withdrawal.

data UserCancelWithdrawal Source #

Instances
Produces UserCancelWithdrawal MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserCancelWithdrawal MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserCancelWithdrawal MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserCancelWithdrawal MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserCancelWithdrawal MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserCancelWithdrawal MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserCancelWithdrawal MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

userCheckReferralCode

userCheckReferralCode Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest UserCheckReferralCode MimeNoContent Double accept 
GET /user/checkReferralCode

Check if a referral code is valid.

If the code is valid, responds with the referral code's discount (e.g. `0.1` for 10%). Otherwise, will return a 404.

data UserCheckReferralCode Source #

Instances
Produces UserCheckReferralCode MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserCheckReferralCode MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserCheckReferralCode MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserCheckReferralCode MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserCheckReferralCode MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserCheckReferralCode MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserCheckReferralCode MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

HasOptionalParam UserCheckReferralCode ReferralCode Source # 
Instance details

Defined in BitMEX.API

userConfirm

userConfirm Source #

Arguments

:: Consumes UserConfirm contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Token

"token"

-> BitMEXRequest UserConfirm contentType AccessToken accept 
POST /user/confirmEmail

Confirm your email address with a token.

data UserConfirm Source #

Instances
Produces UserConfirm MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserConfirm MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserConfirm MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserConfirm MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserConfirm MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserConfirm MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserConfirm MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

userConfirmEnableTFA

userConfirmEnableTFA Source #

Arguments

:: Consumes UserConfirmEnableTFA contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Token

"token" - Token from your selected TFA type.

-> BitMEXRequest UserConfirmEnableTFA contentType Bool accept 
POST /user/confirmEnableTFA

Confirm two-factor auth for this account. If using a Yubikey, simply send a token to this endpoint.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserConfirmEnableTFA Source #

Instances
Produces UserConfirmEnableTFA MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserConfirmEnableTFA MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserConfirmEnableTFA MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserConfirmEnableTFA MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserConfirmEnableTFA MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserConfirmEnableTFA MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserConfirmEnableTFA MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

userConfirmWithdrawal

userConfirmWithdrawal Source #

Arguments

:: Consumes UserConfirmWithdrawal contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Token

"token"

-> BitMEXRequest UserConfirmWithdrawal contentType Transaction accept 
POST /user/confirmWithdrawal

Confirm a withdrawal.

data UserConfirmWithdrawal Source #

Instances
Produces UserConfirmWithdrawal MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserConfirmWithdrawal MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserConfirmWithdrawal MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserConfirmWithdrawal MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserConfirmWithdrawal MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserConfirmWithdrawal MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserConfirmWithdrawal MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

userDisableTFA

userDisableTFA Source #

Arguments

:: Consumes UserDisableTFA contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Token

"token" - Token from your selected TFA type.

-> BitMEXRequest UserDisableTFA contentType Bool accept 
POST /user/disableTFA

Disable two-factor auth for this account.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserDisableTFA Source #

Instances
Produces UserDisableTFA MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserDisableTFA MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserDisableTFA MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserDisableTFA MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserDisableTFA MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserDisableTFA MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserDisableTFA MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

userGet

userGet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest UserGet MimeNoContent User accept 
GET /user

Get your user model.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserGet Source #

Instances
Produces UserGet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserGet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserGet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserGet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserGet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserGet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

userGetAffiliateStatus

userGetAffiliateStatus Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest UserGetAffiliateStatus MimeNoContent Affiliate accept 
GET /user/affiliateStatus

Get your current affiliate/referral status.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserGetAffiliateStatus Source #

Instances
Produces UserGetAffiliateStatus MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserGetAffiliateStatus MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserGetAffiliateStatus MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserGetAffiliateStatus MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserGetAffiliateStatus MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserGetAffiliateStatus MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserGetAffiliateStatus MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

userGetCommission

userGetCommission Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest UserGetCommission MimeNoContent [UserCommission] accept 
GET /user/commission

Get your account's commission status.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserGetCommission Source #

Instances
Produces UserGetCommission MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserGetCommission MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserGetCommission MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserGetCommission MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserGetCommission MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserGetCommission MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserGetCommission MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

userGetDepositAddress

userGetDepositAddress Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest UserGetDepositAddress MimeNoContent Text accept 
GET /user/depositAddress

Get a deposit address.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserGetDepositAddress Source #

Instances
Produces UserGetDepositAddress MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserGetDepositAddress MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserGetDepositAddress MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserGetDepositAddress MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserGetDepositAddress MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserGetDepositAddress MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserGetDepositAddress MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

userGetMargin

userGetMargin Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest UserGetMargin MimeNoContent Margin accept 
GET /user/margin

Get your account's margin status. Send a currency of "all" to receive an array of all supported currencies.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserGetMargin Source #

Instances
Produces UserGetMargin MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserGetMargin MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserGetMargin MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserGetMargin MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserGetMargin MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserGetMargin MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserGetMargin MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

userGetWallet

userGetWallet Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest UserGetWallet MimeNoContent Wallet accept 
GET /user/wallet

Get your current wallet information.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserGetWallet Source #

Instances
Produces UserGetWallet MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserGetWallet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserGetWallet MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserGetWallet MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserGetWallet MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserGetWallet MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserGetWallet MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

userGetWalletHistory

userGetWalletHistory Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest UserGetWalletHistory MimeNoContent [Transaction] accept 
GET /user/walletHistory

Get a history of all of your wallet transactions (deposits, withdrawals, PNL).

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserGetWalletHistory Source #

Instances
Produces UserGetWalletHistory MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserGetWalletHistory MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserGetWalletHistory MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserGetWalletHistory MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserGetWalletHistory MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserGetWalletHistory MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserGetWalletHistory MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

userGetWalletSummary

userGetWalletSummary Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest UserGetWalletSummary MimeNoContent [Transaction] accept 
GET /user/walletSummary

Get a summary of all of your wallet transactions (deposits, withdrawals, PNL).

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserGetWalletSummary Source #

Instances
Produces UserGetWalletSummary MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserGetWalletSummary MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserGetWalletSummary MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserGetWalletSummary MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserGetWalletSummary MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserGetWalletSummary MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserGetWalletSummary MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

userLogout

userLogout Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest UserLogout MimeNoContent res accept 
POST /user/logout

Log out of BitMEX.

Note: Has Produces instances, but no response schema

data UserLogout Source #

Instances
Produces UserLogout MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserLogout MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserLogout MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserLogout MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserLogout MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserLogout MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserLogout MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

userLogoutAll

userLogoutAll Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest UserLogoutAll MimeNoContent Double accept 
POST /user/logoutAll

Log all systems out of BitMEX. This will revoke all of your account's access tokens, logging you out on all devices.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserLogoutAll Source #

Instances
Produces UserLogoutAll MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserLogoutAll MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserLogoutAll MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserLogoutAll MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserLogoutAll MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserLogoutAll MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserLogoutAll MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

userMinWithdrawalFee

userMinWithdrawalFee Source #

Arguments

:: Accept accept

request accept (MimeType)

-> BitMEXRequest UserMinWithdrawalFee MimeNoContent Value accept 
GET /user/minWithdrawalFee

Get the minimum withdrawal fee for a currency.

This is changed based on network conditions to ensure timely withdrawals. During network congestion, this may be high. The fee is returned in the same currency.

data UserMinWithdrawalFee Source #

Instances
Produces UserMinWithdrawalFee MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserMinWithdrawalFee MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserMinWithdrawalFee MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserMinWithdrawalFee MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserMinWithdrawalFee MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserMinWithdrawalFee MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserMinWithdrawalFee MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

userRequestEnableTFA

userRequestEnableTFA Source #

Arguments

:: Consumes UserRequestEnableTFA contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> BitMEXRequest UserRequestEnableTFA contentType Bool accept 
POST /user/requestEnableTFA

Get secret key for setting up two-factor auth.

Use /confirmEnableTFA directly for Yubikeys. This fails if TFA is already enabled.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserRequestEnableTFA Source #

Instances
Produces UserRequestEnableTFA MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserRequestEnableTFA MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserRequestEnableTFA MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserRequestEnableTFA MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserRequestEnableTFA MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserRequestEnableTFA MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserRequestEnableTFA MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

userRequestWithdrawal

userRequestWithdrawal Source #

Arguments

:: Consumes UserRequestWithdrawal contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Currency

"currency" - Currency you're withdrawing. Options: XBt

-> Amount

"amount" - Amount of withdrawal currency.

-> Address

"address" - Destination Address.

-> BitMEXRequest UserRequestWithdrawal contentType Transaction accept 
POST /user/requestWithdrawal

Request a withdrawal to an external wallet.

This will send a confirmation email to the email address on record, unless requested via an API Key with the withdraw permission.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserRequestWithdrawal Source #

Instances
Produces UserRequestWithdrawal MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserRequestWithdrawal MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserRequestWithdrawal MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserRequestWithdrawal MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserRequestWithdrawal MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserRequestWithdrawal MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserRequestWithdrawal MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

userSavePreferences

userSavePreferences Source #

Arguments

:: Consumes UserSavePreferences contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> Prefs

"prefs"

-> BitMEXRequest UserSavePreferences contentType User accept 
POST /user/preferences

Save user preferences.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserSavePreferences Source #

Instances
Produces UserSavePreferences MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserSavePreferences MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserSavePreferences MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserSavePreferences MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserSavePreferences MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserSavePreferences MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserSavePreferences MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 #

userUpdate

userUpdate Source #

Arguments

:: Consumes UserUpdate contentType 
=> ContentType contentType

request content-type (MimeType)

-> Accept accept

request accept (MimeType)

-> BitMEXRequest UserUpdate contentType User accept 
PUT /user

Update your password, name, and other attributes.

AuthMethod: AuthApiKeyApiKey, AuthApiKeyApiNonce, AuthApiKeyApiSignature

data UserUpdate Source #

Instances
Produces UserUpdate MimeXML Source #
application/xml
Instance details

Defined in BitMEX.API

Produces UserUpdate MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

Produces UserUpdate MimeTextxml Source #
text/xml
Instance details

Defined in BitMEX.API

Produces UserUpdate MimeTextjavascript Source #
text/javascript
Instance details

Defined in BitMEX.API

Produces UserUpdate MimeJavascript Source #
application/javascript
Instance details

Defined in BitMEX.API

Consumes UserUpdate MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in BitMEX.API

Consumes UserUpdate MimeJSON Source #
application/json
Instance details

Defined in BitMEX.API

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 ->