Base URL: https://bitcoinquant.co/api/v1
All API requests require a Bearer token in the Authorization header:
Authorization: Bearer bq_live_<keyId>.<secret>
Get your API key at /developers. Free keys are available instantly.
| Plan | Rate Limit | Data Access | Price |
|---|---|---|---|
| FREE | 60 req/min | Basic fields, 7-day history | $0/mo |
| PRO | 300 req/min | All fields, full history | $49/mo |
Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
/v1/preferred-equityList all preferred equity securities with current data.
ticker(string)— Filter by ticker (e.g., STRC, STRD, STRF, STRK, SATA)sort_by(string)— Sort field: ticker, stock_price, effective_yield, market_cap, trading_volume_usd, sharpe_ratiosort_order(string)— asc or desc (default: asc)/v1/preferred-equity/{ticker}Get detailed data for a single preferred equity security.
/v1/preferred-equity/historicalGet historical preferred equity data.
ticker(string)— Filter by ticker (recommended)days(number)— Number of days (PRO only, 1-365)limit(number)— Results per page (default 500, max 5000)offset(number)— Pagination offsetsort_order(string)— asc or desc (default: desc)Complete list of every field returned by the API. Fields marked FREE are included in all plans. Fields marked PRO require a PRO key.
Endpoints: /v1/preferred-equity · /v1/preferred-equity/{ticker}
| Field | Type | Description | Plan |
|---|---|---|---|
| ticker | string | Ticker symbol (STRC, STRD, STRF, STRK, SATA) | FREE |
| issuer | string | Issuing company name | FREE |
| name | string | Full security name | FREE |
| stock_price | number | Current stock price (USD) | FREE |
| current_dividend | number | Current annual dividend per share (USD) | FREE |
| effective_yield | number | Annual dividend / current price (%) | FREE |
| ipo_date | string | Date of IPO | FREE |
| ipo_price | number | IPO price (USD) | FREE |
| three_month_return | number | Price return over the past 3 months (%) | FREE |
| lifetime_return | number | Price return since IPO (%) | FREE |
| market_cap | number | Market capitalization (USD) | FREE |
| shares_outstanding | number | Total shares outstanding | FREE |
| dividend_payment_timeframe | string | Dividend frequency (e.g. quarterly) | FREE |
| updated_at | string | Last data refresh timestamp | FREE |
| overview | string | Short overview of the security | PRO |
| description | string | Detailed security description | PRO |
| price_3m_ago | number | Stock price 3 months ago (USD) | PRO |
| notional_value | number | Notional value (shares × $100 par) | PRO |
| trading_volume_usd | number | Latest day trading volume (USD) | PRO |
| avg_trading_volume_7d | number | 7-day average daily volume (USD) | PRO |
| avg_trading_volume_30d | number | 30-day average daily volume (USD) | PRO |
| scaled_vol_above_100_usd | number | Volume traded above $100 par (USD) | PRO |
| scaled_vol_below_100_usd | number | Volume traded below $100 par (USD) | PRO |
| scaled_vol_above_100_rth_usd | number | Volume above $100 during regular trading hours (USD) | PRO |
| scaled_trading_volume_rth_usd | number | Total volume during regular trading hours (USD) | PRO |
| volume_above_100_pct | number | Percentage of volume traded above $100 par | PRO |
| volatility_7d | number | 7-day annualized volatility | PRO |
| volatility_30d | number | 30-day annualized volatility | PRO |
| volatility_60d | number | 60-day annualized volatility | PRO |
| volatility_90d | number | 90-day annualized volatility | PRO |
| this_weeks_volume | number | Total trading volume this week (USD) | PRO |
| this_weeks_volume_above_par | number | Volume above $100 par this week (USD) | PRO |
| this_weeks_volume_above_par_pct | number | Percentage of this week's volume above par | PRO |
| sharpe_ratio | number | Risk-adjusted return (excess return / volatility) | PRO |
| risk_free_rate | number | Risk-free rate used for Sharpe calculation | PRO |
| created_at | string | Record creation timestamp | PRO |
| last_updated | string | Last data update timestamp | PRO |
Endpoint: /v1/preferred-equity/historical · FREE: last 7 days · PRO: full history
| Field | Type | Description | Plan |
|---|---|---|---|
| date | string | Trading date (YYYY-MM-DD) | FREE |
| ticker | string | Ticker symbol | FREE |
| stock_price | number | Closing price (USD) | FREE |
| effective_yield | number | Effective yield on that date (%) | FREE |
| trading_volume | number | Daily trading volume (USD) | FREE |
| market_cap | number | Market capitalization (USD) | FREE |
| notional | number | Notional value (USD) | FREE |
| dividend_rate | number | Dividend rate on that date | FREE |
| volatility_30d | number | 30-day annualized volatility | FREE |
| sharpe_ratio | number | Sharpe ratio on that date | FREE |
| open_price | number | Opening price (USD) | PRO |
| high_price | number | Intraday high price (USD) | PRO |
| low_price | number | Intraday low price (USD) | PRO |
| avg_trading_volume_7d | number | 7-day average daily volume (USD) | PRO |
| avg_trading_volume_30d | number | 30-day average daily volume (USD) | PRO |
| shares_outstanding | number | Shares outstanding on that date | PRO |
| volatility_7d | number | 7-day annualized volatility | PRO |
| volatility_60d | number | 60-day annualized volatility | PRO |
| volatility_90d | number | 90-day annualized volatility | PRO |
| volume_above_100_pct | number | Pct of volume above $100 par | PRO |
| scaled_vol_above_100_usd | number | Volume above $100 par (USD) | PRO |
| scaled_vol_below_100_usd | number | Volume below $100 par (USD) | PRO |
| scaled_vol_above_100_rth_usd | number | Volume above $100 during regular hours (USD) | PRO |
| trading_volume_rth | number | Total volume during regular hours (USD) | PRO |
| volume_in_99_101_band_pct | number | Pct of volume in $99–$101 band | PRO |
| cumulative_weekly_volume | number | Cumulative volume for the week (USD) | PRO |
| cumulative_weekly_scaled_vol_above_100_usd | number | Cumulative weekly volume above par (USD) | PRO |
| day_of_week | string | Day of the week (Mon, Tue, etc.) | PRO |
| three_month_return | number | 3-month return as of that date (%) | PRO |
| one_year_return | number | 1-year return as of that date (%) | PRO |
| lifetime_return | number | Lifetime return as of that date (%) | PRO |
/v1/keysGenerate a new FREE API key.
email(string)— Your email address (required, in body)name(string)— Optional key name (in body)/v1/keys?email={email}List your API keys. Requires authentication.
email(string)— Your email address/v1/keys/{keyId}Revoke an API key. Requires authentication.
| Code | Status | Description |
|---|---|---|
| AUTHENTICATION_FAILED | 401 | Invalid or missing API key |
| API_KEY_EXPIRED | 401 | API key has expired |
| API_KEY_REVOKED | 401 | API key has been deactivated |
| RATE_LIMIT_EXCEEDED | 429 | Too many requests — check X-RateLimit-Reset header |
| VALIDATION_ERROR | 400 | Invalid query parameters |
| INTERNAL_ERROR | 500 | Server error — contact support |