post_bitmex {bitmexr}R Documentation

POST requests

Description

Use post_bitmex() to send POST requests. All POST requests require authentication.

Usage

post_bitmex(path, args = NULL)

Arguments

path

string. End point for the api.

args

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

Value

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

References

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

Examples

## Not run: 
# edit leverage on a position

post_bitmex(
  path = "/position/leverage",
  args = list("symbol" = "XBTUSD", "leverage" = 10)
)

## End(Not run)


[Package bitmexr version 0.3.1 Index]