# Bifrost Crypto API

> Markdown version of the public documentation of the Bifrost Crypto API v1, for AI agents and code generators. Same content as the HTML pages, generated from the same source, without navigation or styling.
>
> HTML version: https://bifrostcrypto.com/en/docs
> Related files: [ai.md](https://bifrostcrypto.com/ai.md) · [Postman](https://bifrostcrypto.com/postman-collection.json) · [OpenAPI](https://bifrostcrypto.com/openapi.json) · [llms.txt](https://bifrostcrypto.com/llms.txt)
> Other languages: [Português](https://bifrostcrypto.com/ai/pt-BR/introduction.md) · [Español](https://bifrostcrypto.com/ai/es/introduction.md) · [Français](https://bifrostcrypto.com/ai/fr/introduction.md)
> API v1 · contract last changed on 2026-10-10

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

## 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"
```

## 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.

https://bifrostcrypto.com/openapi.json

## 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.

`Bitcoin`, `Ethereum`, `BinanceSmartChain`, `Tron`, `Solana`, `Ripple`, `Cardano`, `Dogecoin`, `Polygon`, `Avalanche`, `ArbitrumOne`, `Celo`, `Optimism`, `Arbitrum`, `Cronos`, `Base`, `BitcoinCash`, `BitcoinSV`, `BitcoinGold`, `Monero`, `OpBnb`, `Xlayer`, `Litecoin`, `TON`

## HTTP Status Codes

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