Skip to documentation
API docs/QuickstartChapters +
Documentation/Getting started
v1

Getting started

Quickstart

From discovery to your first API key.

  1. Fetch the machine-readable manifest: GET https://www.eclipse.trade/api/v1 — it states exactly what this API serves, the auth scheme, and every endpoint. Then GET /api/v1/catalog for the exact live universe. A condensed site summary lives at /llms.txt.
  2. Validate your parser against the static sample: GET https://www.eclipse.trade/api/v1/signals/sample (no auth; exact live-feed shape, not live data). OpenAPI 3.1 definition: GET /api/v1/openapi.json.
  3. Check what the feed actually produces before paying: GET /api/v1/stats (no auth) returns descriptive volume — how many signals fire, by indicator, timeframe and direction, over the last 30 days. Volume facts, not performance claims: counts help you assess volume, but you need to evaluate usefulness against your own strategy.
  4. Buy it yourself. $129/month or $1199/year, and the whole purchase is two HTTP calls — no approval, no sales call, no human issuing anything:
    # 1. Start checkout — no auth, no approval, no human
    curl -X POST https://www.eclipse.trade/api/v1/access/checkout \
      -H "Content-Type: application/json" \
      -d '{"contact_email": "you@example.com", "billing": "monthly"}'
    
    # → { "checkout_url": "https://checkout.stripe.com/…",
    #     "claim_token": "ec_claim_…",           ← shown ONCE, persist it now
    #     "plan": { "tier": "premium", "billing": "monthly", "amount_usd": 129 } }
    
    # 2. Complete payment at checkout_url.
    
    # 3. Exchange the token for your key (retry every 10s while "pending")
    curl -X POST https://www.eclipse.trade/api/v1/access/claim \
      -H "Content-Type: application/json" \
      -d '{"claim_token": "ec_claim_…"}'
    
    # → { "api_key": "ek_…" }   ← returned exactly once

    Already an Eclipse Premium member? API access is included in your plan: create your key at https://www.eclipse.trade/dashboard (Settings, API access). No second purchase.

That is the whole onboarding. The only step needing a payment instrument is the Stripe checkout itself. If you need bulk pricing, redistribution rights or custom terms, there is an optional human path at POST /api/v1/access-request — but it is not required and not the normal route.

Signals are informational outputs of technical indicators, not investment advice or a solicitation to trade. Past signals do not guarantee future performance. Use of this API is governed by the Eclipse terms of use.

Standard API access is self-serve under the published Eclipse terms of use and the pricing and quota on /api/docs/access. No separately negotiated agreement is required for standard access. There is no formal uptime SLA. Redistribution, resale, or custom commercial terms require a separate written agreement through /api/v1/access-request.

Support & access recovery

Search API documentation

↑ ↓ to navigate · Enter to openEsc to close
Quickstart | Eclipse API