API Documentation

Phoebex REST API · Base URL: https://api.phoebex.io · Patent Pending US #64/030,255

Authentication

All requests require a Bearer token. Request an API key →

curl https://api.phoebex.io/v1/status \
  -H "Authorization: Bearer YOUR_API_KEY"

Endpoints

GET/v1/status

API health check — no auth required

{"status":"healthy","version":"1.0.0","available_domains":21}

GET/v1/domains

List all 19 available signal domains

{"domains":[{"id":"financial","name":"Financial Market Timing"},...],"count":19}

GET/v1/signals/{domain}

Get current signal for a domain. Domains: financial, labor, economic, real-estate, consumer, political, gdelt, commodities, fx, supplychain, sovereign_debt, climate, earnings, airline, crypto, mortgage, credit, pmi, smallbiz

{"domain":"labor","signal":{"direction":"bearish","strength":0.785,"lag_months":6}}

GET/v1/composite

All 7 composite economic scores

{"composite_scores":{"recession_probability":{"current_value":5.0},"economic_health":{"current_value":46.1},...},"count":7}

GET/v1/composite/{score_name}

Specific composite score. Names: recession_probability, economic_health, financial_stress, labor_stress, inflation_pressure, re_market_health, supplychain_risk

{"score_name":"recession_probability","current_value":5.0,"as_of":"2025-12","scale":"0-100"}

GET/v1/products

All 28 commercial product scores

{"products":{"hiring_signal":{"current_value":53.6,"current_label":"MAINTAIN"},...},"count":21}

GET/v1/products/{product_name}

Specific product score. Examples: sector_rotation, hiring_signal, ma_timing, pricing_power, capex_timing

{"product":"hiring_signal","current_value":53.6,"current_label":"MAINTAIN headcount","buyer":"HR directors, CFOs"}

GET/v1/real-estate

All 27 US metro market forecasts

{"metros":{"las-vegas":{"prediction":"UP","confidence_pct":77},...},"count":27,"lag":"2 quarters (6 months)"}

GET/v1/real-estate/{metro}

Specific metro. Use hyphens: las-vegas, new-york, san-francisco, houston, nashville

{"metro":"las-vegas","prediction":"UP","confidence_pct":77,"model_accuracy_pct":77}

GET/v1/cross-domain

Top validated cross-domain signal pairs with accuracy

{"strong_signals":15,"top_signals":[{"target":"supplychain_inventory","auc_roc":0.748,"lag_months":6},...]}

GET/v1/accuracy

Live accuracy tracking — predictions vs actual outcomes

{"periods_tracked":1,"note":"Accuracy tracking started April 2026. First verification May 2026."}

Error Codes

401Invalid or missing API key

403Domain not included in your tier

404Domain or metric not found

429Rate limit exceeded

500Internal server error

Python Quick Start

import requests

API_KEY = "your_api_key_here"
BASE = "https://api.phoebex.io"
headers = {"Authorization": f"Bearer {API_KEY}"}

# Get economic health score
r = requests.get(f"{BASE}/v1/composite/economic_health", headers=headers)
print(r.json()["current_value"])  # e.g. 46.1

# Get all metro forecasts
r = requests.get(f"{BASE}/v1/real-estate", headers=headers)
metros = r.json()["metros"]
bullish = [m for m,d in metros.items() if d["prediction"] == "UP"]
print(f"Bullish metros: {bullish}")

Request API Key →