Package: okxr 0.4.5
okxr: R Interface to the 'OKX' REST API
Provides lightweight R wrappers for the 'OKX' REST API, covering endpoints for market data, trading, account management, asset balances, and copy trading. The upstream API reference is available at <https://www.okx.com/docs-v5/en/>.
Authors:
okxr_0.4.5.tar.gz
okxr_0.4.5.zip(r-4.7)okxr_0.4.5.zip(r-4.6)okxr_0.4.5.zip(r-4.5)
okxr_0.4.5.tgz(r-4.6-any)okxr_0.4.5.tgz(r-4.5-any)
okxr_0.4.5.tar.gz(r-4.7-any)okxr_0.4.5.tar.gz(r-4.6-any)
okxr_0.4.5.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
okxr/json (API)
NEWS
| # Install 'okxr' in R: |
| install.packages('okxr', repos = c('https://oliverlds.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/oliverlds/okxr/issues
Last updated from:cdf6c85798. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | OK | 116 | ||
| source / vignettes | OK | 191 | ||
| linux-release-x86_64 | OK | 129 | ||
| macos-release-arm64 | OK | 165 | ||
| macos-oldrel-arm64 | OK | 199 | ||
| windows-devel | OK | 92 | ||
| windows-release | OK | 73 | ||
| windows-oldrel | OK | 70 | ||
| wasm-release | OK | 106 |
Exports:get_account_adjust_leverage_infoget_account_balanceget_account_billsget_account_bills_archiveget_account_bills_history_archiveget_account_collateral_assetsget_account_configget_account_greeksget_account_instrumentsget_account_interest_accruedget_account_interest_limitsget_account_interest_rateget_account_leverage_infoget_account_max_avail_sizeget_account_max_loanget_account_max_sizeget_account_max_withdrawalget_account_mmp_configget_account_move_positions_historyget_account_position_riskget_account_position_tiersget_account_positionsget_account_positions_historyget_account_precheck_set_delta_neutralget_account_risk_stateget_account_set_account_switch_precheckget_account_spot_borrow_repay_historyget_account_subaccount_balancesget_account_subaccount_max_withdrawalget_account_subtypesget_account_trade_feeget_asset_asset_valuationget_asset_balancesget_asset_billsget_asset_bills_historyget_asset_convert_currenciesget_asset_convert_currency_pairget_asset_convert_historyget_asset_currenciesget_asset_deposit_addressget_asset_deposit_historyget_asset_deposit_withdraw_statusget_asset_exchange_listget_asset_non_tradable_assetsget_asset_transfer_stateget_asset_withdrawal_historyget_copy_trade_configget_copy_trade_current_subposget_copy_trade_historical_subposget_copy_trade_instrumentsget_copy_trade_my_leadersget_copy_trade_profit_sharing_detailsget_copy_trade_public_configget_copy_trade_public_copy_tradersget_copy_trade_public_current_subpositionsget_copy_trade_public_lead_tradersget_copy_trade_public_pnlget_copy_trade_public_preference_currencyget_copy_trade_public_statsget_copy_trade_public_subpositions_historyget_copy_trade_public_weekly_pnlget_copy_trade_settingsget_copy_trade_total_profit_sharingget_copy_trade_total_unrealized_profit_sharingget_copy_trade_unrealized_profit_sharing_detailsget_market_block_tickerget_market_block_tickersget_market_booksget_market_candlesget_market_exchange_rateget_market_history_candlesget_market_history_index_candlesget_market_history_mark_price_candlesget_market_history_tradesget_market_index_candlesget_market_index_componentsget_market_index_tickersget_market_mark_price_candlesget_market_option_instrument_family_tradesget_market_platform_24_volumeget_market_tickerget_market_tickersget_market_tradesget_public_block_tradesget_public_convert_contract_coinget_public_delivery_exercise_historyget_public_discount_rate_interest_free_quotaget_public_economic_calendarget_public_estimated_priceget_public_estimated_settlement_infoget_public_funding_rateget_public_funding_rate_historyget_public_instrument_tick_bandsget_public_instrumentsget_public_insurance_fundget_public_interest_rate_loan_quotaget_public_mark_priceget_public_open_interestget_public_opt_summaryget_public_option_tradesget_public_position_tiersget_public_premium_historyget_public_price_limitget_public_settlement_historyget_public_timeget_public_underlyingget_trade_account_rate_limitget_trade_easy_convert_currency_listget_trade_easy_convert_historyget_trade_fillsget_trade_fills_historyget_trade_one_click_repay_currency_listget_trade_one_click_repay_currency_list_v2get_trade_one_click_repay_historyget_trade_one_click_repay_history_v2get_trade_orderget_trade_order_algoget_trade_orders_algo_historyget_trade_orders_algo_pendingget_trade_orders_historyget_trade_orders_history_7dget_trade_orders_history_archiveget_trade_orders_pendingget_var_labelpost_account_account_level_switch_presetpost_account_mmp_configpost_account_mmp_resetpost_account_move_positionspost_account_position_margin_balancepost_account_set_account_levelpost_account_set_auto_loanpost_account_set_auto_repaypost_account_set_collateral_assetspost_account_set_fee_typepost_account_set_greekspost_account_set_leveragepost_account_set_position_modepost_account_spot_manual_borrow_repaypost_asset_cancel_withdrawalpost_asset_convert_estimate_quotepost_asset_convert_tradepost_asset_transferpost_asset_withdrawalpost_trade_amend_algospost_trade_amend_batch_orderspost_trade_amend_orderpost_trade_batch_orderspost_trade_cancel_algospost_trade_cancel_all_afterpost_trade_cancel_batch_orderspost_trade_cancel_orderpost_trade_close_positionpost_trade_mass_cancelpost_trade_orderpost_trade_order_precheckset_okxr_options
Dependencies:askpassbase64enccurldata.tabledigesthttrjsonlitemimeopensslR6rlangsys
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| okxr: R Interface to the OKX REST API | okxr-package okxr |
| Build a full OKX request object | .build_request |
| Execute a GET request to OKX | .execute_get_action |
| Execute a POST request to OKX | .execute_post_action |
| Create OKX API request headers | .get_headers |
| Get account leverage adjustment estimate | get_account_adjust_leverage_info |
| Get account balance | get_account_balance |
| Get account bills | get_account_bills |
| Get archived account bills | get_account_bills_archive |
| Get archived account bill export links | get_account_bills_history_archive |
| Get account collateral assets | get_account_collateral_assets |
| Get account configuration | get_account_config |
| Get account Greeks | get_account_greeks |
| Get account-available instruments | get_account_instruments |
| Get account interest accrued history | get_account_interest_accrued |
| Get account borrow interest and limits | get_account_interest_limits |
| Get account borrowing interest rates | get_account_interest_rate |
| Get account leverage settings | get_account_leverage_info |
| Get maximum available tradable amount | get_account_max_avail_size |
| Get account maximum loan | get_account_max_loan |
| Get maximum order size | get_account_max_size |
| Get account maximum withdrawals | get_account_max_withdrawal |
| Get account MMP configuration | get_account_mmp_config |
| Get account move positions history | get_account_move_positions_history |
| Get account and position risk snapshot | get_account_position_risk |
| Get account position tiers | get_account_position_tiers |
| Get account open positions | get_account_positions |
| Get account position history | get_account_positions_history |
| Precheck delta-neutral strategy switch | get_account_precheck_set_delta_neutral |
| Get account risk state | get_account_risk_state |
| Precheck account mode switch | get_account_set_account_switch_precheck |
| Get spot borrow and repay history | get_account_spot_borrow_repay_history |
| Get sub-account trading balances | get_account_subaccount_balances |
| Get sub-account maximum withdrawals | get_account_subaccount_max_withdrawal |
| Get account bill subtypes | get_account_subtypes |
| Get account trade fee rates | get_account_trade_fee |
| Get asset valuation | get_asset_asset_valuation |
| Get asset balances | get_asset_balances |
| Get asset bills | get_asset_bills |
| Get asset bills history | get_asset_bills_history |
| Get convert currencies | get_asset_convert_currencies |
| Get convert currency pair | get_asset_convert_currency_pair |
| Get convert history | get_asset_convert_history |
| Get funding currencies | get_asset_currencies |
| Get deposit address | get_asset_deposit_address |
| Get asset deposit history | get_asset_deposit_history |
| Get deposit or withdrawal status | get_asset_deposit_withdraw_status |
| Get exchange list | get_asset_exchange_list |
| Get non-tradable assets | get_asset_non_tradable_assets |
| Get asset transfer state | get_asset_transfer_state |
| Get asset withdrawal history | get_asset_withdrawal_history |
| Get copy trading config | get_copy_trade_config |
| Get current copy trading subpositions | get_copy_trade_current_subpos |
| Get historical copy trading subpositions | get_copy_trade_historical_subpos |
| Get copy trading instruments | get_copy_trade_instruments |
| Get my lead traders | get_copy_trade_my_leaders |
| Get profit sharing details | get_copy_trade_profit_sharing_details |
| Get public copy trading config | get_copy_trade_public_config |
| Get public copy trader summary | get_copy_trade_public_copy_traders |
| Get public current copy trading subpositions | get_copy_trade_public_current_subpositions |
| Get public lead trader ranks | get_copy_trade_public_lead_traders |
| Get public copy trading pnl | get_copy_trade_public_pnl |
| Get public preference currencies | get_copy_trade_public_preference_currency |
| Get public copy trading stats | get_copy_trade_public_stats |
| Get public historical copy trading subpositions | get_copy_trade_public_subpositions_history |
| Get public copy trading weekly pnl | get_copy_trade_public_weekly_pnl |
| Get copy trading settings | get_copy_trade_settings |
| Get total profit sharing | get_copy_trade_total_profit_sharing |
| Get total unrealized profit sharing | get_copy_trade_total_unrealized_profit_sharing |
| Get unrealized profit sharing details | get_copy_trade_unrealized_profit_sharing_details |
| Get block ticker | get_market_block_ticker |
| Get block tickers | get_market_block_tickers |
| Get order book | get_market_books |
| Get recent market candles | get_market_candles |
| Get exchange rate | get_market_exchange_rate |
| Get historical market candles | get_market_history_candles |
| Get historical index candles | get_market_history_index_candles |
| Get historical mark price candles | get_market_history_mark_price_candles |
| Get historical public trades | get_market_history_trades |
| Get recent index candles | get_market_index_candles |
| Get index components | get_market_index_components |
| Get index tickers | get_market_index_tickers |
| Get mark price candles | get_market_mark_price_candles |
| Get option trades by instrument family | get_market_option_instrument_family_trades |
| Get platform 24-hour volume | get_market_platform_24_volume |
| Get market ticker | get_market_ticker |
| Get market tickers | get_market_tickers |
| Get recent public trades | get_market_trades |
| Get public block trades | get_public_block_trades |
| Convert between contract size and currency amount | get_public_convert_contract_coin |
| Get delivery or exercise history | get_public_delivery_exercise_history |
| Get collateral discount rate and interest-free quota | get_public_discount_rate_interest_free_quota |
| Get economic calendar | get_public_economic_calendar |
| Get estimated delivery or exercise price | get_public_estimated_price |
| Get estimated settlement info | get_public_estimated_settlement_info |
| Get current funding rate | get_public_funding_rate |
| Get funding rate history | get_public_funding_rate_history |
| Get option instrument tick bands | get_public_instrument_tick_bands |
| Get instrument metadata | get_public_instruments |
| Get security fund balance information | get_public_insurance_fund |
| Get interest rate and loan quota | get_public_interest_rate_loan_quota |
| Get current mark price | get_public_mark_price |
| Get open interest | get_public_open_interest |
| Get option summary | get_public_opt_summary |
| Get public option trades | get_public_option_trades |
| Get public position tiers | get_public_position_tiers |
| Get premium history | get_public_premium_history |
| Get price limit | get_public_price_limit |
| Get settlement history | get_public_settlement_history |
| Get OKX system time | get_public_time |
| Get underlying list | get_public_underlying |
| Get trade account rate limit | get_trade_account_rate_limit |
| Get easy convert currency list | get_trade_easy_convert_currency_list |
| Get easy convert history | get_trade_easy_convert_history |
| Get trade fills | get_trade_fills |
| Get trade fills history | get_trade_fills_history |
| Get one-click repay currency list | get_trade_one_click_repay_currency_list |
| Get one-click repay currency list v2 | get_trade_one_click_repay_currency_list_v2 |
| Get one-click repay history | get_trade_one_click_repay_history |
| Get one-click repay history v2 | get_trade_one_click_repay_history_v2 |
| Get trade order details | get_trade_order |
| Get a single algo order | get_trade_order_algo |
| Get algo order history | get_trade_orders_algo_history |
| Get pending algo orders | get_trade_orders_algo_pending |
| Get trade orders history | get_trade_orders_history |
| Get trade orders history (last 7 days) | get_trade_orders_history_7d |
| Get archived trade orders history | get_trade_orders_history_archive |
| Get all pending trade orders | get_trade_orders_pending |
| Retrieve variable labels from OKX data frames | get_var_label |
| Preset Account Level Switch | post_account_account_level_switch_preset |
| Configure MMP | post_account_mmp_config |
| Reset MMP Status | post_account_mmp_reset |
| Move Positions Between Accounts | post_account_move_positions |
| Adjust Position Margin Balance | post_account_position_margin_balance |
| Set Account Level | post_account_set_account_level |
| Set Account Auto Loan | post_account_set_auto_loan |
| Set Account Auto Repay | post_account_set_auto_repay |
| Set Account Collateral Assets | post_account_set_collateral_assets |
| Set Account Fee Type | post_account_set_fee_type |
| Set Account Greeks Display Type | post_account_set_greeks |
| Set Account Leverage | post_account_set_leverage |
| Set Account Position Mode | post_account_set_position_mode |
| Submit Spot Manual Borrow or Repay | post_account_spot_manual_borrow_repay |
| Cancel an Asset Withdrawal | post_asset_cancel_withdrawal |
| Estimate an Asset Convert Quote | post_asset_convert_estimate_quote |
| Execute an Asset Convert Trade | post_asset_convert_trade |
| Transfer Assets | post_asset_transfer |
| Submit an Asset Withdrawal | post_asset_withdrawal |
| Amend an Algo Order | post_trade_amend_algos |
| Amend Multiple Trade Orders | post_trade_amend_batch_orders |
| Amend a Trade Order | post_trade_amend_order |
| Place Multiple Trade Orders | post_trade_batch_orders |
| Cancel Multiple Algo Orders | post_trade_cancel_algos |
| Set Cancel-All-After | post_trade_cancel_all_after |
| Cancel Multiple Trade Orders | post_trade_cancel_batch_orders |
| Cancel a Trade Order | post_trade_cancel_order |
| Close a Position | post_trade_close_position |
| Mass Cancel MMP Orders | post_trade_mass_cancel |
| Place a Trade Order | post_trade_order |
| Precheck a Trade Order | post_trade_order_precheck |
| Set or get okxr options | set_okxr_options |
