Natal texts (static)

GET

/natal-texts

curl -X GET https://api.astroway.info/v1/natal-texts?keys=sun.aries,moon.h4,sun_moon.trine&lang=en \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json"

const res = await fetch('https://api.astroway.info/v1/natal-texts?keys=sun.aries,moon.h4,sun_moon.trine&lang=en', {
  method: 'GET',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
});
const { ok, data, error } = await res.json();
if (!ok) throw new Error(error.message);
console.log(data);

import os, requests

r = requests.get(
    'https://api.astroway.info/v1/natal-texts?keys=sun.aries,moon.h4,sun_moon.trine&lang=en',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

<?php
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
$r = $client->get('natal-texts?keys=sun.aries,moon.h4,sun_moon.trine&lang=en', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

Edited interpretation texts for a chart, no AI at request time. keys is a comma list of up to 64: sun.aries (planet in sign, also chiron, ascendant), moon.h4 (planet in house), sun_moon.trine (major aspect between two of Sun..Pluto). lang is required; a text that does not exist in that language is listed in missing, never replaced by another language. Planet in sign covers 20 languages; houses and aspects are being written. Plain text, paragraphs separated by a blank line.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

keys required

string

Example

sun.aries,moon.h4,sun_moon.trine

Comma list of up to 64 distinct keys: <body>.<sign> (planet in sign, also chiron, ascendant, north_node, south_node, lilith), <body>.h<1-12> (planet in house, also chiron, lilith), <body>_<body>.<aspect> (conjunction, sextile, square, trine, opposition between two of Sun..Pluto), pattern.<name> (t_square, grand_trine, grand_cross, stellium, yod, kite; kind pattern, a general text for the figure, the planets are yours to list). Nodes, Lilith in sign and patterns are written in every language listed for lang.

lang required

string

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

Example

en

Language of the texts. No fallback: a text missing in this language is listed in missing.

fields

string

Comma-separated dotted paths, relative to data, to keep in the response. A path is applied to every element of an array, so planets.name means the name of each planet. Paths that match nothing come back in _fields_unmatched; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer.

Example

planets.name,planets.longitude

precision

integer

<= 15

Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute.

Example

Responses

200

Successful calculation

application/json

object

boolean

data

object

lang

string

nullable

texts

object

sun.aries

object

title

string

nullable

body

string

nullable

kind

string

nullable

missing

Array<string>

nullable

Example

{
  "ok": true,
  "data": {
    "lang": "en",
    "texts": {
      "sun.aries": {
        "title": "Sun in Aries",
        "body": "Sun in Aries is will in its purest form, still hot as metal fresh from the furnace. …",
        "kind": "planet_in_sign"
      }
    },
    "missing": [
      "moon.h4"
    ]
  }
}

400

Validation error

application/json

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

application/json

Example

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