get_positions_history {okxAPI}R Documentation

Retrieve the position data

Description

Wrapper for API Get positions history.

Usage

get_positions_history(
  api_key,
  secret_key,
  passphrase,
  count = 90,
  period = 10,
  ...
)

Arguments

api_key

Okx API key.

secret_key

Okx API secret key.

passphrase

Okx API passphrase.

count

Retrieve position data for a specified number of past days, with a maximum of 90(days)

period

Due to the 'Number of results per request' limitation of the API, the period parameter must be specified to ensure that the number of position data entries within each period does not exceed 100.

...

Other request parameters to be passed, See Get positions history for more information.

Value

Position data

Examples

## Not run: 
positions <- get_positions_history(
  api_key, secret_key, passphrase, count = 90, period = 10,
  instType = "SWAP", mgnMode = "isolated"
)

## End(Not run)


[Package okxAPI version 0.1.1 Index]