README.md

bitmexr: R Client for the BitMEX Exchange

Travis build
status Codecov test
coverage R build
status CRAN
status

Overview

The goal of bitmexr is to provide an API wrapper for cryptocurrency derivatives exchange, BitMEX. bitmexr now provides support for all API endpoints for both the Testnet (www.testnet.bitmex.com) and the live exchange (www.bitmex.com). For more information about the API, check https://www.bitmex.com/app/apiOverview.

Installation

The development version of bitmexr can be installed from github:

# install.packages("devtools")
devtools::install_github("hfshr/bitmexr")

Or the released version from CRAN:

install.packages("bitmexr")

Package contents

The package contains dedicated wrappers for the majority of API endpoints.

Additional API endpoints that do not have a dedicated wrapper can be accessed using get_bitmex() for GET requests and post_bitmex() for POST requests. For example use:

get_bitmex(path = "/chat", args = list(reverse = "false"))

to get the latest trollbox messages.

Testnet API

All functions in the package also work with BitMEX’s Testnet API. Simply use the “tn_” prefix to access the Testnet version of the function. For example tn_place_order() will place an order on the Testnet exchange.

Authentication

Accessing private API endpoints, such as those to manage trades, requires an API key and secret. bitmexr reads these from your \~/.Renviron file - see vignette Authentication for more information.

Disclaimer

This software is in no way affiliated, endorsed, or approved by the BitMEX cryptocurrency exchange or any of its affiliates.

Contribution

If you spot any issues, or would like additional features added, please feel free to raise an issue, or submit a pull request.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.



Try the bitmexr package in your browser

Any scripts or data that you put into this service are public.

bitmexr documentation built on July 1, 2020, 5:20 p.m.