API Documentation

Our API provides programmatic access to the Bitcoin Fundamental Indicator and weekly thresholds.

1. BTC Data Endpoint

GET /api/btc

Query Parameters

• date (optional): Fetch data for a specific date. Format: YYYY-MM-DD
• start and end (optional): Fetch data within a date range. Format: YYYY-MM-DD
• If no parameters are provided, all rows are returned.

Response Fields

• timestamp: ISO 8601 datetime string
• BTC_Price_USD: Bitcoin price in USD
• FS_Optimized: Combined fundamental score
• FS_3Cat_Score: Weekly category score (0,1,2)
• FS_Directional_Label: Directional indicator ("Up 📈", "Down 📉", "Flat ⏸")
• thresholds: Weekly thresholds for the data point

Sample Request

GET /api/btc?date=2025-09-12

Sample Response

[
  {
    "timestamp": "2025-09-12T19:35:45+00:00",
    "BTC_Price_USD": 116528,
    "FS_Optimized": 72.99,
    "FS_3Cat_Score": 1.0,
    "FS_Directional_Label": "Up 📈",
    "thresholds": [64.98, 67.5, 72.9, 75.64]
  }
]

2. Thresholds Endpoint

GET /api/thresholds

Query Parameters

• week (optional): Return thresholds for a specific week. Format: YYYY-W## (e.g., 2025-W37)
• If omitted, all weekly thresholds are returned.

Sample Requests

GET /api/thresholds
GET /api/thresholds?week=2025-W37

Sample Responses

[
  {
    "2025-W37": [64.98, 68.13, 72.81, 75.64]
  }
]

Notes

• Timestamps are in UTC and ISO 8601 format.
• The API is informational and does not provide financial advice.
• Rate limit: 10 requests per minute per IP.