Aspect Bars (Gantt)

POST

/aspect-bar

request.sh

curl -X POST https://api.astroway.info/v1/aspect-bar \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "startDate": "2024-01-01", "endDate": "2024-06-30", "stepDays": 1, "visiblePlanetIds": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ] }'

▸ Try it POST /aspect-bar

• Production

Transform aspect timelines into Gantt-style bars grouped by transit planet. Each bar shows the duration an aspect is in orb, with exact dates marked. Useful for visual transit calendars.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

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

Request Body ^required

Media type application/json

object

startDate required

string

/^\d{4}-\d{2}-\d{2}$/

endDate required

string

/^\d{4}-\d{2}-\d{2}$/

stepDays

number

>= 0.041666666666666664 <= 365

planet1Ids

Array<integer>

<= 32 items

planet2Ids

Array<integer>

<= 32 items

aspectAngles

Array<number>

<= 64 items

maxOrb

number

>= 1e-9 <= 30

visiblePlanetIds

Array<integer>

<= 32 items

Example

{
  "startDate": "2024-01-01",
  "endDate": "2024-06-30",
  "stepDays": 1,
  "visiblePlanetIds": [
    0,
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9
  ]
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

rows

number

nullable

bars

object

rows

Array<object>

nullable

object

planetId

number

nullable

bars

Array<object>

nullable

object

transitPlanetId

number

nullable

targetPlanetId

number

nullable

aspect

object

name

string

nullable

i18nKey

string

nullable

angle

number

nullable

orb

number

nullable

symbol

string

nullable

isMajor

boolean

nullable

color

string

nullable

startDate

string

nullable

endDate

string

nullable

startJd

number

nullable

endJd

number

nullable

exactDates

Array<object>

nullable

object

jd

number

nullable

date

string

nullable

nature

string

nullable

lane

number

nullable

maxLanes

number

nullable

timeRange

object

start

string

nullable

end

string

nullable

Example

{
  "ok": true,
  "data": {
    "rows": 9,
    "bars": {
      "rows": [
        {
          "planetId": 0,
          "bars": [
            {
              "transitPlanetId": 0,
              "targetPlanetId": 1,
              "aspect": {
                "name": "Trine",
                "i18nKey": "aspect_trine",
                "angle": 120,
                "orb": 12,
                "symbol": "△",
                "isMajor": true,
                "color": "#3366cc"
              },
              "startDate": "2024-01-01T12:00:00.000Z",
              "endDate": "2024-06-26T12:00:00.000Z",
              "startJd": 2460311,
              "endJd": 2460488,
              "exactDates": [
                {
                  "jd": 2460340.7539681466,
                  "date": "2024-01-31T06:05:43.000Z"
                }
              ],
              "nature": "harmonious",
              "lane": 0
            }
          ],
          "maxLanes": 11
        }
      ],
      "timeRange": {
        "start": "2024-01-01T12:00:00.000Z",
        "end": "2024-06-30T12:00:00.000Z"
      }
    }
  }
}

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