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

Vastu overlay SVG

POST
/render/vastu
request.sh
curl -X POST https://api.astroway.info/v1/render/vastu \
-H "X-Api-Key: aw_live_..." \
-H "Content-Type: application/json" \
-d '{ "coords": { "system": "image", "width": 1200, "height": 800 }, "northAngle": 0, "boundary": [ [ 100, 100 ], [ 1100, 100 ], [ 1100, 700 ], [ 100, 700 ] ], "rooms": [ { "type": "kitchen", "point": [ 1000, 650 ] } ], "options": { "layer": "zones" } }'

The /vastu/plan input drawn as an SVG in the plan’s own coordinates on a transparent background, to lay straight over the floor-plan image: the 81-cell mandala with its deities, or the 16 zones, or the 8 directions as rays from the centre the school reads from, rooms coloured by verdict, the door with its pada, and a north arrow. options.format: "svg" returns the image itself.

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
object
coords required
object
system required
string
Allowed values: image metric
width
number
height
number
normalized
boolean
units
string
Allowed values: m ft
northAngle required
number
>= -360 <= 360
northReference
string
Allowed values: true magnetic
declination
number
>= -90 <= 90
boundary required
Array<Array<number>>
>= 3 items <= 500 items
rooms
Array<object>
<= 60 items
object
type required
string
>= 1 characters <= 40 characters
label
string
<= 60 characters
point
Array<number>
>= 2 items <= 2 items
polygon
Array<Array<number>>
>= 3 items <= 200 items
items
Array<object>
<= 60 items
object
type required
string
>= 1 characters <= 40 characters
label
string
<= 60 characters
point
Array<number>
>= 2 items <= 2 items
polygon
Array<Array<number>>
>= 3 items <= 200 items
entrance
Array<number>
>= 2 items <= 2 items
entranceMethod
string
Allowed values: eight-per-side mandala-cells
facing
string
Allowed values: E S W N
school
string
Allowed values: brihat-samhita mayamata sixteen-zone
scoreVersion
Any of:
number
Allowed values: 1
options
object
layer
string
Allowed values: mandala zones directions
labels
boolean
width
integer
>= 200 <= 4000
format
string
Allowed values: json svg
Example
{
"coords": {
"system": "image",
"width": 1200,
"height": 800
},
"northAngle": 0,
"boundary": [
[
100,
100
],
[
1100,
100
],
[
1100,
700
],
[
100,
700
]
],
"rooms": [
{
"type": "kitchen",
"point": [
1000,
650
]
}
],
"options": {
"layer": "zones"
}
}

Successful calculation

Media type application/json
object
ok
boolean
data
object
svg
string
nullable
layer
string
nullable
school
string
nullable
from
string
nullable
language
string
nullable
warnings
Array
nullable
Example
{
"ok": true,
"data": {
"svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"800\" height=\"533\" viewBox=\"0 0 1200 800\" ...>...</svg>",
"layer": "zones",
"school": "brihat-samhita",
"from": "grid",
"language": "en",
"warnings": []
}
}

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