Guida rapida

Cinque minuti dalla registrazione a una carta natale completa in JSON. Copre l’installazione dell’SDK, la prima richiesta, gli header di risposta, l’autenticazione e la gestione degli errori.

// avvio rapido

Ottieni la tua chiave API in 60 secondi

10.000 crediti/mese per sempre gratis. Senza carta.

1. 01
   Registrati

   Email + password. Un account per tutti i prodotti AstroWay.
2. 02
   Crea la chiave

   Nel dashboard clicca su "Crea chiave". aw_live_ o aw_test_ (sandbox).
3. 03
   Fai una richiesta

   POST /v1/chart con header X-Api-Key. Mappa natale completa in JSON.

Registrati - gratis→Guida rapida

1. Genera una chiave API

   Entra nella dashboard e premi Generate key. Il piano gratuito offre 10 000 crediti/mese per sempre, senza inserire una carta. Le chiavi iniziano con:

   • aw_live_*: produzione, addebiti reali
   • aw_test_*: sandbox, nessun consumo di crediti, risposta deterministica

   Attenzione

   La chiave è un segreto. Non committarla in git, non inserirla nel codice frontend. Per il frontend usa un backend proxy o token di sessione a breve durata (Phase 3).

2. Installa l’SDK

   L’API è un normale REST + JSON, quindi l’SDK non è obbligatorio. Ma tutti e tre sono già pubblicati: TypeScript (@astroway/sdk), Python (astroway) e PHP (astroway/sdk), più un server MCP (@astroway/mcp) per gli agenti AI.

   cURL

   # No SDK needed - just curl and a key:
   export AW_KEY="aw_test_demo_replaceme"

   TypeScript

   npm install @astroway/sdk
   # or without an SDK: native fetch, Node 18+ or the browser
   export AW_KEY="aw_test_demo_replaceme"

   Python

   pip install astroway   # or without an SDK: requests or httpx
   export AW_KEY="aw_test_demo_replaceme"

   PHP

   composer require astroway/sdk
   # or without an SDK: guzzlehttp/guzzle + raw HTTP

   MCP

   # For AI agents - Claude Desktop, Cursor IDE, Windsurf,
   # VS Code (llm CLI), GPT with MCP via the OpenAI Realtime API,
   # or any MCP-compatible client:
   npx -y @astroway/mcp   # 700+ tools, OpenAPI auto-sync

3. Fai la prima richiesta

   Calcolo della carta natale per il 24 agosto 1991, 16:30 EEST, Kyiv:

   cURL

   first-request.sh

   curl -X POST https://api.astroway.info/v1/chart \
     -H "X-Api-Key: $AW_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "date": "1991-08-24",
       "time": "16:30:00",
       "timezoneOffset": 3,
       "latitude": 50.4501,
       "longitude": 30.5234,
       "houseSystem": "P"
     }'

   TypeScript

   first-request.ts

   // native fetch - Node 18+ / Bun / Deno / browser. With the SDK: npm install @astroway/sdk
   const r = await fetch('https://api.astroway.info/v1/chart', {
     method: 'POST',
     headers: {
       'X-Api-Key': process.env.AW_KEY!,
       'Content-Type': 'application/json',
     },
     body: JSON.stringify({
       date: '1991-08-24',
       time: '16:30:00',
       timezoneOffset: 3,
       latitude: 50.4501,
       longitude: 30.5234,
       houseSystem: 'P',
     }),
   });
   
   const { data: chart } = await r.json();
   console.log(chart.planets[0]); // { id: 0, name: 'Sun', longitude: 151.12, ... }

   Python

   first_request.py

   # requests or httpx. With the SDK: pip install astroway
   import os, requests
   
   r = requests.post(
       'https://api.astroway.info/v1/chart',
       headers={'X-Api-Key': os.environ['AW_KEY']},
       json={
           'date': '1991-08-24',
           'time': '16:30:00',
           'timezoneOffset': 3,
           'latitude': 50.4501,
           'longitude': 30.5234,
           'houseSystem': 'P',
       },
   )
   chart = r.json()['data']
   print(chart['planets'][0])

   PHP

   first-request.php

   <?php
   use GuzzleHttp\Client;
   
   $aw = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
   $r = $aw->post('chart', [
       'headers' => ['X-Api-Key' => getenv('AW_KEY')],
       'json' => [
           'date' => '1991-08-24',
           'time' => '16:30:00',
           'timezoneOffset' => 3,
           'latitude' => 50.4501,
           'longitude' => 30.5234,
           'houseSystem' => 'P',
       ],
   ]);
   
   $chart = json_decode($r->getBody(), true)['data'];
   print_r($chart['planets'][0]);

   timezoneOffset è lo scostamento, in ore, che gli orologi avevano in quella data. Se non lo conosci, invia invece "timezone": "Europe/Kyiv" oppure "timezone": "auto" per ricavare il fuso dalle coordinate, e il server calcolerà lo scostamento da solo, ora legale compresa: formati dei campi.

