Swagger API Explorer

Explore, test, and integrate with the Bitnob API using our interactive Swagger-powered documentation. Download OpenAPI specifications, test endpoints live, and generate code snippets - all from your browser.

Quick Access

Interactive Explorer

Test API endpoints live with real-time responses and parameter validation

Download Specifications

Get OpenAPI 3.0 config files and swagger.yaml for your development workflow

Download API Specifications

Get the complete Bitnob API specification in multiple formats for your development environment.

OpenAPI 3.0 Specification Files

openapi.json

Complete OpenAPI 3.0 specification in JSON format for code generation and validation tools

swagger.yaml

Human-readable YAML format specification perfect for documentation and API design tools

Quick Downloads

Click any button below to download the specification file directly:

Download sandbox-openapi.json - Sandbox JSON specification
Download sandbox-swagger.yaml - Sandbox YAML specification

Additional Options

Versioned Downloads: Access specific API versions (v1, v2) for compatibility

Schema-only: Download just the data models and schemas without endpoints

Custom Filtering: Generate specifications for specific endpoint categories

Interactive Features

Live API Testing

Real-time Testing

Execute actual API calls against sandbox or production environments with immediate response validation

Authentication Management

Secure API key storage and automatic header injection for authenticated requests

Parameter Validation

Real-time validation of request parameters with helpful error messages and examples

Response Inspection

Formatted JSON responses with syntax highlighting, error analysis, and performance metrics

Code Generation

Generate client code and integration examples directly from the API specification.

Supported Languages

JavaScript/Node.js

ES6+ compatible code with async/await patterns and TypeScript definitions

Python

Python 3.7+ compatible requests-based client with type hints and error handling

PHP

PSR-4 compliant PHP client with Composer support and Laravel integration

Go

Idiomatic Go client with context support, structured errors, and comprehensive testing

cURL

Ready-to-execute cURL commands with proper headers, authentication, and payload formatting

Java

Java 11+ client using modern HTTP client with Jackson serialization and Spring Boot compatibility

C#/.NET

.NET 6+ compatible client with async patterns, dependency injection, and comprehensive logging

Ruby

Ruby 2.7+ compatible gem with ActiveRecord-style interfaces and Rails integration helpers

Getting Started

Step 1: Access the Explorer

Open Interactive Explorer: Visit /swagger-ui to access the live documentation interface

Select Environment: Choose between sandbox API environments

Authentication Setup: Configure your API key for authenticated endpoint testing

Browse Categories: Explore endpoints organized by functionality (wallets, transactions, transfers, etc.)

Step 2: Download Specifications

Choose Format: Select openapi.json for tooling integration or swagger.yaml for human readability

Select Version: Download current version or specific API version for compatibility

Environment Option: Get production or sandbox specifications based on your needs

Import to Tools: Use downloaded files with Postman, Insomnia, or code generation tools

API Coverage

Our Swagger documentation covers 100% of the Bitnob API surface area.

Core Endpoints

Authentication & Security - API key verification, permissions, and token management

Wallet Management - Create, list, and manage cryptocurrency and fiat wallets

Transaction Processing - Send, receive, and track Bitcoin and Lightning transactions

Transfer Operations - Internal transfers between wallets and external transfers

Customer Management - KYC, user verification, and account management

Virtual Cards - Issue, manage, and control spending on virtual debit cards

Trading & Exchange - Spot trading, market data, and order management

Payouts & Settlements - Batch payouts, recipient management, and compliance

Webhooks - Event notifications and real-time updates configuration

Lightning Network - Invoice generation, payment processing, and channel management

Security & Authentication

API Key Management

Secure Storage

API keys are stored locally in your browser session and never transmitted to our documentation servers

Permission Validation

Real-time validation of API key permissions before executing potentially destructive operations

Environment Separation

Strict separation between sandbox and production API keys to prevent accidental live transactions

Automatic Headers

Proper authentication headers automatically included in all test requests with signature validation

Integration Workflows

Explore API: Use interactive explorer to understand endpoint behavior and data models

Download Specification: Get openapi.json or swagger.yaml for your development environment

Generate Client Code: Use OpenAPI generators to create SDK in your preferred language

Test Integration: Validate your implementation against sandbox environment

Production Deploy: Switch to production API keys and deploy your integration

Tool Integration

Postman Integration

Import swagger.yaml directly into Postman for advanced testing and automation workflows

OpenAPI Generator

Use openapi-generator CLI tool with our specification to create client libraries in 40+ languages

API Design Tools

Import specifications into Swagger Editor, Insomnia, or other API design platforms

Advanced Features

Performance Monitoring

Response Time Tracking - Monitor API endpoint performance in real-time

Payload Size Analysis - Understand request and response data volumes

Rate Limit Monitoring - Track API usage against your rate limit quotas

Error Rate Analytics - Monitor success rates and common failure patterns

Testing Utilities

Request History

Track and replay previous API requests for regression testing and debugging

Batch Testing

Execute multiple API calls in sequence with dependency management and result validation

Mock Responses

Generate realistic mock responses based on API schemas for front-end development

Schema Validation

Validate API responses against OpenAPI schemas to ensure compliance and catch regressions

Tip

Pro Tip: Download the openapi.json specification and use it with OpenAPI Generator to create a fully-featured client library in your preferred programming language. This ensures type safety and reduces integration time significantly.

Note

Environment Safety: Always start with sandbox API keys when testing. Our interactive explorer clearly indicates which environment you're using, but double-check before making transactions with real funds.