Skip to content
AstroWay/api v2.325.0 · docs
all systems operational

Vedic Wheel: South Indian (SVG)

POST
/render/wheel-vedic-south
request.sh
curl -X POST https://api.astroway.info/v1/render/wheel-vedic-south \
-H "X-Api-Key: aw_live_..." \
-H "Content-Type: application/json" \
-d '{ "date": "1990-05-15", "time": "15:30:00", "timezone": "Europe/Kyiv", "latitude": 50.45, "longitude": 30.52 }'

South Indian 4×4 grid layout (Pisces top-left, signs fixed). House numbers placed where lagna sign falls.

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
4
Idempotency-Key
string
>= 1 characters <= 255 characters /^[\x21-\x7E]+$/

Unique per logical operation, kept across retries. For 24 hours from the first request, a repeat with the same key, method, path, body and query string returns the stored response with Idempotent-Replayed: true and costs 0 credits. The same key with a different body or query string is a 409 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running is a 409 IDEMPOTENCY_IN_PROGRESS. Only 2xx responses are kept. See /idempotency/.

Example
01HXY2A7ZM0ABCDEF
Media type application/json

Birth data for a single natal chart. Required: date (YYYY-MM-DD), time (HH:mm:ss), latitude and longitude in decimal degrees. The short forms lat, lon, lng and tz are rejected with 400 INVALID_FIELD; pass the full names. timezoneOffset is hours from UTC and defaults to 0, meaning UTC; send timezone instead (an IANA name such as Europe/Kyiv, or auto) and the offset for that date is worked out, summer time included. city is a display label only: nothing here geocodes it, so it never stands in for coordinates. houseSystem is a single house-system letter, P by default; a name such as “Placidus” is refused, and the case matters because I and i are two different Sunshine systems.

object
date required
string
/^\d{4}-\d{2}-\d{2}$/
time required
string
/^\d{2}:\d{2}(:\d{2})?$/
timezoneOffset

Hours from UTC at the given moment, not minutes. Fractional zones are hours too: 5.5 for India, 5.75 for Nepal, -3.5 for Newfoundland. Defaults to 0, meaning UTC. Ignored when timezone is sent.

number
0 nullable >= -14 <= 14
timezone

IANA zone name such as Europe/Kyiv, or auto to look the zone up from latitude and longitude. The server takes the offset that zone kept at this local date and time, summer time included, and uses it in place of timezoneOffset. A clock time that happened twice takes the first occurrence; one skipped when clocks went forward takes the offset from before the change. Abbreviations such as EST are refused. Before 1970 the tz database is not reliable for every place, so send timezoneOffset when the local clock is known.

string
latitude required
number
>= -90 <= 90
longitude required
number
>= -180 <= 180
houseSystem
string
default: P
Allowed values: P K R C E W B M O A T V D F G H I i L N Q S U X Y
name
string
""
city
string
""
zodiacType
string
Allowed values: tropical sidereal
ayanamsaId
number
nullable
ayanamsa

Sidereal school by name. Lahiri when omitted. Equivalent to ayanamsaId; send either.

string
Allowed values: fagan-bradley lahiri de-luce raman krishnamurti kp yukteshwar jn-bhasin true-citra djwhal-khul
cosmogram
boolean
options
object
size
integer
>= 200 <= 2000
theme

Css paints every colour as var(—aw-, ), so the page that inlines the SVG can recolour it with CSS custom properties (—aw-chart-bg, —aw-fg, —aw-muted, —aw-ring, —aw-houses-fill, —aw-benefic, —aw-malefic, —aw-aspect-harmonious, —aw-aspect-tense, —aw-aspect-neutral, —aw-aspect-minor, —aw-aspect-quintile, —aw-moon-shadow, —aw-moon-light, —aw-cycle-physical, —aw-cycle-emotional, —aw-cycle-intellectual). With none set it looks exactly like light. Inside an the variables cannot be set, so it stays light. The Western wheels and the aspect grid then also carry stable aw-* classes, and each planet is a with data-planet and data-label, each aspect line has data-a and data-b; see the @astroway/render changelog for the list.

string
Allowed values: light dark console css
showAspects
boolean
showRetrograde
boolean
title
string
<= 120 characters
format
string
default: json
Allowed values: svg json
bodies
Array<string>
>= 1 items <= 14 items
Allowed values: Sun Moon Mercury Venus Mars Jupiter Saturn Uranus Neptune Pluto North Node South Node Chiron Lilith
labels

Your own words in place of the English the image would otherwise carry: the ASC/DSC/MC/IC axis labels, the SVG and <desc> read by screen readers, and the planet and sign names plus the word for retrograde in each planet’s data-label (theme css). bodies is keyed by the English name, signs lists twelve names from Aries. Nothing is translated for you; absent keys keep the English.

object
asc
string
>= 1 characters <= 40 characters
dsc
string
>= 1 characters <= 40 characters
mc
string
>= 1 characters <= 40 characters
ic
string
>= 1 characters <= 40 characters
title
string
>= 1 characters <= 200 characters
desc
string
>= 1 characters <= 2000 characters
bodies
object
Sun
string
>= 1 characters <= 40 characters
Moon
string
>= 1 characters <= 40 characters
Mercury
string
>= 1 characters <= 40 characters
Venus
string
>= 1 characters <= 40 characters
Mars
string
>= 1 characters <= 40 characters
Jupiter
string
>= 1 characters <= 40 characters
Saturn
string
>= 1 characters <= 40 characters
Uranus
string
>= 1 characters <= 40 characters
Neptune
string
>= 1 characters <= 40 characters
Pluto
string
>= 1 characters <= 40 characters
North Node
string
>= 1 characters <= 40 characters
South Node
string
>= 1 characters <= 40 characters
Chiron
string
>= 1 characters <= 40 characters
Lilith
string
>= 1 characters <= 40 characters
signs
Array<string>
retrograde
string
>= 1 characters <= 40 characters
Example
{
"date": "1990-05-15",
"time": "15:30:00",
"timezone": "Europe/Kyiv",
"latitude": 50.45,
"longitude": 30.52
}

Successful calculation

Media type application/json
object
ok
boolean
data
object
svg
string
nullable
format
string
nullable
byteLength
number
nullable
Example
{
"ok": true,
"data": {
"svg": "<svg ...>",
"format": "svg",
"byteLength": 5845
}
}

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"
}
]
}
}

Missing or invalid API key

Media type application/json
Example
{
"ok": false,
"error": {
"code": "INVALID_API_KEY",
"message": "Invalid API key"
}
}