Generate Natal Report (PDF or HTML)

POST

/reports/natal

request.sh

curl -X POST https://api.astroway.info/v1/reports/natal \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "chart": { "date": "1990-05-15", "time": "14:30:00", "timezoneOffset": 3, "latitude": 50.45, "longitude": 30.52 }, "language": "uk", "whitelabel": false }'

▸ Спробувати POST /reports/natal

• Production

Render a Western tropical natal chart as a single-page A4 PDF (default) or live HTML (add ?format=html). Includes Big Three (Sun/Moon/ASC), full planets table with houses + retrograde, all 12 house cusps, and major aspects. Set whitelabel: true to apply the caller’s branding overrides. Languages: uk (default) or en. PDF URLs valid 24h via auto-cleanup cron; HTML mode streams directly without storage.

Authorizations

• ApiKeyAuth

Request Body ^required

Media type application/json

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

nullable

language

string

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

whitelabel

Any of:

boolean

boolean

object

object

companyName

string

>= 1 characters <= 80 characters

companyUrl

string format: uri

companyEmail

string format: email

companyMobile

string

<= 40 characters

companyBio

string

<= 500 characters

logoUrl

string format: uri

frontImage

string format: uri

textPrimaryColor

string

/^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/

textSecondaryColor

string

/^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/

backgroundColor

string

/^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/

themeColor

Accent colour — used for section heading text and inline emphasis.

string

/^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/

headingColor

Colour of the divider rule under each section heading (not the heading text — that is themeColor).

string

/^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/

footerText

string

<= 200 characters

fontPairing

string

Allowed values: serif-sans sans-serif serif-only sans-only system

reportName

string

>= 1 characters <= 80 characters

enrich

boolean

tone

string

Allowed values: warm professional concise

length

string

Allowed values: short medium long

Example

{
  "chart": {
    "date": "1990-05-15",
    "time": "14:30:00",
    "timezoneOffset": 3,
    "latitude": 50.45,
    "longitude": 30.52
  },
  "language": "uk",
  "whitelabel": false
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

url

string

nullable

storage_key

string

nullable

byte_length

number

nullable

page_count

number

nullable

duration_ms

number

nullable

expires_at

string

nullable

Example

{
  "ok": true,
  "data": {
    "url": "https://api.astroway.info/reports/abc-natal.pdf",
    "storage_key": "reports/abc-natal.pdf",
    "byte_length": 124350,
    "page_count": 1,
    "duration_ms": 3210,
    "expires_at": "2026-05-09T07:00:00Z"
  }
}

400

Validation error

Media type 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

Media type application/json

Example

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