API for providing insights into Bitcoin transactions before signing. Offers guides on authentication, simulations, and error handling. Includes documentation and SDKs for integration.
Features
API Key Management
Create and manage API keys through the account settings page to access the API.
Transaction Insights
Provides detailed insights into Bitcoin transactions before they are signed, with information on how many Bitcoin, Ordinals, and BRC-20’s are being transferred.
Simulation
Allows users to simulate Bitcoin PSBTs (Partially Signed Bitcoin Transactions) and transactions using HTTP APIs or dedicated client SDKs.
Authentication Guide
Provides guidance on how to authenticate API requests to securely interact with the service.
Error Handling Guide
Offers information on the different types of errors that can be returned by the API and how to handle them.
API Key Management
You need to obtain your API key from the VirtOshi dashboard to make requests to the API.
Client Selection
Guidance on choosing an appropriate API client for making HTTP requests, with support for cURL and a JavaScript client.
First API Request Example
A detailed example showcasing how to make a POST request to the API's Simulation endpoint using cURL, JavaScript, and Python.
JavaScript SDK
Works in any JavaScript runtime environment that supports Fetch (Web, Node.js®, React-Native).
Authorization with bearer token
Allows you to authenticate requests by adding an API key to the request header using cURL. This involves using a bearer token for security.
Using an SDK
Provides a simpler way to authenticate requests by using official SDKs, which manage API key handling automatically.
Status Codes
Provides a list of HTTP status codes returned by the Virtoshi API to help identify the success or failure of a request.
Error Types
Describes specific error types such as 'InvalidAuthenticationError', 'RateLimitExceededError', and 'P2SHScriptError' to help users understand and resolve issues.
Run a simulation
Allows you to run a transaction simulation on the Bitcoin blockchain. It returns the state changes for requested addresses before executing them permanently.
SDKs
Provides software development kits to integrate with the service.
Authentication
Offers secure methods for user authentication to access the service.
Error Management
Documentation or tools for handling errors within the service.
API Simulation
Allows testing and simulation of API calls for development and debugging.
Manage API Key
Enables users to manage their API keys for accessing services securely.