# Roxom API

- [Welcome to the Roxom Help Center!](https://docs.roxom.com/help-center/index.md): Find answers to your questions about Roxom, trading, account management, and more.
- [What is Roxom?](https://docs.roxom.com/help-center/about-roxom/what-is-roxom.md): Roxom is a Bitcoin-denominated trading platform, meaning trades are priced, margined, and settled in BTC, not in USD or other fiat currencies.
- [Institutional OTC desk](https://docs.roxom.com/help-center/about-roxom/institutional-otc-desk.md): Roxom's institutional OTC desk provides personalized trading solutions for crypto and equities with dedicated support.
- [What is Roxom.TV?](https://docs.roxom.com/help-center/about-roxom/what-is-roxom-tv.md): Learn what Roxom.TV is and where to watch its live financial news and Bitcoin-focused market analysis.
- [What is Roxom Insights?](https://docs.roxom.com/help-center/about-roxom/what-is-roxom-insights.md): Learn what Roxom Insights is, where to find it, and what kind of content it publishes.
- [Roxom platform updates](https://docs.roxom.com/help-center/about-roxom/platform-updates.md): Track the latest Roxom feature launches and product updates, including futures, One-Click Trade, and Auto-Earn.
- [How to contact Roxom and join our community](https://docs.roxom.com/help-center/about-roxom/how-to-contact-roxom.md): Learn where to contact Roxom for support, business inquiries, partnerships, and how to join our official community channels.
- [Join our team](https://docs.roxom.com/help-center/about-roxom/join-our-team.md): Explore career opportunities at Roxom and become part of the team building the future of Bitcoin-native capital markets.
- [Understanding your Roxom accounts](https://docs.roxom.com/help-center/account-basics/understanding-your-roxom-accounts.md): Learn how the Funding Account and Unified Trading Account (UTA) work together on Roxom.
- [How to transfer funds between accounts](https://docs.roxom.com/help-center/account-basics/how-to-transfer-funds-between-accounts.md): Step-by-step guide to moving BTC, USDC, and USDT between your Funding Account and Unified Trading Account (UTA).
- [Supported currencies and what they're used for](https://docs.roxom.com/help-center/account-basics/supported-currencies.md): Learn which currencies Roxom supports, what networks are available, and how each currency is used across the platform.
- [Display preferences: language, currency unit, hidden balances, and USD estimates](https://docs.roxom.com/help-center/account-basics/display-preferences.md): Customize how Roxom is displayed: switch language, switch between BTC, sats, and USD, hide balances, and show USD estimates.
- [How to complete your account verification (KYC)](https://docs.roxom.com/help-center/kyc/how-to-complete-your-account-verification-kyc.md): Follow step-by-step instructions to complete your Roxom KYC verification using a government-issued ID and liveness check.
- [Accepted documents for identity verification](https://docs.roxom.com/help-center/kyc/accepted-documents-for-identity-verification.md): Find out which ID documents are accepted for Roxom KYC verification and get tips for submitting clear, valid photos.
- [Proof of address: what is accepted and how to submit it](https://docs.roxom.com/help-center/kyc/proof-of-address-what-is-accepted-and-how-to-submit-it.md): Learn which documents are accepted as proof of address for Roxom KYC and how to submit them correctly.
- [Why was my KYC verification rejected?](https://docs.roxom.com/help-center/kyc/why-was-my-kyc-verification-rejected.md): Find out common reasons your Roxom KYC verification was rejected and what steps you can take to fix it.
- [Restricted countries and nationalities](https://docs.roxom.com/help-center/kyc/restricted-countries-and-nationalities.md): Find out whether you can use Roxom based on your nationality or country of residence.
- [Need help verifying your number](https://docs.roxom.com/help-center/kyc/need-help-verifying-your-number.md): Troubleshoot SMS verification issues and get your code delivered.
- [Business verification (KYB)](https://docs.roxom.com/help-center/kyc/business-verification.md): Step-by-step guide to verify a business account on Roxom through the Know Your Business (KYB) process.
- [How to deposit crypto into your Roxom account](https://docs.roxom.com/help-center/crypto-deposits-withdrawals/how-to-deposit-crypto-into-my-roxom-account.md): Step-by-step guide to deposit BTC, USDC, or USDT into your Roxom Funding Account.
- [How to withdraw crypto from your Roxom account](https://docs.roxom.com/help-center/crypto-deposits-withdrawals/how-to-withdraw-crypto-from-your-roxom-account.md): Step-by-step guide to withdraw BTC, USDC, or USDT from Roxom to an external wallet.
- [What is the withdrawal limit in Roxom?](https://docs.roxom.com/help-center/crypto-deposits-withdrawals/what-is-the-withdrawal-limit-in-roxom.md): Learn about Roxom's daily withdrawal limits (5 BTC for personal accounts, 20 BTC for business accounts), how USDC and USDT withdrawals are converted to BTC to count against your limit, and how to request an increase.
- [How do I check the status of my withdrawal?](https://docs.roxom.com/help-center/crypto-deposits-withdrawals/how-do-i-check-the-status-of-my-withdrawal.md): Learn how to check your crypto withdrawal status on Roxom, understand each status meaning, and track blockchain transactions.
- [What security settings are required to withdraw crypto from Roxom?](https://docs.roxom.com/help-center/crypto-deposits-withdrawals/what-security-settings-are-required-to-withdraw-crypto-from-roxom.md): Security methods required to enable crypto withdrawals from your Roxom account.
- [Why are my withdrawals temporarily restricted?](https://docs.roxom.com/help-center/crypto-deposits-withdrawals/why-are-my-withdrawals-temporarily-restricted.md): Understand why crypto withdrawals may be restricted due to compliance review.
- [Why can't I withdraw crypto right now?](https://docs.roxom.com/help-center/crypto-deposits-withdrawals/why-can-t-i-withdraw-crypto-right-now.md): Common reasons why crypto withdrawals may be blocked and how to fix them.
- [What is Auto-Earn?](https://docs.roxom.com/help-center/btc-earn/what-is-btc-earn.md): Learn what Auto-Earn is and how you can earn BTC on your Funding Account balance without locking your funds.
- [How Auto-Earn works](https://docs.roxom.com/help-center/btc-earn/how-auto-earn-works.md): Understand how Auto-Earn works on Roxom, including how to enable it, daily accrual windows, and balance evaluation rules.
- [Minimum balance requirements and daily accrual](https://docs.roxom.com/help-center/btc-earn/eligibility-balances-and-daily-accrual.md): Learn which BTC balances qualify for Auto-Earn, minimum balance requirements, and how daily accrual works.
- [Rates, earnings calculation, and credits](https://docs.roxom.com/help-center/btc-earn/rates-earnings-calculation-and-credits.md): Learn how Auto-Earn rates are set, how your BTC earnings are calculated daily, and how credits appear in your account.
- [What is Roxom Loans?](https://docs.roxom.com/help-center/loans/what-is-roxom-loans.md): Roxom Loans is the collateralized lending engine within Roxom. The first instrument is the BLOC (Bitcoin Line of Credit).
- [How to open a credit line](https://docs.roxom.com/help-center/loans/how-to-open-a-credit-line.md): Step-by-step operational guide to open, monitor, adjust, borrow more, and repay a BLOC (Bitcoin Line of Credit) on Roxom.
- [How to refinance your loan](https://docs.roxom.com/help-center/loans/how-to-refinance-your-loan.md): Move a bitcoin-backed loan from another lender to a Roxom BLOC. Same BTC, lower rate, we rebate your first month's interest.
- [BLOC (Bitcoin Line of Credit)](https://docs.roxom.com/help-center/loans/bitcoin-backed-credit-line.md): The first instrument within Roxom Loans. Deposit BTC as collateral, receive USDT or USDC, keep your long position.
- [Rates and terms](https://docs.roxom.com/help-center/loans/rates-and-terms.md): Interest rate, term, borrowing limits, currencies, and fees for the BLOC (Bitcoin Line of Credit).
- [Repayment and interest](https://docs.roxom.com/help-center/loans/repayment-and-interest.md): How interest accrues, how to repay (early or partial), how to manage collateral, and what fees apply.
- [LTV, margin calls, and liquidation](https://docs.roxom.com/help-center/loans/ltv-margin-calls-and-liquidation.md): How loan-to-value is monitored, when margin calls and liquidations are triggered, how the 2% fee is calculated, and what happens afterward.
- [Custody and security](https://docs.roxom.com/help-center/loans/custody-and-security.md): How your BTC collateral is held, segregated, and protected while a Roxom loan is open.
- [Risk and regulation](https://docs.roxom.com/help-center/loans/risk-and-regulation.md): Hard questions answered: insolvency, automatic liquidation, institutional custody, and regulatory backing.
- [What is One-Click Trade and what assets are available?](https://docs.roxom.com/help-center/one-click-trade/what-is-one-click-trade-what-assets-are-available.md): Learn what One-Click Trade is, which crypto assets, U.S. stocks, ETFs, bond ETFs, and other assets are available, plus trading hours and trade size limits.
- [How to buy or sell tokenized assets](https://docs.roxom.com/help-center/one-click-trade/how-to-buy-or-sell-tokenized-assets.md): Step-by-step guide to buying and selling tokenized stocks with BTC using Roxom's One-Click Trade swap interface.
- [Understanding tokenized assets](https://docs.roxom.com/help-center/one-click-trade/understanding-tokenized-assets.md): Understand what tokenized assets are on Roxom, how they provide price exposure to U.S. stocks, and their limitations.
- [Where can I see my tokenized assets and activity?](https://docs.roxom.com/help-center/one-click-trade/where-can-i-see-my-tokenized-assets-and-activity.md): Find out where to view your tokenized assets in your portfolio and how to review your One-Click Trade swap activity.
- [How corporate actions are handled](https://docs.roxom.com/help-center/one-click-trade/how-corporate-actions-are-handled.md): Learn how dividends, stock splits, and other corporate actions are handled for your tokenized assets on Roxom.
- [How to secure your Roxom account](https://docs.roxom.com/help-center/security-access/how-to-secure-my-roxom-account.md): Set up Passkey and Authenticator App to protect your account and enable withdrawals.
- [How to create a Roxom account](https://docs.roxom.com/help-center/security-access/how-to-create-a-roxom-account.md): Step-by-step guide to register for Roxom using email or Google Sign-In.
- [How to log in to your Roxom account](https://docs.roxom.com/help-center/security-access/how-to-log-in-to-your-roxom-account.md): Learn how to log in to your Roxom account using email or Google, and how security methods affect your login flow.
- [Address Book and Withdrawal Whitelist](https://docs.roxom.com/help-center/security-access/address-book-and-withdrawal-whitelist.md): Save withdrawal addresses in your Address Book and lock withdrawals to whitelisted addresses only for extra protection.
- [Can't log in with your passkey?](https://docs.roxom.com/help-center/security-access/passkey-troubleshooting.md): Step-by-step help if your passkey isn't working on a new device or you see an 'insert USB key' message.
- [How to generate API keys](https://docs.roxom.com/help-center/security-access/how-to-generate-api-keys.md): Learn how to create, manage, and secure your Roxom API keys to access the trading API.
- [Passwordless login and access codes](https://docs.roxom.com/help-center/security-access/password-otp.md): Learn how Roxom passwordless login works and how to manage email access codes.
- [My email access code expired, what should I do?](https://docs.roxom.com/help-center/security-access/my-email-access-code-expired-what-should-i-do.md): Learn what to do if your Roxom email access code expired and how to request a new one to log in.
- [Account restrictions: what you need to know](https://docs.roxom.com/help-center/security-access/account-restrictions-what-you-need-to-know.md): Understand why your account may be restricted and how to resolve it.
- [How to delete your Roxom account](https://docs.roxom.com/help-center/security-access/how-to-delete-your-roxom-account.md): Learn how to permanently delete your Roxom account, what the requirements are, and what to expect after deletion.
- [Can I access Roxom from mobile devices?](https://docs.roxom.com/help-center/security-access/can-i-access-roxom-from-mobile-devices.md): Roxom can be accessed from mobile devices using a web browser. Roxom does not currently offer an iOS or Android mobile app, and the platform is available in English and Spanish.
- [Referral Program: how it works](https://docs.roxom.com/help-center/referral-program/referral-program-how-it-works.md): Start here: how referrals are linked to you on Roxom, what qualifies for rewards, and how the overall flow works.
- [Referral rewards and payouts](https://docs.roxom.com/help-center/referral-program/referral-rewards-and-payouts.md): Understand how referral rewards are calculated on Roxom, what the default rate is, and when/where BTC payouts are delivered.
- [Referral dashboard metrics](https://docs.roxom.com/help-center/referral-program/referral-dashboard-metrics.md): Definitions for each Referral Program dashboard metric, including sign-ups, verified users, volume, and earned commissions.
- [Troubleshooting referrals](https://docs.roxom.com/help-center/referral-program/troubleshooting-referrals.md): Fix common issues with referral attribution, missing commissions, payout timing, and dashboard metric delays.
- [Partner Program: eligibility and how to apply](https://docs.roxom.com/help-center/referral-program/partner-program-eligibility-and-how-to-apply.md): Learn who the Partner Program is for, what changes compared to the standard Referral Program, and how to apply.
- [How Roxom protects your assets](https://docs.roxom.com/help-center/trust-center/index.md): How Roxom secures your assets through MPC custody, transaction screening, segregated accounts, and institutional-grade infrastructure partners.
- [Report suspicious activity](https://docs.roxom.com/help-center/security-center/index.md): Report suspicious transactions, phishing attempts, or unauthorized activity. Information for law enforcement agencies on how to submit official requests.
- [My account was compromised](https://docs.roxom.com/help-center/security-guides/account-compromised.md): What to do if you suspect your Roxom account has been accessed without your authorization.
- [Impersonation and phishing](https://docs.roxom.com/help-center/security-guides/impersonation-and-phishing.md): How to identify impersonation scams, recognize phishing attacks, and verify that you're communicating with the real Roxom.
- [Fraud recognition and prevention](https://docs.roxom.com/help-center/security-guides/fraud-and-prevention.md): Common crypto scam patterns, how to spot them, and essential security practices to protect your Roxom account.
- [Legal](https://docs.roxom.com/legal/index.md): Browse Roxom's legal documents, including terms and conditions, privacy policy, risk notice, and user communication guidelines.
- [Terms & Conditions - General Operation](https://docs.roxom.com/legal/terms-and-conditions.md): Review Roxom's general terms and conditions for using the platform, including account setup, trading, custody, fees, and liability.
- [Terms & Conditions - Partner Program](https://docs.roxom.com/legal/terms-and-conditions-partner-program.md): Review the terms for Roxom's Partner Program, including eligibility, commissions, referral rules, and termination policies.
- [Terms & Conditions - Referral Program](https://docs.roxom.com/legal/terms-and-conditions-referral-program.md): Review the terms for Roxom's Referral Program, including how to earn a 10% commission on referred users' trading fees.
- [Terms and Conditions - Trading Program](https://docs.roxom.com/legal/terms-and-conditions-trading-program.md): Review the terms for Roxom's Trader Partnerships Program, where eligible traders receive promotional instruments and profit sharing.
- [Terms & Conditions - Inner Circle Program](https://docs.roxom.com/legal/terms-and-conditions-inner-circle-program.md): Review the terms for Roxom's Inner Circle referral program, an invite-only initiative for VIP members with BTC cashback rewards.
- [Terms & Conditions - BTC Earn](https://docs.roxom.com/legal/terms-and-conditions-btc-earn.md): Review the terms governing Roxom's BTC Earn product, including how earnings work, custody, redemptions, and associated risks.
- [Terms & Conditions - One Click Trade Hunt](https://docs.roxom.com/legal/terms-and-conditions-one-click-trade.md): Review the terms for Roxom's One Click Trade Hunt Challenge, a trading competition rewarding the highest PnL with BTC prizes.
- [Terms & Conditions - Auto-Earn Boost](https://docs.roxom.com/legal/terms-and-conditions-auto-earn-boost.md): Review the terms for Roxom's temporary Auto-Earn Boost promotion, including eligibility, accrual rules, and early termination.
- [Terms & Conditions - First Trade Boost](https://docs.roxom.com/legal/terms-and-conditions-first-trade-boost.md): Review the terms for Roxom's First Trade Boost campaign, which rewards you for opening your first futures position.
- [Terms & Conditions - Zero Trading Fees Campaign](https://docs.roxom.com/legal/terms-and-conditions-zero-trading-fees.md): Review the terms for Roxom's Zero Trading Fees campaign, offering 100% maker and taker fee discounts for a limited time.
- [Terms & Conditions - BLOC ReFi Campaign](https://docs.roxom.com/legal/terms-and-conditions-bloc-refi-campaign.md): Review the terms for Roxom's BLOC ReFi Campaign, which lets eligible users refinance an existing bitcoin-backed loan into BTC Backed Loans.
- [Terms & Conditions - Others](https://docs.roxom.com/legal/terms-and-conditions-others.md): Find our Terms & Conditions for Roxom's active promotions and campaigns
- [Terms & Conditions - OTC Services](https://docs.roxom.com/legal/terms-and-conditions-otc-services.md)
- [Terms & Conditions - BTC Backed Loans](https://docs.roxom.com/legal/terms-and-conditions-btc-backed-loans.md)
- [Fees - Cash In, Cash Out & Custody](https://docs.roxom.com/legal/fees-cash-in-cash-out-custody.md): Overview of Roxom's fees for Cash In, Cash Out, and Custody services.
- [Risk Notice](https://docs.roxom.com/legal/risk-notice.md): Understand the risks of trading digital assets on Roxom, including volatility, security, regulatory, and counterparty risks.
- [Privacy Policies](https://docs.roxom.com/legal/privacy-policy.md): Learn how Roxom collects, uses, stores, and protects your personal data, including your rights under applicable regulations.
- [User Communication Manual](https://docs.roxom.com/legal/user-communication-manual.md): Learn about Roxom's support channels, response times, complaint procedures, and how to contact the customer experience team.
- [.pr body](https://docs.roxom.com/.pr-body.md)
- [Crypto deposits and withdrawals](https://docs.roxom.com/help-center/crypto-deposits-withdrawals/crypto-deposits-withdrawals.md): Learn how to deposit and withdraw BTC, USDC, and USDT from your Roxom account.
- [KYC](https://docs.roxom.com/help-center/kyc/kyc.md): Complete your identity verification to start trading on Roxom.
- [Security and access](https://docs.roxom.com/help-center/security-access/security-access.md): Manage your account security settings, login methods, and protect against unauthorized access.
- [Legal documents date audit report](https://docs.roxom.com/legal/date-audit-report.md): Structured review of effective dates, expiration dates, and renewal terms across all legal documents in the /legal directory.
- [OTC Terms of Service - Roxom Securities](https://docs.roxom.com/legal/securities/terms-and-conditions-otc-services.md): OTC Terms of Service for Roxom Securities' over-the-counter securities trading services.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)
- [raw_openapi](/raw_openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.