ExBitmex

Bitmex API Client for Elixir

Installation

If available in Hex, the package can be installed by adding bitmex to your list of dependencies in mix.exs:

def deps do
  [
    {:ex_bitmex, "~> 1.0.0"}
  ]
end

Setup Bitmex, set test_mode to true in test environment. In production set to false

config :ex_bitmex, test_mode: false

Rest API Usage

credentials = %ExBitmex.Credentials{
  api_key: System.get_env("BITMEX_API_KEY"),
  api_secret: System.get_env("BITMEX_SECRET")
}

# Single API

# Create a new order
ExBitmex.Rest.Orders.create(credentials, %{
  symbol: "XBTUSD",
  side: "Buy",
  orderQty: 1,
  price: 1
})

# Update an order
ExBitmex.Rest.Orders.amend(credentials, %{
  orderID: "8d6f2649-7477-4db5-e32a-d8d5bf99dd9b",
  leavesQty: 3
})

# Cancel an order
ExBitmex.Rest.Orders.cancel(credentials, %{
  orderID: "8d6f2649-7477-4db5-e32a-d8d5bf99dd9b"
})

# Bulk API

# Create multiple orders
ExBitmex.Rest.Orders.create_bulk(credentials, %{orders: [%{
  symbol: "XBTUSD",
  side: "Buy",
  orderQty: 1,
  price: 1
}]})

# Update multiple orders
ExBitmex.Rest.Orders.amend_bulk(credentials, %{orders: [
  %{
    orderID: "8d6f2649-7477-4db5-e32a-d8d5bf99dd9b",
    leavesQty: 3
  }
]})

# Cancel multiple orders
ExBitmex.Rest.Orders.amend_bulk(credentials, %{orders: [
  %{
    orderID: "8d6f2649-7477-4db5-e32a-d8d5bf99dd9b"
  }
]})

Static API Key

By default, this library will fetch the API key from the environment.

api_key: System.get_env("BITMEX_API_KEY"),
api_secret: System.get_env("BITMEX_SECRET")

Dynamic API Key

There will be cases when we want to switch to different API keys based on different info or need. That's why we're supporting this.

One of the use case when you want to have the dynamic API key feature is: when you want to using multiple API keys in the same app. In that case you simply need to spawn a process which encapsulate the config info. And each process with have it's own credentials to interact with Bitmex.

So we can tell either API or Websocket module to use certain access keys to retrieve the API keys that we want.

NOTE: The access key must be in string.

SECURITY: Access key is passed around instead of actual value of the key is to reduce the security risk. People can not inspect the key when the program up and running. This follow Tell, don't ask principle.

ExBitmex.Credentials.config(%{access_keys: ["BITMEX1_API_KEY", "BITMEX1_API_SECRET"]})

# or

ExBitmex.Credentials.config(%{access_keys: ["BITMEX2_API_KEY", "BITMEX2_API_SECRET"]})

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/bitmex.