R Interface to the 'OKX' REST API

[Up] [Top]

Documentation for package ‘okxr’ version 0.4.5

Help Pages

G O P S misc

okxr-package okxr: R Interface to the OKX REST API

-- G --

get_account_adjust_leverage_info Get account leverage adjustment estimate
get_account_balance Get account balance
get_account_bills Get account bills
get_account_bills_archive Get archived account bills
get_account_bills_history_archive Get archived account bill export links
get_account_collateral_assets Get account collateral assets
get_account_config Get account configuration
get_account_greeks Get account Greeks
get_account_instruments Get account-available instruments
get_account_interest_accrued Get account interest accrued history
get_account_interest_limits Get account borrow interest and limits
get_account_interest_rate Get account borrowing interest rates
get_account_leverage_info Get account leverage settings
get_account_max_avail_size Get maximum available tradable amount
get_account_max_loan Get account maximum loan
get_account_max_size Get maximum order size
get_account_max_withdrawal Get account maximum withdrawals
get_account_mmp_config Get account MMP configuration
get_account_move_positions_history Get account move positions history
get_account_positions Get account open positions
get_account_positions_history Get account position history
get_account_position_risk Get account and position risk snapshot
get_account_position_tiers Get account position tiers
get_account_precheck_set_delta_neutral Precheck delta-neutral strategy switch
get_account_risk_state Get account risk state
get_account_set_account_switch_precheck Precheck account mode switch
get_account_spot_borrow_repay_history Get spot borrow and repay history
get_account_subaccount_balances Get sub-account trading balances
get_account_subaccount_max_withdrawal Get sub-account maximum withdrawals
get_account_subtypes Get account bill subtypes
get_account_trade_fee Get account trade fee rates
get_asset_asset_valuation Get asset valuation
get_asset_balances Get asset balances
get_asset_bills Get asset bills
get_asset_bills_history Get asset bills history
get_asset_convert_currencies Get convert currencies
get_asset_convert_currency_pair Get convert currency pair
get_asset_convert_history Get convert history
get_asset_currencies Get funding currencies
get_asset_deposit_address Get deposit address
get_asset_deposit_history Get asset deposit history
get_asset_deposit_withdraw_status Get deposit or withdrawal status
get_asset_exchange_list Get exchange list
get_asset_non_tradable_assets Get non-tradable assets
get_asset_transfer_state Get asset transfer state
get_asset_withdrawal_history Get asset withdrawal history
get_copy_trade_config Get copy trading config
get_copy_trade_current_subpos Get current copy trading subpositions
get_copy_trade_historical_subpos Get historical copy trading subpositions
get_copy_trade_instruments Get copy trading instruments
get_copy_trade_my_leaders Get my lead traders
get_copy_trade_profit_sharing_details Get profit sharing details
get_copy_trade_public_config Get public copy trading config
get_copy_trade_public_copy_traders Get public copy trader summary
get_copy_trade_public_current_subpositions Get public current copy trading subpositions
get_copy_trade_public_lead_traders Get public lead trader ranks
get_copy_trade_public_pnl Get public copy trading pnl
get_copy_trade_public_preference_currency Get public preference currencies
get_copy_trade_public_stats Get public copy trading stats
get_copy_trade_public_subpositions_history Get public historical copy trading subpositions
get_copy_trade_public_weekly_pnl Get public copy trading weekly pnl
get_copy_trade_settings Get copy trading settings
get_copy_trade_total_profit_sharing Get total profit sharing
get_copy_trade_total_unrealized_profit_sharing Get total unrealized profit sharing
get_copy_trade_unrealized_profit_sharing_details Get unrealized profit sharing details
get_market_block_ticker Get block ticker
get_market_block_tickers Get block tickers
get_market_books Get order book
get_market_candles Get recent market candles
get_market_exchange_rate Get exchange rate
get_market_history_candles Get historical market candles
get_market_history_index_candles Get historical index candles
get_market_history_mark_price_candles Get historical mark price candles
get_market_history_trades Get historical public trades
get_market_index_candles Get recent index candles
get_market_index_components Get index components
get_market_index_tickers Get index tickers
get_market_mark_price_candles Get mark price candles
get_market_option_instrument_family_trades Get option trades by instrument family
get_market_platform_24_volume Get platform 24-hour volume
get_market_ticker Get market ticker
get_market_tickers Get market tickers
get_market_trades Get recent public trades
get_public_block_trades Get public block trades
get_public_convert_contract_coin Convert between contract size and currency amount
get_public_delivery_exercise_history Get delivery or exercise history
get_public_discount_rate_interest_free_quota Get collateral discount rate and interest-free quota
get_public_economic_calendar Get economic calendar
get_public_estimated_price Get estimated delivery or exercise price
get_public_estimated_settlement_info Get estimated settlement info
get_public_funding_rate Get current funding rate
get_public_funding_rate_history Get funding rate history
get_public_instruments Get instrument metadata
get_public_instrument_tick_bands Get option instrument tick bands
get_public_insurance_fund Get security fund balance information
get_public_interest_rate_loan_quota Get interest rate and loan quota
get_public_mark_price Get current mark price
get_public_open_interest Get open interest
get_public_option_trades Get public option trades
get_public_opt_summary Get option summary
get_public_position_tiers Get public position tiers
get_public_premium_history Get premium history
get_public_price_limit Get price limit
get_public_settlement_history Get settlement history
get_public_time Get OKX system time
get_public_underlying Get underlying list
get_trade_account_rate_limit Get trade account rate limit
get_trade_easy_convert_currency_list Get easy convert currency list
get_trade_easy_convert_history Get easy convert history
get_trade_fills Get trade fills
get_trade_fills_history Get trade fills history
get_trade_one_click_repay_currency_list Get one-click repay currency list
get_trade_one_click_repay_currency_list_v2 Get one-click repay currency list v2
get_trade_one_click_repay_history Get one-click repay history
get_trade_one_click_repay_history_v2 Get one-click repay history v2
get_trade_order Get trade order details
get_trade_orders_algo_history Get algo order history
get_trade_orders_algo_pending Get pending algo orders
get_trade_orders_history Get trade orders history
get_trade_orders_history_7d Get trade orders history (last 7 days)
get_trade_orders_history_archive Get archived trade orders history
get_trade_orders_pending Get all pending trade orders
get_trade_order_algo Get a single algo order
get_var_label Retrieve variable labels from OKX data frames