4. Analizza la risposta

   Ogni risposta è un JSON con pianeti, case, aspetti e un blocco meta (cache hit, crediti, versione del motore).

   JSON

   response.json

   {
     "ok": true,
     "data": {
       "julianDay": 2448493.0625,
       "planets": [
         { "id": 0, "name": "Sun", "longitude": 150.894819, "latitude": 0.00019, "isRetrograde": false, "declination": 11.15726 },
         { "id": 1, "name": "Moon", "longitude": 321.634655, "latitude": 2.834053, "isRetrograde": false, "declination": -11.609723 }
       ],
       "houses": {
         "system": "P",
         "cusps": [264.384681, 306.997683, 353.867426],
         "ascendant": 264.384681,
         "mc": 207.315669
       },
       "aspects": [
         {
           "planet1": "Sun",
           "planet2": "Moon",
           "type": { "name": "Opposition", "angle": 180, "isMajor": true },
           "exactAngle": 170.739837,
           "orb": 9.260163,
           "isApplying": true
         }
       ],
       "chartSect": "diurnal",
       "meta": { "engineVersion": "2.10.03", "calculatedAt": "2026-08-22T20:53:31.431Z" }
     }
   }

   HTTP Headers

   HTTP/2 200
   content-type: application/json
   x-credits-used: 20
   x-credits-remaining: 9980
   x-credits-limit: 10000
   x-credits-reset: 2026-09-01T00:00:00.000Z
   x-ratelimit-limit: 10
   x-ratelimit-remaining: 9
   x-ratelimit-reset: 1787432304
   x-request-id: 8aec43e9bc749b37e998a489bbad1757
   x-cache: MISS

5. Controlla il saldo

   La dashboard mostra l’utilizzo in tempo reale: api.astroway.info/dashboard. Oppure tramite API:

   curl https://api.astroway.info/v1/keys/usage \
     -H "X-Api-Key: $AW_KEY"

Autenticazione

L’API AstroWay autentica le richieste tramite l’header X-Api-Key. Token Bearer e chiavi nella query string non sono supportati.

curl -H "X-Api-Key: aw_live_..." https://api.astroway.info/v1/health

Tipo di chiave	Prefisso	Comportamento
Production	aw_live_*	Addebita crediti reali dall’account
Sandbox	aw_test_*	Risposta mock deterministica, senza addebito
Restricted (Pro+)	aw_live_* con restrizioni	Limitata a endpoint / IP / RPS specifici

Le chiavi si ruotano senza downtime: la vecchia chiave continua a funzionare per 24 ore dopo la generazione della nuova. Dettagli: /authentication/.

Errori

Tutti gli errori vengono restituiti nel formato ok: false + oggetto error. Il campo error.code (UPPER_SNAKE_CASE) è stabile per gli script: fai lo switch su di esso, non su message.

error-response.json

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Validation failed: date: Invalid input: expected string, received undefined",
    "details": [
      { "path": "date", "message": "Invalid input: expected string, received undefined" }
    ]
  }
}

I codici più frequenti:

• INVALID_INPUT (400): validazione Zod fallita; details contiene un array di { path, message }
• INVALID_API_KEY (401): la chiave non esiste o è stata revocata
• PLAN_UPGRADE_REQUIRED (402): serve un piano superiore o un pack add-on
• CREDITS_EXHAUSTED (429): budget mensile di crediti esaurito
• RATE_LIMIT (429): RPM superato; viene restituito con l’header Retry-After: <sec>
• internal_calc_error (500): errore delle effemeridi; retry automatico lato SDK

Elenco completo e semantica: /errors/.

Rate limit

Piano	Quota
Free	10 req/min
Indie	30 req/min
Starter	120 req/min
Pro	400 req/min
Business	1 000 req/min
Enterprise	personalizzata

Superamento → 429 con Retry-After (sec). Gli SDK ufficiali hanno di default retry con backoff esponenziale. Dettagli: /rate-limits-credits/.

Prossimi passi

• Autenticazione: best practice, rotazione delle chiavi, modalità sandbox
• Crediti e limiti: tabella dei costi, rate limiting, overage
• Esempi: carta natale: analisi dettagliata di /v1/chart
• Integrazioni pronte su GitHub: bot Discord/Slack, tool OpenAI, Cloudflare, FastAPI sugli SDK ufficiali
• API reference completa: tutti i 771 endpoint con playground