Reports

Generate Report: Unified Dispatcher (V2)

Changed on

Single endpoint over the 12 type-specific renderers: pass report_type ("natal" | "transit-yearly" | "synastry" | "business" | "career" | "love" | "money" | "child" | "lal-kitab" | "human-design" | "tarot" | "vedic-kundli") plus the renderer-specific inputs. SDK ergonomics: one method instead of 12. Required fields vary by type: chart for most, chart1+chart2 for synastry, seed for tarot (chart optional).

post/reports/generate

Request

  • Base URL: https://api.astroway.info/v1
  • URL: https://api.astroway.info/v1/reports/generate
  • Auth: API key in header X-Api-Key

Query parameters

retain_daysinteger

How many days the PDF stays at its url. 1 by default; up to 90 for a link you hand to a client. Delete it sooner with DELETE /v1/reports/files/{filename}.

format'pdf' | 'html'

html returns the rendered report as text/html instead of storing a PDF; nothing is kept.

fieldsstring

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.

precisioninteger

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.

Request body

report_type'natal' | 'transit-yearly' | 'synastry' | 'business' | 'career' | 'love' | 'money' | 'child' | 'lal-kitab' | 'human-design' | 'tarot' | 'vedic-kundli' required
yearinteger
spreadstring
seedinteger nullable
namestring
allowReversedboolean
language'uk' | 'en' | 'de' | 'ru' | 'pl' | 'es' | 'pt' | 'hi' | 'fr' | 'ko' | 'it' | 'ja' | 'id' | 'tr' | 'nl' | 'ro' | 'cs' | 'vi' | 'ar' | 'el' | 'hu'
depth'standard' | 'extended'

extended (10000 credits) adds the chart wheel and a chapter for each of Sun to Pluto, Chiron and the Ascendant in its sign, from edited texts with no AI at request time. Available in the 20 languages of /v1/natal-texts.

Example request

{
  "chart": {
    "timezone": "Europe/Kyiv"
  },
  "chart1": {
    "timezone": "Europe/Kyiv"
  },
  "chart2": {
    "timezone": "Europe/Kyiv"
  }
}

Response

Successful calculation

okboolean

Example response

{
  "ok": true
}

Changes