Bifrost Crypto API

Complete reference for the Bifrost Crypto API V1. Integrate multi-chain crypto payments into your platform in minutes.

ᚱ
"Through the rainbow bridge of Bifrost, nine digital realms connect, each guarding ancestral secrets of blockchain technology. Heimdall watches the passages between worlds, allowing only the worthy to cross the sacred portals."

Authentication

All routes require the header with your private API key: X-Bifrost-Invoke

Base URL

All requests are made to:

https://bridge.bifrostcrypto.com

Format

All request and response bodies use JSON format: Content-Type: application/json

Quick Start

Every API request must include your private key in the header:

bash
curl -X GET "https://bridge.bifrostcrypto.com/v1/balances" \
  -H "X-Bifrost-Invoke: YOUR_API_KEY"
ᚱ
"In the mists of Niflheim, only bearers of the golden seal can cross the digital rainbow bridges."
Odin, The Allfather

OpenAPI specification

The whole reference as an OpenAPI 3.1 file. Import it into Postman or Insomnia to try the endpoints, or generate a client in your language. It is built from the same source as this documentation.

Dates and times

Date-time fields (created_at, updated_at, expires_at and the others) are YYYY-MM-DD HH:MM:SS in UTC−03:00, without an offset in the value. Date filters (date_from, date_to) are read in the same offset. Two exceptions: the daily payout limit of an API key resets at 00:00 UTC, and fixed-address webhooks send timestamp in ISO 8601 with the offset included.

Supported Networks

Values accepted in the network field, case-insensitive on create. On create, common aliases are also accepted (erc20, bsc, trc20, matic…) and converted to these names; see Network aliases on the create endpoints. Responses, webhooks and list filters always use the names below. Which tokens are available on each network is returned by GET /v1/summary/tokens.

BitcoinEthereumBinanceSmartChainTronSolanaRippleCardanoDogecoinPolygonAvalancheArbitrumOneCeloOptimismArbitrumCronosBaseBitcoinCashBitcoinSVBitcoinGoldMoneroOpBnbXlayerLitecoinTON

HTTP Status Codes

CodeMeaning
200Success
201Created - fixed address assigned
207Multi-Status - payout batch with some items refused
400Bad Request - invalid parameters
401Unauthorized - missing or invalid API key or signature
403Forbidden - no permission for this resource
404Not Found - resource or route not found
409Conflict - request still in progress or limit reached
422Unprocessable - type not supported
429Too Many Requests - quota or failed-auth limit
500Server Error
502Bad Gateway - a service we depend on failed. Retry later.
503Service Unavailable - try again later

API Categories

Payments Payout

3 endpoints

Create and manage crypto withdrawals. Up to 50 per batch.

Deposits Payin

3 endpoints

Generate deposit wallets and track incoming payments.

Queries

6 endpoints

Check balances, statements, tokens, and account info.

Prices

2 endpoints

Get real-time conversion rates and available currencies.

Fixed Wallets

5 endpoints

Assign and manage permanent deposit addresses per customer.