HodlBaseDocs
OverviewREST APIWebSockets

HodlBase API

The first API built for accessing Bitcoin treasury data. Gain insight into BTC holdings, mNAV, amplification, and leverage for treasury companies, alongside yields, credit ratings, and volume for preferred securities — available in real-time or historical time series.

Base URLhttps://api.hodlbase.io/v2
56+
Metrics
2
Entity Types
Live
Real-time Data
14d
Historical Data

Features

Structured financial data for Bitcoin treasury companies and their preferred securities.

Bitcoin Treasuries

Comprehensive metrics for public companies holding Bitcoin as a treasury asset. Access BTC holdings, reserve valuations, mNAV ratios, amplification factors, leverage metrics, and capital structure data.

BTC HoldingsBTC ReserveEnterprise ValueDebt OutstandingBitcoins Bought YTD
Capital Raised YTDCommon Stock PriceMarket CapBTC per ShareBasic Shares OutstandingFully Diluted Shares OutstandingShares per BTCmNAVAmplificationNet LeverageGross LeveragePreferred AmplificationTotal Preferred NotionalTotal Preferred Market CapTotal Dividends PaidUSD Cash ReserveAnnual Preferred DividendsAnnual Dividends (Total)BTC Years Dividend CoverageUSD Months Dividend CoverageBTC 7-Day Historical VolatilityBTC 30-Day Historical Volatility

Preferred Securities

Detailed data for preferred stocks issued by Bitcoin treasury companies. Track effective yields, Bitcoin ratings, dividend coverage, notional values, ATM issuances, and trading volume.

Close PriceEffective YieldMarket CapNotional ValueDividend Rate
Shares OutstandingBitcoin RatingPure Bitcoin RatingHigher Seniority NotionalCumulative Capital RaisedCumulative ATM Capital RaisedTotal Dividends PaidATM Capital Raised (Daily)ATM Capital Raised (YTD)Bitcoin AccumulatedTotal Bitcoin AccumulatedDaily Volume (Currency)Daily Volume Above Par (Currency)Average 30-Day VolumeVWAPCumulative Volume (Currency)Cumulative Volume Above Par (Currency)Credit Spread vs AAACredit Spread vs SOFRCredit Spread vs US 10YMacaulay Duration90-Day BTC Price Correlation30-Day Historical Volatility90-Day BTC Return Correlation
Live

Real-time Data

Get the latest metric values updated continuously throughout each trading day. Live endpoints return the most recent snapshot of any metric — from BTC holdings to market caps and yield calculations.

Timeseries

Historical Data

Access up to 14 days of historical data on the explorer plan. Timeseries endpoints return daily data points for any metric, perfect for trend analysis, backtesting, and research.

Simple Auth

Single API key in the X-API-Key header. No OAuth, no token refresh.

RESTful JSON

Clean REST endpoints returning JSON. Works with any language or HTTP client.

Per-Metric Endpoints

Fetch metrics by subgroup or query individual metrics for efficient, targeted data access.

Integrate in minutes

Easily bring HodlBase data into your web app, dashboard, or Node.js service — with a single npm install.

Build faster with @hodlbase/client

Type-safe access to every endpoint with built-in auto-pagination, zero dependencies, and full IntelliSense. Drop it into any webapp, dashboard, or Node.js service.

npm install @hodlbase/client
Company data
import { HodlBase } from "@hodlbase/client"
const hb = new HodlBase("YOUR_API_KEY")

// Get Strategy's latest BTC holdings
const mstr = await hb.companies.get("MSTR")

// MSTR share price — live snapshot
const price = await hb.companies.metrics
  .priceLive("MSTR")
Security metrics
// STRC volatility — live
const vol = await hb.securities.metrics
  .volatilityLive("STRC")

// STRC vol-above-par — 14-day history
const hist = await hb.securities.metrics
  .volAboveParTs("STRC")
View on npm →

Quickstart

Make your first API request in seconds. All you need is an API key.

Sample Requests

# 1. Get fundamental metrics for a specific company
curl -X GET "https://api.hodlbase.io/v2/companies/MSTR/fundamental_metrics/live" \
  -H "X-API-Key: YOUR_API_KEY"

# 2. Get historical timeseries for a metric
curl -X GET "https://api.hodlbase.io/v2/companies/MSTR/fundamental_metrics/btc_holdings/ts?days=14" \
  -H "X-API-Key: YOUR_API_KEY"

# 3. Get live data for a preferred security
curl -X GET "https://api.hodlbase.io/v2/securities/STRK/fundamental_metrics/live" \
  -H "X-API-Key: YOUR_API_KEY"

Sample Response

Response from GET /companies/MSTR/fundamental_metrics/live:

{
  "status": "ok",
  "ticker": "MSTR",
  "subgroup": "fundamental_metrics",
  "subgroup_display_name": "Fundamental Metrics",
  "plan": "explorer",
  "metrics_count": 5,
  "result": {
    "timestamp": "2026-02-10",
    "values": {
      "btc_holdings": 478740,
      "btc_reserve_usd": 46528410000,
      "bitcoin_per_share": 0.0019915,
      "enterprise_value_usd": 85000000000,
      "mnav": 1.827
    }
  }
}

Getting Access

Get started with the HodlBase API in three simple steps.

1

Create an Account

Sign up for a free HodlBase account. No credit card required — you can start exploring the API immediately with the explorer plan.

Create Account
2

Generate an API Key

Go to your Account page and navigate to the API Keys section. Click Create API Key to generate your key. Copy it and store it securely — you won't be able to see it again.

Go to Account
3

Include Your Key in Requests

Add your API key to every request using the X-API-Key header. That's it — no OAuth, no token refresh, no complexity.

curl -X GET "https://api.hodlbase.io/v2/companies" \
  -H "X-API-Key: YOUR_API_KEY"

Explore the Endpoints

Browse all available endpoints, parameters, and response examples.