Explain Transit

POST

/ai/explain-transit

• Production

Explain a current transit hitting your natal chart.

Authorizations

• ApiKeyAuth

Code Samples

cURL

curl -X POST https://api.astroway.info/v1/ai/explain-transit \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "transitPlanet": "Saturn", "natalPlanet": "Sun", "aspect": "conjunction" }'

Node.js

const res = await fetch('https://api.astroway.info/v1/ai/explain-transit', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "transitPlanet": "Saturn",
    "natalPlanet": "Sun",
    "aspect": "conjunction"
  }),
});
const { ok, data, error } = await res.json();
if (!ok) throw new Error(error.message);
console.log(data);

Python

import os, requests

r = requests.post(
    'https://api.astroway.info/v1/ai/explain-transit',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      'transitPlanet': "Saturn",
      'natalPlanet': "Sun",
      'aspect': "conjunction"
    },
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

PHP

<?php
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
$r = $client->post('ai/explain-transit', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
    'json' => [
        'transitPlanet' => 'Saturn',
        'natalPlanet' => 'Sun',
        'aspect' => 'conjunction',
    ],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

Request Body ^required

object

chart

required

Birth data for a single natal chart. Required: date (YYYY-MM-DD), time (HH:mm:ss). Defaults to lat/lon/tz=0 if omitted; pass real values for accurate computation.

object

date

required

string

/^\d{4}-\d{2}-\d{2}$/

time

required

string

/^\d{2}:\d{2}:\d{2}$/

timezoneOffset

number

0 nullable

latitude

number

0 nullable

longitude

number

0 nullable

houseSystem

string

default: P

name

string

""

city

string

""

zodiacType

string

Allowed values: tropical sidereal

ayanamsaId

number

nullable

cosmogram

boolean

key

additional properties

nullable

transitDate

required

string

/^\d{4}-\d{2}-\d{2}$/

transitPlanet

required

string

>= 2 characters <= 40 characters

natalPlanet

required

string

>= 2 characters <= 40 characters

aspectType

required

string

Allowed values: Conjunction Sextile Square Trine Opposition

language

string

default: uk

Allowed values: uk en de ru pl es pt hi fr ko it ja id tr nl ro cs vi ar el hu

Example

{
  "transitPlanet": "Saturn",
  "natalPlanet": "Sun",
  "aspect": "conjunction"
}

Responses

200

Successful calculation

object

ok

boolean

Example

true

data

object

explanation

string

Example

{
  "ok": true,
  "data": {
    "explanation": "..."
  }
}

400

Validation error

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Validation failed: date: Date must be YYYY-MM-DD",
    "details": [
      {
        "path": "date",
        "message": "Date must be YYYY-MM-DD"
      }
    ]
  }
}

401

Missing or invalid API key

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key"
  }
}