API Documentation

Complete REST API and SSE streaming documentation for ab astris variable star discovery platform. All endpoints return JSON responses.

Production API

https://starhunt-apiu.onrender.com

Local Development

http://localhost:8000

Swagger UI

https://starhunt-apiu.onrender.com/api/docs

Routers

Quick Links

SSE Streaming Endpoints Interactive Swagger UI ↗

Analysis

Single and batch TIC variability analysis with period detection

Discoveries

Discovery management, plots, coordinates, and exports

Bulk Analysis

CSV upload and bulk job management

Sectors

TESS sector exploration with discovery prediction

Targets

TIC search by sector, coordinates, or region

Validation

Catalog cross-validation and accuracy metrics

Export

LaTeX and CSV export for publication

FITS Export

FITS binary table export for DS9/TOPCAT

Cross-Validation

Cross-validate TESS discoveries with Kepler/K2 (period confirmation) and Gaia DR3 (variability + type)

Kepler/K2 Browse

Browse Kepler quarters and K2 campaigns (for cross-validation coverage checks)

Transit Detection

BLS transit search, candidate vetting, and ExoFOP validation for exoplanet discovery

SSE Streaming Endpoints

Server-Sent Events (SSE) endpoints for real-time analysis progress and live updates

SSE

/ws/analysis/{session_id}

Real-time analysis progress

Streams log messages during single/batch analysis. Connect before starting analysis job to receive live updates.

WebSocket URL: ws://localhost:8000/ws/analysis/abc123...

Messages:
{"level": "info", "message": "Analyzing TIC 277539431..."}
{"level": "info", "message": "Period detected: 0.3456 days"}

SSE

/ws/bulk-analysis/{job_id}

Bulk CSV upload progress

Streams progress updates during bulk analysis jobs. Shows current TIC, completed count, and discoveries found.

WebSocket URL: ws://localhost:8000/ws/bulk-analysis/xyz789...

Messages:
{"completed": 45, "total": 100, "discoveries": 12, "current_tic": 123456}

SSE

/ws/sector-analysis/{sector}/{job_id}

Sector preview progress

Streams real-time progress during sector preview analysis. Shows TIC-by-TIC analysis status and predictions.

WebSocket URL: ws://localhost:8000/ws/sector-analysis/1/abc123...

Messages:
{"tic": 123456, "status": "analyzing", "progress": "25/50"}

Need Help?

All endpoints are documented with interactive examples in Swagger UI. You can test requests directly from your browser.

Open Swagger UI