Início rápido

Cinco minutos desde o registo até um mapa natal completo em JSON. Cobre a instalação do SDK, o primeiro pedido, os cabeçalhos da resposta, a autenticação e o tratamento de erros.

// início rápido

Obtém uma chave API em 60 segundos

10 000 créditos/mês para sempre grátis. Sem cartão.

1. 01
   Regista-te

   Email + password. Uma conta para todos os produtos AstroWay.
2. 02
   Cria a chave

   No dashboard, clica em 'Criar chave'. aw_live_ ou aw_test_ (sandbox).
3. 03
   Faz o pedido

   POST /v1/chart com header X-Api-Key. Mapa natal completo em JSON.

Registar - grátis→Início rápido

1. Gera uma chave de API

   Entra no dashboard e clica em Generate key. O plano gratuito dá 10 000 créditos/mês para sempre - sem introduzir cartão. As chaves começam por:

   • aw_live_*: produção, cobranças reais
   • aw_test_*: sandbox, sem gasto de créditos, resposta determinística

   Cuidado

   A chave é um segredo. Não a faças commit no git, não a coloques em código de frontend. Para o frontend usa um backend proxy ou tokens de sessão de curta duração (Phase 3).

2. Instala o SDK

   A API é REST + JSON normal, por isso o SDK não é obrigatório. Mas os três já estão publicados: TypeScript (@astroway/sdk), Python (astroway) e PHP (astroway/sdk), mais o servidor MCP (@astroway/mcp) para agentes de IA.

   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. Faz o primeiro pedido

   Cálculo do mapa natal para 24 de agosto de 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 é o desvio que os relógios tinham nessa data, em horas. Se não o souberes, envia em vez disso "timezone": "Europe/Kyiv" ou "timezone": "auto", para obter a zona a partir das coordenadas, e o servidor calcula o desvio sozinho, incluindo a hora de verão: formatos dos campos.

4. Analisa a resposta

   Cada resposta é um JSON com planetas, casas, aspetos e um bloco meta (cache hit, créditos, versão do motor).

   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. Verifica o saldo

   O dashboard mostra o uso em tempo real: api.astroway.info/dashboard. Ou através da API:

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

Autenticação

A AstroWay API autentica os pedidos através do cabeçalho X-Api-Key. Tokens Bearer e chaves na query string não são suportados.

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

Tipo de chave	Prefixo	Comportamento
Production	aw_live_*	Cobra créditos reais da conta
Sandbox	aw_test_*	Resposta simulada determinística, sem cobrança
Restricted (Pro+)	aw_live_* com restrição	Limitada a endpoints / IP / RPS concretos

As chaves rodam sem downtime - a chave antiga continua a funcionar durante 24 horas depois de gerada a nova. Detalhes: /authentication/.

Erros

Todos os erros são devolvidos no formato ok: false + objeto error. O campo error.code (UPPER_SNAKE_CASE) é estável para scripts - faz o switch por ele, não por 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" }
    ]
  }
}

Os códigos mais frequentes:

• INVALID_INPUT (400): validação Zod falhada; details contém um array { path, message }
• INVALID_API_KEY (401): a chave não existe ou foi revogada
• PLAN_UPGRADE_REQUIRED (402): é preciso um plano superior ou um pack add-on
• CREDITS_EXHAUSTED (429): o orçamento mensal de créditos está esgotado
• RATE_LIMIT (429): RPM excedido; devolvido com o cabeçalho Retry-After: <sec>
• internal_calc_error (500): erro das efemérides; retry automático do lado do SDK

Lista completa e semântica: /errors/.

Limites de pedidos

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

Excesso → 429 com Retry-After (sec). Os SDK oficiais fazem retries com backoff exponencial por omissão. Detalhes: /rate-limits-credits/.

A seguir

• Autenticação: boas práticas, rotação de chaves, modo sandbox
• Créditos e limites: tabela de custos, rate limiting, overage
• Exemplos: mapa natal: análise detalhada de /v1/chart
• Integrações prontas no GitHub: bots para Discord/Slack, OpenAI tools, Cloudflare, FastAPI com os SDK oficiais
• Referência completa da API: todos os 771 endpoints com playground