post_bitmex: POST requests

In hfshr/bitmexr: R Client for BitMEX

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)

hfshr/bitmexr documentation built on Aug. 4, 2023, 2:01 p.m.