Bitpulse Documentation Guide
Welcome to Bitpulse documentation. Set up authentication, make your first API call, and understand how the platform is structured — in under 15 minutes.
Bitpulse products and services are available to institutional counterparties in eligible jurisdictions only.
Documentation Structure
Our documentation is organized into four sections:
1. Getting Started (This Page)
Platform overview and navigation guide.
2. Ozone
Real-time risk monitoring for on-chain treasuries — vault scores, alerts, and API access.
3. API Reference
Complete endpoint documentation for loan risk, VaR, and isolated perp risk calculations.
4. Data Catalog
Bitpulse's DeFi dataset on BigQuery — liquidity, stability, and volume across major protocols.
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
- Ozone Score Methodology: How vault risk scores are calculated
For Treasury Teams
- Ozone Overview: Real-time vault risk monitoring
- Configuring Alerts: Set up risk threshold notifications
Core Products
Ozone
Ozone provides real-time risk intelligence for on-chain treasuries:
- Live risk scores for Morpho, Aave, and Maple vaults
- Configurable threshold alerts
- Ozone Score methodology (concentration, oracle drift, market risk)
- Direct API access for integration
Risk API
The Risk API offers risk assessment capabilities for lending and trading desks:
- Loan risk calculation
- Value at Risk (VaR) analysis
- Isolated perpetual risk
- Multiple risk assessment methodologies
Data Catalog
The Data Catalog provides clean, normalized data across multiple blockchains and DEXes on BigQuery:
- Network information across supported blockchains
- Token contract metadata
- DEX protocol deployments
- Uniswap V3 pools, states, positions, and swaps
- OHLCV time series data
Need Help?
- Review Error Handling guides
- Contact our support team at support@bitpulse.io