Package {binxr}

binxr: Binance REST API Client for R

Description

Client helpers for the Binance Spot, Futures, and Options REST APIs. The package provides configuration constructors, signed and unsigned request helpers, market data retrieval, account access, and order management functions. Tabular endpoint responses are returned as data.table objects by default.

Details

Network examples and live trading calls are not run during package checks. Authenticated endpoints require user-supplied Binance API credentials.

Author(s)

Maintainer: Oliver Zhou oliver.yxzhou@gmail.com

Authors:

• Lily Li lilyli.qc.hk@gmail.com

See Also

Useful links:

• https://github.com/OliverLDS/binxr

• https://oliverlds.github.io/binxr/

• Report bugs at https://github.com/OliverLDS/binxr/issues

Backward-compatible futures config constructor

Description

Backward-compatible futures config constructor

Usage

binxr_config_futures(
  api_key = Sys.getenv("BINX_API_KEY", unset = ""),
  secret_key = Sys.getenv("BINX_SECRET_KEY", unset = ""),
  base = "https://fapi.binance.com",
  recvWindow = 10000L
)

Arguments

Value

A binxr_config list.

Backward-compatible options config constructor

Description

Backward-compatible options config constructor

Usage

binxr_config_options(
  api_key = Sys.getenv("BINX_API_KEY", unset = ""),
  secret_key = Sys.getenv("BINX_SECRET_KEY", unset = ""),
  base = "https://eapi.binance.com",
  recvWindow = 10000L
)

Arguments

Value

A binxr_config list.

Backward-compatible spot config constructor

Description

Backward-compatible spot config constructor

Usage

binxr_config_spot(
  api_key = Sys.getenv("BINX_API_KEY", unset = ""),
  secret_key = Sys.getenv("BINX_SECRET_KEY", unset = ""),
  base = "https://api.binance.com",
  recvWindow = 10000L
)

Arguments

Value

A binxr_config list.

(Optional) Coerce account to data.frames

Description

(Optional) Coerce account to data.frames

Usage

coerce_account_frames(account)

Arguments

Value

list(assets=..., positions=...)

Examples

account <- list(
  assets = list(list(asset = "USDT", walletBalance = "10")),
  positions = list(list(symbol = "ETHUSDT", positionAmt = "0"))
)
coerce_account_frames(account)

Create a Binance futures configuration

Description

Create a Binance futures configuration

Usage

config_futures(
  api_key = Sys.getenv("BINX_API_KEY", unset = ""),
  secret_key = Sys.getenv("BINX_SECRET_KEY", unset = ""),
  base_url = "https://fapi.binance.com",
  recv_window = 10000L,
  timeout = 30,
  verbose = FALSE
)

Arguments

Value

A binxr_config list.

Examples

cfg <- config_futures(api_key = NULL, secret_key = NULL)
cfg$product

Create a Binance options configuration

Description

Create a Binance options configuration

Usage

config_options(
  api_key = Sys.getenv("BINX_API_KEY", unset = ""),
  secret_key = Sys.getenv("BINX_SECRET_KEY", unset = ""),
  base_url = "https://eapi.binance.com",
  recv_window = 10000L,
  timeout = 30,
  verbose = FALSE
)

Arguments

Value

A binxr_config list.

Examples

cfg <- config_options(api_key = NULL, secret_key = NULL)
cfg$product

Create a Binance spot configuration

Description

Create a Binance spot configuration

Usage

config_spot(
  api_key = Sys.getenv("BINX_API_KEY", unset = ""),
  secret_key = Sys.getenv("BINX_SECRET_KEY", unset = ""),
  base_url = "https://api.binance.com",
  recv_window = 10000L,
  timeout = 30,
  verbose = FALSE
)

Arguments

Value

A binxr_config list.

Examples

cfg <- config_spot(api_key = NULL, secret_key = NULL)
cfg$product

Cancel all open Binance Futures orders for a symbol

Description

Cancel all open Binance Futures orders for a symbol

Usage

futures_cancel_all_orders(symbol, config = config_futures())

cancel_fapi_trade_orders_all(symbol, config = binxr_config_futures())

Arguments

Value

A parsed list.

Cancel a Binance Futures order

Description

Cancel a Binance Futures order

Usage

futures_cancel_order(
  symbol,
  order_id = NULL,
  orig_client_order_id = NULL,
  config = config_futures()
)

cancel_fapi_trade_order(
  symbol,
  orderId = NULL,
  origClientOrderId = NULL,
  config = binxr_config_futures()
)

Arguments

Value

A parsed list.

Set Binance Futures countdown cancel-all

Description

Set Binance Futures countdown cancel-all

Usage

futures_countdown_cancel_all(symbol, countdown_time, config = config_futures())

Arguments

Value

A parsed list.

Get Binance Futures 24hr ticker statistics

Description

Get Binance Futures 24hr ticker statistics

Usage

futures_get_24hr_ticker(symbol = NULL, config = config_futures())

Arguments

Value

A parsed list.

Get Binance Futures account info

Description

Get Binance Futures account info

Usage

futures_get_account(config = config_futures())

get_fapi_account(config = binxr_config_futures())

Arguments

Value

A parsed list.

Get Binance Futures account summary

Description

Get Binance Futures account summary

