tn_get_bitmex {bitmexr}R Documentation

GET requests (testnet)

Description

Use tn_get_bitmex() to send GET requests to the testnet API. For private endpoints, authentication is required.

Usage

tn_get_bitmex(path, args = NULL, use_auth = FALSE)

Arguments

path

string. End point for the api.

args

A named list containing valid parameters for the given API endpoint.

use_auth

logical. Use TRUE to access private endpoints if authentication has been set up.

Value

Returns a data.frame containing the response from the request.

References

https://www.bitmex.com/api/explorer/

Examples

## Not run: 
# Access a public endpoint
chat <- tn_get_bitmex(path = "/chat", args = list(channelID = 1, reverse = "true"))

# Access private endpoint using `use_auth` = `TRUE`.

user <- tn_get_bitmex(path = "/execution", args = list(symbol = "XBTUSD"), use_auth = TRUE)

## End(Not run)


[Package bitmexr version 0.3.1 Index]