BitcoinVN API - Integration Guide & Use Cases

    BitcoinVN offers a REST API that lets developers integrate instant cryptocurrency exchange into their own applications. Full interactive documentation is available at bitcoinvn.io/api/doc.

    Getting started

    1. Get your API key: Register at bitcoinvn.io and generate an API key from your dashboard (bitcoinvn.io/api-keys)
    2. Explore endpoints: Browse the interactive Swagger UI at bitcoinvn.io/api/doc or download the OpenAPI spec at bitcoinvn.io/api/doc.json
    3. Go live: Create quotes, submit orders, and receive webhook notifications

    Authentication

    Public endpoints (rates, asset info, order lookup) require no authentication. For private endpoints (creating orders, balances, KYC, staking), include your API key in the X-API-KEY header with every request.

    Core workflow

    1. GET /api/info - Discover supported assets and transfer methods
    2. POST /api/quotes - Lock an exchange rate for 15 minutes
    3. POST /api/orders - Create an order using the quote ID and settlement details
    4. Customer sends deposit to the address provided in the order response
    5. GET /api/orders/{shortId} - Track order status, or listen for webhook callbacks

    Use cases

    • Swap aggregators: List BitcoinVN as an exchange provider across 100+ assets. Use the public rate and quote endpoints to display competitive prices, then submit orders on behalf of users.
    • Merchant payments: Accept cryptocurrency payments from customers worldwide and settle in any supported asset.
    • Wallets and apps: Embed exchange functionality directly in your wallet or app with just a few API calls. Users can swap between assets without leaving your interface.
    • Automated trading: Build bots that monitor rates via the ticker endpoint and execute swaps programmatically when target prices are reached.
    • Accounting and reporting: Use the balance and ledger endpoints to pull transaction history for bookkeeping, reconciliation, or tax reporting.
    • Compliance tools: Leverage the blacklist management endpoints to screen crypto addresses or IP addresses and set freezing thresholds for flagged transactions.
    • Staking dashboards: Query current staking offers and manage auto-stake preferences through your own interface.

    Key features

    • 100+ supported assets across multiple networks
    • Binding quotes with guaranteed pricing for 15 minutes
    • Webhook notifications for real-time order status updates
    • No personal data required for basic crypto-to-crypto swaps
    • OpenAPI 3.0 spec for easy client code generation

    Developer support

    For integration questions, join our developer Telegram chat or contact us at [email protected].

    Published