Usage

futures_get_account_summary(
  acc = NULL,
  json_list = FALSE,
  config = config_futures()
)

get_fapi_account_summary(acc = NULL, config = binxr_config_futures())

Arguments

Value

A one-row data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures account trades

Description

Get Binance Futures account trades

Usage

futures_get_account_trades(
  symbol,
  order_id = NULL,
  startTime = NULL,
  endTime = NULL,
  fromId = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_futures()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures aggregate trades

Description

Get Binance Futures aggregate trades

Usage

futures_get_aggregate_trades(
  symbol,
  fromId = NULL,
  startTime = NULL,
  endTime = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_futures()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures balances

Description

Get Binance Futures balances

Usage

futures_get_balance(json_list = FALSE, config = config_futures())

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures order book ticker

Description

Get Binance Futures order book ticker

Usage

futures_get_book_ticker(symbol = NULL, config = config_futures())

Arguments

Value

A parsed list.

Get Binance Futures commission rate

Description

Get Binance Futures commission rate

Usage

futures_get_commission_rate(symbol, config = config_futures())

Arguments

Value

A parsed list.

Get Binance Futures continuous contract klines

Description

Get Binance Futures continuous contract klines

Usage

futures_get_continuous_klines(
  pair,
  contract_type = c("PERPETUAL", "CURRENT_MONTH", "NEXT_MONTH", "CURRENT_QUARTER",
    "NEXT_QUARTER"),
  interval,
  startTime = NULL,
  endTime = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_futures()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures exchange info

Description

Get Binance Futures exchange info

Usage

futures_get_exchange_info(config = config_futures())

get_fapi_exchange_info(config = binxr_config_futures())

Arguments

Value

A parsed list. Symbol and asset lists are named when present.

Get Binance Futures force orders

Description

Get Binance Futures force orders

Usage

futures_get_force_orders(
  symbol = NULL,
  auto_close_type = NULL,
  startTime = NULL,
  endTime = NULL,
  limit = 50,
  json_list = FALSE,
  config = config_futures()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures funding info

Description

Get Binance Futures funding info

Usage

futures_get_funding_info(
  symbol = NULL,
  json_list = FALSE,
  config = config_futures()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures funding rate history

Description

Get Binance Futures funding rate history

Usage

futures_get_funding_rate_history(
  symbol = NULL,
  startTime = NULL,
  endTime = NULL,
  limit = 100,
  json_list = FALSE,
  config = config_futures()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures index price klines

Description

Get Binance Futures index price klines

Usage

futures_get_index_price_klines(
  symbol,
  interval,
  startTime = NULL,
  endTime = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_futures()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures klines

Description

Get Binance Futures klines

Usage

futures_get_klines(
  symbol,
  interval,
  startTime = NULL,
  endTime = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_futures()
)

get_fapi_klines(
  symbol,
  interval,
  startTime = NULL,
  endTime = NULL,
  limit = 500,
  config = binxr_config_futures()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures mark price

Description

Get Binance Futures mark price

Usage

futures_get_mark_price(symbol = NULL, config = config_futures())

get_fapi_mark_price(symbol = NULL, config = binxr_config_futures())

Arguments

Value

A parsed list.

Get Binance Futures mark price klines

Description

Get Binance Futures mark price klines

Usage

futures_get_mark_price_klines(
  symbol,
  interval,
  startTime = NULL,
  endTime = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_futures()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures multi-assets mode

Description

Get Binance Futures multi-assets mode

Usage

futures_get_multi_assets_mode(config = config_futures())

Arguments

Value

A parsed list.

Get Binance Futures open interest

Description

Get Binance Futures open interest

Usage

futures_get_open_interest(symbol, config = config_futures())

Arguments

Value

A parsed list.

Get Binance Futures open orders

Description

Get Binance Futures open orders

Usage

futures_get_open_orders(
  symbol = NULL,
  json_list = FALSE,
  config = config_futures()
)

get_fapi_trade_open_orders(symbol = NULL, config = binxr_config_futures())

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get a Binance Futures order

Description

Get a Binance Futures order

Usage

futures_get_order(
  symbol,
  order_id = NULL,
  orig_client_order_id = NULL,
  config = config_futures()
)

get_fapi_trade_order(
  symbol,
  orderId = NULL,
  origClientOrderId = NULL,
  config = binxr_config_futures()
)

Arguments

Value

A parsed list.

Get Binance Futures order book

Description

Get Binance Futures order book

Usage

futures_get_order_book(symbol, limit = NULL, config = config_futures())

Arguments

Value

A parsed list.

Get Binance Futures order rate limits

Description

Get Binance Futures order rate limits

Usage

futures_get_order_rate_limit(json_list = FALSE, config = config_futures())

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures order history

Description

Get Binance Futures order history

Usage

futures_get_orders(
  symbol,
  limit = 500,
  json_list = FALSE,
  config = config_futures()
)

get_fapi_trade_orders(symbol, limit = 500, config = binxr_config_futures())

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures position mode

Description

Get Binance Futures position mode

Usage

futures_get_position_mode(config = config_futures())

Arguments

Value

A parsed list.

Get Binance Futures position risk

Description

Get Binance Futures position risk

Usage

futures_get_position_risk(json_list = FALSE, config = config_futures())

get_fapi_account_position_risk(config = binxr_config_futures())

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get standardized Binance Futures positions

Description

Get standardized Binance Futures positions

Usage

futures_get_positions(acc = NULL, json_list = FALSE, config = config_futures())

get_fapi_account_positions(acc = NULL, config = binxr_config_futures())

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures premium index klines

Description

Get Binance Futures premium index klines

Usage

futures_get_premium_index_klines(
  symbol,
  interval,
  startTime = NULL,
  endTime = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_futures()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures recent trades

Description

Get Binance Futures recent trades

Usage

futures_get_recent_trades(
  symbol,
  limit = 500,
  json_list = FALSE,
  config = config_futures()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Futures server time

Description

Get Binance Futures server time

Usage

futures_get_server_time(config = config_futures())

get_fapi_system_time(config = binxr_config_futures())

Arguments

Value

A POSIXct timestamp.

Get Binance Futures ticker price

Description

Get Binance Futures ticker price

Usage

futures_get_ticker_price(
  symbol = NULL,
  version = c("v2", "deprecated"),
  config = config_futures()
)

Arguments

Value

A parsed list.

Test Binance Futures connectivity

Description

Test Binance Futures connectivity

Usage

futures_ping(config = config_futures())

Arguments

Value

A parsed list.

Place a Binance Futures order

Description

Place a Binance Futures order

Usage

futures_place_order(
  symbol,
  side = c("BUY", "SELL"),
  type = c("LIMIT", "MARKET", "STOP", "STOP_MARKET", "TAKE_PROFIT", "TAKE_PROFIT_MARKET",
    "TRAILING_STOP_MARKET"),
  quantity,
  price = NULL,
  time_in_force = NULL,
  position_side = c("BOTH", "LONG", "SHORT"),
  reduce_only = FALSE,
  stop_price = NULL,
  working_type = NULL,
  new_client_order_id = NULL,
  config = config_futures()
)

place_fapi_trade_order(
  symbol,
  side = c("BUY", "SELL"),
  type = c("LIMIT", "MARKET", "STOP", "STOP_MARKET", "TAKE_PROFIT", "TAKE_PROFIT_MARKET",
    "TRAILING_STOP_MARKET"),
  quantity,
  price = NULL,
  timeInForce = c("GTC", "IOC", "FOK", "GTX"),
  positionSide = c("BOTH", "LONG", "SHORT"),
  reduceOnly = FALSE,
  stopPrice = NULL,
  workingType = c("CONTRACT_PRICE", "MARK_PRICE"),
  newClientOrderId = NULL,
  config = binxr_config_futures()
)

Arguments

Value

A parsed list.

Set Binance Futures leverage

Description

Set Binance Futures leverage

Usage

futures_set_leverage(symbol, leverage, config = config_futures())

set_fapi_account_leverage(symbol, leverage, config = binxr_config_futures())

Arguments

Value

A parsed list.

Set Binance Futures margin type

Description

Set Binance Futures margin type

Usage

futures_set_margin_type(
  symbol,
  margin_type = c("CROSSED", "ISOLATED"),
  config = config_futures()
)

set_fapi_account_margin_type(
  symbol,
  marginType = c("CROSSED", "ISOLATED"),
  config = binxr_config_futures()
)

Arguments

Value

A parsed list.

Set Binance Futures multi-assets mode

Description

Set Binance Futures multi-assets mode

Usage

futures_set_multi_assets_mode(
  multi_assets_margin = TRUE,
  config = config_futures()
)

Arguments

Value

A parsed list.

Set Binance Futures position mode

Description

Set Binance Futures position mode

Usage

futures_set_position_mode(dual_side_position = TRUE, config = config_futures())

set_fapi_account_position_side(
  dualSidePosition = TRUE,
  config = binxr_config_futures()
)

Arguments

Value

A parsed list.

Test a Binance Futures order

Description

Test a Binance Futures order

Usage

futures_test_order(
  symbol,
  side = c("BUY", "SELL"),
  type = c("LIMIT", "MARKET", "STOP", "STOP_MARKET", "TAKE_PROFIT", "TAKE_PROFIT_MARKET",
    "TRAILING_STOP_MARKET"),
  quantity,
  price = NULL,
  time_in_force = NULL,
  position_side = c("BOTH", "LONG", "SHORT"),
  reduce_only = FALSE,
  stop_price = NULL,
  working_type = NULL,
  new_client_order_id = NULL,
  config = config_futures()
)

Arguments

Value

A parsed list.

Cancel all Binance Options orders for a symbol

Description

Cancel all Binance Options orders for a symbol

Usage

options_cancel_all_orders(symbol, config = config_options())

Arguments

Value

A parsed list.

Cancel all Binance Options orders by underlying

Description

Cancel all Binance Options orders by underlying

Usage

options_cancel_all_orders_by_underlying(underlying, config = config_options())

Arguments

Value

A parsed list.

Cancel a Binance Options order

Description

Cancel a Binance Options order

Usage

options_cancel_order(
  symbol,
  order_id = NULL,
  client_order_id = NULL,
  config = config_options()
)

Arguments

Value

A parsed list.

Get Binance Options 24hr ticker statistics

Description

Get Binance Options 24hr ticker statistics

Usage

options_get_24hr_ticker(
  symbol = NULL,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Options account trades

Description

Get Binance Options account trades

Usage

options_get_account_trades(
  symbol = NULL,
  fromId = NULL,
  startTime = NULL,
  endTime = NULL,
  limit = 100,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Options user commission

Description

Get Binance Options user commission

Usage

options_get_commission(config = config_options())

Arguments

Value

A parsed list.

Get Binance Options exchange info

Description

Get Binance Options exchange info

Usage

options_get_exchange_info(config = config_options())

Arguments

Value

A parsed list. Option symbol and asset lists are named when present.

Get Binance Options historical exercise records

Description

Get Binance Options historical exercise records

Usage

options_get_exercise_history(
  underlying = NULL,
  startTime = NULL,
  endTime = NULL,
  limit = 100,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Options exercise records

Description

Get Binance Options exercise records

Usage

options_get_exercise_records(
  symbol = NULL,
  startTime = NULL,
  endTime = NULL,
  limit = 1000,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Options funding flow

Description

Get Binance Options funding flow

Usage

options_get_funding_flow(
  currency = "USDT",
  recordId = NULL,
  startTime = NULL,
  endTime = NULL,
  limit = 100,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Options underlying index price

Description

Get Binance Options underlying index price

Usage

options_get_index_price(underlying, config = config_options())

Arguments

Value

A parsed list.

Get Binance Options klines

Description

Get Binance Options klines

Usage

options_get_klines(
  symbol,
  interval,
  startTime = NULL,
  endTime = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Options margin account information

Description

Get Binance Options margin account information

Usage

options_get_margin_account(config = config_options())

Arguments

Value

A parsed list.

Get Binance Options mark prices

Description

Get Binance Options mark prices

Usage

options_get_mark_price(
  symbol = NULL,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Options open interest

Description

Get Binance Options open interest

Usage

options_get_open_interest(
  underlying_asset,
  expiration,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Options open orders

Description

Get Binance Options open orders

Usage

options_get_open_orders(
  symbol = NULL,
  order_id = NULL,
  startTime = NULL,
  endTime = NULL,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get a Binance Options order

Description

Get a Binance Options order

Usage

options_get_order(
  symbol,
  order_id = NULL,
  client_order_id = NULL,
  config = config_options()
)

Arguments

Value

A parsed list.

Get Binance Options order book

Description

Get Binance Options order book

Usage

options_get_order_book(symbol, limit = NULL, config = config_options())

Arguments

Value

A parsed list.

Get Binance Options order history

Description

Get Binance Options order history

Usage

options_get_order_history(
  symbol,
  order_id = NULL,
  startTime = NULL,
  endTime = NULL,
  limit = 100,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Options positions

Description

Get Binance Options positions

Usage

options_get_positions(
  symbol = NULL,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Options recent block trades

Description

Get Binance Options recent block trades

Usage

options_get_recent_block_trades(
  symbol = NULL,
  limit = 100,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Options recent trades

Description

Get Binance Options recent trades

Usage

options_get_recent_trades(
  symbol,
  limit = 100,
  json_list = FALSE,
  config = config_options()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Options server time

Description

Get Binance Options server time

Usage

options_get_server_time(config = config_options())

Arguments

Value

A POSIXct timestamp.

Test Binance Options connectivity

Description

Test Binance Options connectivity

Usage

options_ping(config = config_options())

Arguments

Value

A parsed list.

Place a Binance Options order

Description

Place a Binance Options order

Usage

options_place_order(
  symbol,
  side = c("BUY", "SELL"),
  type = c("LIMIT"),
  quantity,
  price,
  time_in_force = c("GTC", "IOC", "FOK"),
  reduce_only = FALSE,
  post_only = FALSE,
  new_order_resp_type = c("ACK", "RESULT"),
  client_order_id = NULL,
  is_mmp = FALSE,
  self_trade_prevention_mode = NULL,
  config = config_options()
)

Arguments

Value

A parsed list.

Round price and quantity to exchange increments

Description

Round price and quantity to exchange increments

Usage

round_price_qty(
  exchangeInfo,
  symbol,
  price = NULL,
  quantity = NULL,
  round_dir = c("down", "up")
)

util_round_price_qty(
  exchangeInfo,
  symbol,
  price = NULL,
  quantity = NULL,
  round_dir = c("down", "up")
)

Arguments

Value

A list with elements price and quantity.

Examples

exchange_info <- list(
  symbols = list(
    ETHUSDT = list(
      filters = list(
        list(filterType = "PRICE_FILTER", tickSize = "0.01"),
        list(filterType = "LOT_SIZE", stepSize = "0.001")
      )
    )
  )
)
round_price_qty(exchange_info, "ETHUSDT", price = 1800.123, quantity = 0.12345)

Amend a Binance Spot order while keeping priority

Description

Amend a Binance Spot order while keeping priority

Usage

spot_amend_order_keep_priority(
  symbol,
  order_id = NULL,
  orig_client_order_id = NULL,
  new_client_order_id = NULL,
  new_qty,
  config = config_spot()
)

Arguments

Value

A parsed list.

Cancel all open Binance Spot orders for a symbol

Description

Cancel all open Binance Spot orders for a symbol

Usage

spot_cancel_all_orders(symbol, config = config_spot())

Arguments

Value

A parsed list by default.

Cancel a Binance Spot order

Description

Cancel a Binance Spot order

Usage

spot_cancel_order(
  symbol,
  order_id = NULL,
  orig_client_order_id = NULL,
  new_client_order_id = NULL,
  cancel_restrictions = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Cancel a Binance Spot order list

Description

Cancel a Binance Spot order list

Usage

spot_cancel_order_list(
  symbol,
  order_list_id = NULL,
  list_client_order_id = NULL,
  new_client_order_id = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Cancel and replace a Binance Spot order

Description

Cancel and replace a Binance Spot order

Usage

spot_cancel_replace_order(
  symbol,
  side = c("BUY", "SELL"),
  type = c("LIMIT", "MARKET", "STOP_LOSS", "STOP_LOSS_LIMIT", "TAKE_PROFIT",
    "TAKE_PROFIT_LIMIT", "LIMIT_MAKER"),
  cancel_replace_mode = c("STOP_ON_FAILURE", "ALLOW_FAILURE"),
  time_in_force = NULL,
  quantity = NULL,
  quote_order_qty = NULL,
  price = NULL,
  cancel_new_client_order_id = NULL,
  cancel_orig_client_order_id = NULL,
  cancel_order_id = NULL,
  new_client_order_id = NULL,
  strategy_id = NULL,
  strategy_type = NULL,
  stop_price = NULL,
  trailing_delta = NULL,
  iceberg_qty = NULL,
  new_order_resp_type = NULL,
  self_trade_prevention_mode = NULL,
  cancel_restrictions = NULL,
  order_rate_limit_exceeded_mode = NULL,
  peg_price_type = NULL,
  peg_offset_value = NULL,
  peg_offset_type = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Get Binance Spot 24-hour ticker statistics

Description

Get Binance Spot 24-hour ticker statistics

Usage

spot_get_24hr_ticker(
  symbol = NULL,
  symbols = NULL,
  type = c("FULL", "MINI"),
  symbol_status = NULL,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A parsed list for single-symbol requests, or a data.table for multi-symbol/all-symbol requests unless json_list = TRUE.

Get Binance Spot account information

Description

Get Binance Spot account information

Usage

spot_get_account(omit_zero_balances = FALSE, config = config_spot())

Arguments

Value

A parsed list.

Get Binance Spot account trades

Description

Get Binance Spot account trades

Usage

spot_get_account_trades(
  symbol,
  order_id = NULL,
  start_time = NULL,
  end_time = NULL,
  from_id = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Spot aggregate trades

Description

Get Binance Spot aggregate trades

Usage

spot_get_aggregate_trades(
  symbol,
  fromId = NULL,
  startTime = NULL,
  endTime = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get all Binance Spot order lists

Description

Get all Binance Spot order lists

Usage

spot_get_all_order_lists(
  from_id = NULL,
  start_time = NULL,
  end_time = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Spot allocations

Description

Get Binance Spot allocations

Usage

spot_get_allocations(
  symbol,
  start_time = NULL,
  end_time = NULL,
  from_allocation_id = NULL,
  limit = 500,
  order_id = NULL,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Spot average price

Description

Get Binance Spot average price

Usage

spot_get_average_price(symbol, config = config_spot())

Arguments

Value

A parsed list.

Get Binance Spot book ticker

Description

Get Binance Spot book ticker

Usage

spot_get_book_ticker(
  symbol = NULL,
  symbols = NULL,
  symbol_status = NULL,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A parsed list for single-symbol requests, or a data.table for multi-symbol/all-symbol requests unless json_list = TRUE.

Get Binance Spot commission rates

Description

Get Binance Spot commission rates

Usage

spot_get_commission_rates(symbol, config = config_spot())

Arguments

Value

A parsed list.

Get Binance Spot exchange information

Description

Get Binance Spot exchange information

Usage

spot_get_exchange_info(
  symbol = NULL,
  symbols = NULL,
  permissions = NULL,
  show_permission_sets = TRUE,
  symbol_status = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Get Binance Spot execution rules

Description

Get Binance Spot execution rules

Usage

spot_get_execution_rules(
  symbol = NULL,
  symbols = NULL,
  symbol_status = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Get Binance Spot historical trades

Description

Get Binance Spot historical trades

Usage

spot_get_historical_trades(
  symbol,
  limit = 500,
  fromId = NULL,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Spot klines

Description

Get Binance Spot klines

Usage

spot_get_klines(
  symbol,
  interval,
  startTime = NULL,
  endTime = NULL,
  timeZone = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Spot open order lists

Description

Get Binance Spot open order lists

Usage

spot_get_open_order_lists(json_list = FALSE, config = config_spot())

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Spot open orders

Description

Get Binance Spot open orders

Usage

spot_get_open_orders(symbol = NULL, json_list = FALSE, config = config_spot())

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get a Binance Spot order

Description

Get a Binance Spot order

Usage

spot_get_order(
  symbol,
  order_id = NULL,
  orig_client_order_id = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Get Binance Spot order amendments

Description

Get Binance Spot order amendments

Usage

spot_get_order_amendments(
  symbol,
  order_id,
  from_execution_id = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Spot order book

Description

Get Binance Spot order book

Usage

spot_get_order_book(
  symbol,
  limit = NULL,
  symbol_status = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Get a Binance Spot order list

Description

Get a Binance Spot order list

Usage

spot_get_order_list(
  order_list_id = NULL,
  orig_client_order_id = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Get Binance Spot order history

Description

Get Binance Spot order history

Usage

spot_get_orders(
  symbol,
  order_id = NULL,
  start_time = NULL,
  end_time = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Spot prevented matches

Description

Get Binance Spot prevented matches

Usage

spot_get_prevented_matches(
  symbol,
  prevented_match_id = NULL,
  order_id = NULL,
  from_prevented_match_id = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Spot recent trades

Description

Get Binance Spot recent trades

Usage

spot_get_recent_trades(
  symbol,
  limit = 500,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Spot reference price

Description

Get Binance Spot reference price

Usage

spot_get_reference_price(symbol, config = config_spot())

Arguments

Value

A parsed list.

Get Binance Spot reference price calculation metadata

Description

Get Binance Spot reference price calculation metadata

Usage

spot_get_reference_price_calculation(
  symbol,
  symbol_status = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Get Binance Spot relevant account filters

Description

Get Binance Spot relevant account filters

Usage

spot_get_relevant_filters(symbol, config = config_spot())

Arguments

Value

A parsed list.

Get Binance Spot rolling window ticker statistics

Description

Get Binance Spot rolling window ticker statistics

Usage

spot_get_rolling_window_ticker(
  symbol = NULL,
  symbols = NULL,
  windowSize = NULL,
  type = c("FULL", "MINI"),
  symbol_status = NULL,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A parsed list for single-symbol requests, or a data.table for multi-symbol requests unless json_list = TRUE.

Get Binance Spot server time

Description

Get Binance Spot server time

Usage

spot_get_server_time(config = config_spot())

Arguments

Value

A POSIXct timestamp.

Get Binance Spot ticker price

Description

Get Binance Spot ticker price

Usage

spot_get_ticker_price(
  symbol = NULL,
  symbols = NULL,
  symbol_status = NULL,
  json_list = FALSE,
  config = config_spot()
)

get_spot_mark_price(symbol = NULL, config = binxr_config_spot())

Arguments

Value

A parsed list for single-symbol requests, or a data.table for multi-symbol/all-symbol requests unless json_list = TRUE.

Get Binance Spot trading day ticker statistics

Description

Get Binance Spot trading day ticker statistics

Usage

spot_get_trading_day_ticker(
  symbol = NULL,
  symbols = NULL,
  timeZone = NULL,
  type = c("FULL", "MINI"),
  symbol_status = NULL,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A parsed list for single-symbol requests, or a data.table for multi-symbol requests unless json_list = TRUE.

Get Binance Spot UI klines

Description

Get Binance Spot UI klines

Usage

spot_get_ui_klines(
  symbol,
  interval,
  startTime = NULL,
  endTime = NULL,
  timeZone = NULL,
  limit = 500,
  json_list = FALSE,
  config = config_spot()
)

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Get Binance Spot unfilled order counts

Description

Get Binance Spot unfilled order counts

Usage

spot_get_unfilled_order_count(json_list = FALSE, config = config_spot())

Arguments

Value

A data.table by default, or a parsed list when json_list = TRUE.

Test Binance Spot API connectivity

Description

Test Binance Spot API connectivity

Usage

spot_ping(config = config_spot())

Arguments

Value

An empty parsed list on success.

Place a deprecated Binance Spot OCO order

Description

Place a deprecated Binance Spot OCO order

Usage

spot_place_oco_order(
  symbol,
  side = c("BUY", "SELL"),
  quantity,
  price,
  stop_price,
  list_client_order_id = NULL,
  limit_client_order_id = NULL,
  limit_strategy_id = NULL,
  limit_strategy_type = NULL,
  limit_iceberg_qty = NULL,
  trailing_delta = NULL,
  stop_client_order_id = NULL,
  stop_strategy_id = NULL,
  stop_strategy_type = NULL,
  stop_limit_price = NULL,
  stop_iceberg_qty = NULL,
  stop_limit_time_in_force = NULL,
  new_order_resp_type = NULL,
  self_trade_prevention_mode = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Place a Binance Spot order

Description

Place a Binance Spot order

Usage

spot_place_order(
  symbol,
  side = c("BUY", "SELL"),
  type = c("LIMIT", "MARKET", "STOP_LOSS", "STOP_LOSS_LIMIT", "TAKE_PROFIT",
    "TAKE_PROFIT_LIMIT", "LIMIT_MAKER"),
  time_in_force = NULL,
  quantity = NULL,
  quote_order_qty = NULL,
  price = NULL,
  new_client_order_id = NULL,
  strategy_id = NULL,
  strategy_type = NULL,
  stop_price = NULL,
  trailing_delta = NULL,
  iceberg_qty = NULL,
  new_order_resp_type = NULL,
  self_trade_prevention_mode = NULL,
  peg_price_type = NULL,
  peg_offset_value = NULL,
  peg_offset_type = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Place a Binance Spot OCO order list

Description

Place a Binance Spot OCO order list

Usage

spot_place_order_list_oco(
  symbol,
  side = c("BUY", "SELL"),
  quantity,
  above_type = c("STOP_LOSS_LIMIT", "STOP_LOSS", "LIMIT_MAKER", "TAKE_PROFIT",
    "TAKE_PROFIT_LIMIT"),
  above_client_order_id = NULL,
  above_iceberg_qty = NULL,
  above_price = NULL,
  above_stop_price = NULL,
  above_trailing_delta = NULL,
  above_time_in_force = NULL,
  above_strategy_id = NULL,
  above_strategy_type = NULL,
  above_peg_price_type = NULL,
  above_peg_offset_type = NULL,
  above_peg_offset_value = NULL,
  below_type = c("STOP_LOSS", "STOP_LOSS_LIMIT", "TAKE_PROFIT", "TAKE_PROFIT_LIMIT"),
  below_client_order_id = NULL,
  below_iceberg_qty = NULL,
  below_price = NULL,
  below_stop_price = NULL,
  below_trailing_delta = NULL,
  below_time_in_force = NULL,
  below_strategy_id = NULL,
  below_strategy_type = NULL,
  below_peg_price_type = NULL,
  below_peg_offset_type = NULL,
  below_peg_offset_value = NULL,
  list_client_order_id = NULL,
  new_order_resp_type = NULL,
  self_trade_prevention_mode = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Place a Binance Spot OPO order list

Description

Place a Binance Spot OPO order list

Usage

spot_place_order_list_opo(
  symbol,
  list_client_order_id = NULL,
  new_order_resp_type = NULL,
  self_trade_prevention_mode = NULL,
  working_type = c("LIMIT", "LIMIT_MAKER"),
  working_side = c("BUY", "SELL"),
  working_client_order_id = NULL,
  working_price,
  working_quantity,
  working_iceberg_qty = NULL,
  working_time_in_force = NULL,
  working_strategy_id = NULL,
  working_strategy_type = NULL,
  working_peg_price_type = NULL,
  working_peg_offset_type = NULL,
  working_peg_offset_value = NULL,
  pending_type = c("LIMIT", "MARKET", "STOP_LOSS", "STOP_LOSS_LIMIT", "TAKE_PROFIT",
    "TAKE_PROFIT_LIMIT", "LIMIT_MAKER"),
  pending_side = c("BUY", "SELL"),
  pending_client_order_id = NULL,
  pending_price = NULL,
  pending_stop_price = NULL,
  pending_trailing_delta = NULL,
  pending_iceberg_qty = NULL,
  pending_time_in_force = NULL,
  pending_strategy_id = NULL,
  pending_strategy_type = NULL,
  pending_peg_price_type = NULL,
  pending_peg_offset_type = NULL,
  pending_peg_offset_value = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Place a Binance Spot OPOCO order list

Description

Place a Binance Spot OPOCO order list

Usage

spot_place_order_list_opoco(
  symbol,
  list_client_order_id = NULL,
  new_order_resp_type = NULL,
  self_trade_prevention_mode = NULL,
  working_type = c("LIMIT", "LIMIT_MAKER"),
  working_side = c("BUY", "SELL"),
  working_client_order_id = NULL,
  working_price,
  working_quantity,
  working_iceberg_qty = NULL,
  working_time_in_force = NULL,
  working_strategy_id = NULL,
  working_strategy_type = NULL,
  working_peg_price_type = NULL,
  working_peg_offset_type = NULL,
  working_peg_offset_value = NULL,
  pending_side = c("BUY", "SELL"),
  pending_above_type = c("STOP_LOSS_LIMIT", "STOP_LOSS", "LIMIT_MAKER", "TAKE_PROFIT",
    "TAKE_PROFIT_LIMIT"),
  pending_above_client_order_id = NULL,
  pending_above_price = NULL,
  pending_above_stop_price = NULL,
  pending_above_trailing_delta = NULL,
  pending_above_iceberg_qty = NULL,
  pending_above_time_in_force = NULL,
  pending_above_strategy_id = NULL,
  pending_above_strategy_type = NULL,
  pending_above_peg_price_type = NULL,
  pending_above_peg_offset_type = NULL,
  pending_above_peg_offset_value = NULL,
  pending_below_type = c("STOP_LOSS", "STOP_LOSS_LIMIT", "TAKE_PROFIT",
    "TAKE_PROFIT_LIMIT"),
  pending_below_client_order_id = NULL,
  pending_below_price = NULL,
  pending_below_stop_price = NULL,
  pending_below_trailing_delta = NULL,
  pending_below_iceberg_qty = NULL,
  pending_below_time_in_force = NULL,
  pending_below_strategy_id = NULL,
  pending_below_strategy_type = NULL,
  pending_below_peg_price_type = NULL,
  pending_below_peg_offset_type = NULL,
  pending_below_peg_offset_value = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Place a Binance Spot OTO order list

Description

Place a Binance Spot OTO order list

Usage

spot_place_order_list_oto(
  symbol,
  list_client_order_id = NULL,
  new_order_resp_type = NULL,
  self_trade_prevention_mode = NULL,
  working_type = c("LIMIT", "LIMIT_MAKER"),
  working_side = c("BUY", "SELL"),
  working_client_order_id = NULL,
  working_price,
  working_quantity,
  working_iceberg_qty = NULL,
  working_time_in_force = NULL,
  working_strategy_id = NULL,
  working_strategy_type = NULL,
  working_peg_price_type = NULL,
  working_peg_offset_type = NULL,
  working_peg_offset_value = NULL,
  pending_type = c("LIMIT", "MARKET", "STOP_LOSS", "STOP_LOSS_LIMIT", "TAKE_PROFIT",
    "TAKE_PROFIT_LIMIT", "LIMIT_MAKER"),
  pending_side = c("BUY", "SELL"),
  pending_client_order_id = NULL,
  pending_price = NULL,
  pending_stop_price = NULL,
  pending_trailing_delta = NULL,
  pending_quantity,
  pending_iceberg_qty = NULL,
  pending_time_in_force = NULL,
  pending_strategy_id = NULL,
  pending_strategy_type = NULL,
  pending_peg_price_type = NULL,
  pending_peg_offset_type = NULL,
  pending_peg_offset_value = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Place a Binance Spot OTOCO order list

Description

Place a Binance Spot OTOCO order list

Usage

spot_place_order_list_otoco(
  symbol,
  list_client_order_id = NULL,
  new_order_resp_type = NULL,
  self_trade_prevention_mode = NULL,
  working_type = c("LIMIT", "LIMIT_MAKER"),
  working_side = c("BUY", "SELL"),
  working_client_order_id = NULL,
  working_price,
  working_quantity,
  working_iceberg_qty = NULL,
  working_time_in_force = NULL,
  working_strategy_id = NULL,
  working_strategy_type = NULL,
  working_peg_price_type = NULL,
  working_peg_offset_type = NULL,
  working_peg_offset_value = NULL,
  pending_side = c("BUY", "SELL"),
  pending_quantity,
  pending_above_type = c("STOP_LOSS_LIMIT", "STOP_LOSS", "LIMIT_MAKER", "TAKE_PROFIT",
    "TAKE_PROFIT_LIMIT"),
  pending_above_client_order_id = NULL,
  pending_above_price = NULL,
  pending_above_stop_price = NULL,
  pending_above_trailing_delta = NULL,
  pending_above_iceberg_qty = NULL,
  pending_above_time_in_force = NULL,
  pending_above_strategy_id = NULL,
  pending_above_strategy_type = NULL,
  pending_above_peg_price_type = NULL,
  pending_above_peg_offset_type = NULL,
  pending_above_peg_offset_value = NULL,
  pending_below_type = c("STOP_LOSS", "STOP_LOSS_LIMIT", "TAKE_PROFIT",
    "TAKE_PROFIT_LIMIT"),
  pending_below_client_order_id = NULL,
  pending_below_price = NULL,
  pending_below_stop_price = NULL,
  pending_below_trailing_delta = NULL,
  pending_below_iceberg_qty = NULL,
  pending_below_time_in_force = NULL,
  pending_below_strategy_id = NULL,
  pending_below_strategy_type = NULL,
  pending_below_peg_price_type = NULL,
  pending_below_peg_offset_type = NULL,
  pending_below_peg_offset_value = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Place a Binance Spot SOR order

Description

Place a Binance Spot SOR order

Usage

spot_place_sor_order(
  symbol,
  side = c("BUY", "SELL"),
  type = c("LIMIT", "MARKET"),
  quantity,
  time_in_force = NULL,
  price = NULL,
  new_client_order_id = NULL,
  strategy_id = NULL,
  strategy_type = NULL,
  iceberg_qty = NULL,
  new_order_resp_type = NULL,
  self_trade_prevention_mode = NULL,
  config = config_spot()
)

Arguments

Value

A parsed list.

Test a Binance Spot order

Description

Test a Binance Spot order

Usage

spot_test_order(
  symbol,
  side = c("BUY", "SELL"),
  type = c("LIMIT", "MARKET", "STOP_LOSS", "STOP_LOSS_LIMIT", "TAKE_PROFIT",
    "TAKE_PROFIT_LIMIT", "LIMIT_MAKER"),
  time_in_force = NULL,
  quantity = NULL,
  quote_order_qty = NULL,
  price = NULL,
  new_client_order_id = NULL,
  strategy_id = NULL,
  strategy_type = NULL,
  stop_price = NULL,
  trailing_delta = NULL,
  iceberg_qty = NULL,
  new_order_resp_type = NULL,
  self_trade_prevention_mode = NULL,
  peg_price_type = NULL,
  peg_offset_value = NULL,
  peg_offset_type = NULL,
  compute_commission_rates = FALSE,
  config = config_spot()
)

Arguments

Value

A parsed list.

Test a Binance Spot SOR order

Description

Test a Binance Spot SOR order

Usage

spot_test_sor_order(
  symbol,
  side = c("BUY", "SELL"),
  type = c("LIMIT", "MARKET"),
  quantity,
  time_in_force = NULL,
  price = NULL,
  new_client_order_id = NULL,
  strategy_id = NULL,
  strategy_type = NULL,
  iceberg_qty = NULL,
  new_order_resp_type = NULL,
  self_trade_prevention_mode = NULL,
  compute_commission_rates = FALSE,
  config = config_spot()
)

Arguments

Value

A parsed list.