SPB Git forge
3commits 1branches 0releases
417.0 KBsize
maindefault branch
10 days agolast push
TypeScript 66.5% Python 30.9% JavaScript 1.4% CSS 0.7%
2.9 KB · 35 lines markdown
Rendered Raw Blame History
1# SatelliteIndex API — /api/v123Base URL: `https://www.satelliteindex.io/api/v1` (OpenAPI: `/api/v1/docs`, `/api/v1/openapi.json`). Envelope `{ "data": …, "meta": { request_id, generated_at, … } }`;4lists `{ "data": [], "pagination": { page, page_size, total, pages }, "meta": {} }`. Errors `{ "error": { title, detail, status }, "meta": {} }`. All times UTC ISO 8601; km, km/s, degrees, minutes.56| Endpoint | Purpose |7|---|---|8| `GET /health`, `/ready` | service + data freshness |9| `GET /satellites` | list/filter (`status, object_type, orbit_class, mission_type, country, operator, constellation, launch, launch_site, on_orbit, has_gp, launched_after/before, decayed_after, min/max_perigee, tag, q, sort, page, page_size`) |10| `GET /satellites/facets` | facet counts for the same filters |11| `GET /satellites/{slug|norad|id}` | detail: orbital_state, live position, aliases, tags, identifiers, history, memberships, provenance, events, quality flags, siblings, related, sources, freshness |12| `GET /satellites/{id}/orbit` | element-set history (append-only) |13| `GET /satellites/{id}/position?time=` | SGP4 position (lat, lon, altitude_km, velocity_km_s, source_epoch) |14| `GET /satellites/{id}/track?before=45&after=90&step=60` | ground track |15| `GET /satellites/{id}/history` | change log + daily altitude series |16| `GET /satellites/{id}/live` | position from the shared in-memory propagator |17| `GET /orbit/positions?step=30` | compact batch for the globe: `norad[]`, `cls[]`, `mission[]`, `active[]`, `pos[]` (lat0,lon0,alt0,lat1,lon1,alt1 …), `vel[]` |18| `GET /orbit/density` | altitude buckets, LEO 25 km profile, inclination profile |19| `GET /search?q=&limit=&types=` · `/search/suggest?q=` | unified search (satellites, operators, constellations, countries, launches, sites) |20| `GET /stats` · `/stats/home` | global statistics snapshot (hourly) |21| `GET /rankings?metric=constellations|operators|countries|countries-debris|launches|fastest-growing|congested-shells|launch-years` | rankings |22| `GET /constellations` · `/constellations/{slug}` | constellations + deployment analytics |23| `GET /operators` · `/operators/{slug}` | organizations |24| `GET /countries` · `/countries/{code|slug}` | countries |25| `GET /launches` · `/launches/timeline` · `/launches/{cospar}` | launches (derived from international designators) |26| `GET /launch-sites` · `/launch-sites/{slug}` | launch sites |27| `GET /debris` · `/reentries` | debris explorer · decays + low-perigee watch (not a prediction) |28| `GET /events` · `/events/{id}` | derived event feed |29| `GET /sources` · `/sources/status` · `/methodology` | transparency |30| `POST /views` | anonymous page-view beacon `{entity_type, entity_id}` |31| `/admin/*` | token-protected (`x-si-admin-token`) |3233Rate limits per IP per minute: default 600, search 120, positions 60, position/track 240, admin 120.34Attribution: orbital data courtesy of CelesTrak. Not for operational use.35