Introduction
Welcome to Hoseki’s API documentation. These docs are designed to help developers seamlessly integrate Hoseki’s capabilities into their applications, making it easy to verify and manage Bitcoin holdings across the two primary ownership methods: self-custody and exchanges.
Verify API
The Verify API allows users to securely connect self-custodial wallets, view real-time balances, and generate verified ownership statements. Unlike standard wallet integrations, Verify goes a step further—it cryptographically proves ownership of each connected wallet, ensuring your users truly control the Bitcoin they’ve linked.
To get started, check out our Verify API guides.
Hoseki Connect
For assets held on exchanges, Hoseki Connect provides a robust integration layer across a growing number of platforms. It delivers a unified portfolio view by consolidating exchange data—without the overhead of managing multiple APIs.
To get started, please follow our Integrating Hoseki Connect guide.
What You Can Expect from This Documentation
This documentation is structured to guide you through every step of integrating Hoseki’s APIs — both Verify for self-custody and Hoseki Connect for exchange accounts:
- Getting Started: Initial setup instructions and prerequisites for using Hoseki’s APIs.
- Authentication: Protocols for securely authenticating and establishing access requests and sessions with both Verify and Connect.
- API Endpoints: Comprehensive reference for all endpoints, including request and response formats for fetching balances, generating statements, and managing digital asset data.
- Error Handling: Guidance on interpreting and resolving errors to ensure smooth and resilient integrations.
- Best Practices: Recommendations for optimizing performance, security, and user experience across both products.
- Examples and Resources: Sample code, integration patterns, and additional resources to help you implement Hoseki quickly and effectively.
By the end of this documentation, you'll be equipped to fully integrate Hoseki’s APIs into your application — empowering your users to prove and manage their Bitcoin holdings, whether they self-custody or use exchanges.