Bitpulse Documentation Guide
Welcome to the Bitpulse documentation! This guide will help you navigate our documentation and find the resources you need to get started with our services.
Documentation Structure
Our documentation is organized into three main sections:
1. Getting Started (This Page)
This guide helps you understand and navigate Bitpulse's documentation and services.
2. Data Services
Documentation for our data products, including the Data Catalog and Risk Metrics.
3. Risk Simulations
Information about our risk simulation tools, APIs, and client portals.
Quick Navigation
For New Users
- API Authentication Guide: Learn how to authenticate with our APIs
- Data Catalog Overview: Explore our comprehensive DeFi dataset
- Risk API Introduction: Understand our risk assessment API capabilities
For Analysts and Builders
- Data Catalog Tables: Documentation for all available data tables
- Performance Tips: Optimize your queries and data usage
- Risk Metrics Overview: Understand our risk measurement methodologies
For Risk Managers
- Risk API Reference: Technical documentation for our risk assessment API
- Client Portal Solutions: Custom risk simulation interfaces
For Traders
- Sentinel Platform: Our risk management platform for traders
Core Products
Data Catalog
The Data Catalog provides clean, normalized data across multiple blockchains and DEXes, available on BigQuery. It includes:
- Network information across supported blockchains
- Token contract metadata
- DEX protocol deployments
- Uniswap V3 pools, states, positions, and swaps
- OHLCV time series data
Risk API
The Risk API offers powerful risk assessment capabilities:
- Loan risk calculation
- Value at Risk (VaR) analysis
- Optimal loan parameter determination
- Multiple risk assessment methodologies
Sentinel
Sentinel is our risk management platform for traders and non-technical users:
- Real-time position monitoring
- Risk forecasting
- Funding cost analysis
- Support for various trading instruments
Client Portals
Our Client Portals provide customized risk simulation interfaces:
- Loan Margin Optimizer
- Risk Loan Calculator
- Custom analytics dashboards
Need Help?
If you need assistance with our documentation or services:
- Check our FAQ sections
- Review Error Handling guides
- Contact our support team at support@bitpulse.io