-- O --

okxr okxr: R Interface to the OKX REST API

-- P --

post_account_account_level_switch_preset Preset Account Level Switch
post_account_mmp_config Configure MMP
post_account_mmp_reset Reset MMP Status
post_account_move_positions Move Positions Between Accounts
post_account_position_margin_balance Adjust Position Margin Balance
post_account_set_account_level Set Account Level
post_account_set_auto_loan Set Account Auto Loan
post_account_set_auto_repay Set Account Auto Repay
post_account_set_collateral_assets Set Account Collateral Assets
post_account_set_fee_type Set Account Fee Type
post_account_set_greeks Set Account Greeks Display Type
post_account_set_leverage Set Account Leverage
post_account_set_position_mode Set Account Position Mode
post_account_spot_manual_borrow_repay Submit Spot Manual Borrow or Repay
post_asset_cancel_withdrawal Cancel an Asset Withdrawal
post_asset_convert_estimate_quote Estimate an Asset Convert Quote
post_asset_convert_trade Execute an Asset Convert Trade
post_asset_transfer Transfer Assets
post_asset_withdrawal Submit an Asset Withdrawal
post_trade_amend_algos Amend an Algo Order
post_trade_amend_batch_orders Amend Multiple Trade Orders
post_trade_amend_order Amend a Trade Order
post_trade_batch_orders Place Multiple Trade Orders
post_trade_cancel_algos Cancel Multiple Algo Orders
post_trade_cancel_all_after Set Cancel-All-After
post_trade_cancel_batch_orders Cancel Multiple Trade Orders
post_trade_cancel_order Cancel a Trade Order
post_trade_close_position Close a Position
post_trade_mass_cancel Mass Cancel MMP Orders
post_trade_order Place a Trade Order
post_trade_order_precheck Precheck a Trade Order

-- S --

set_okxr_options Set or get okxr options

-- misc --

.build_request Build a full OKX request object
.execute_get_action Execute a GET request to OKX
.execute_post_action Execute a POST request to OKX
.get_headers Create OKX API request headers