Cyclic Index

POST

/cyclic-index

request.sh

curl -X POST https://api.astroway.info/v1/cyclic-index \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "startYear": 2020, "endYear": 2030 }'

▸ Try it POST /cyclic-index

• Production

Calculate the André Barbault Cyclic Index, sum of all outer planet separations, for a date range to indicate global crisis periods.

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

startYear required

number

nullable

endYear required

number

nullable

pairs

nullable

Example

{
  "startYear": 2020,
  "endYear": 2030
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

startYear

number

nullable

endYear

number

nullable

count

number

nullable

data

Array<object>

nullable

object

jd

number

nullable

year

number

nullable

total

number

nullable

pairs

object

Jupiter-Saturn

number

nullable

Jupiter-Uranus

number

nullable

Jupiter-Neptune

number

nullable

Jupiter-Pluto

number

nullable

Saturn-Uranus

number

nullable

Saturn-Neptune

number

nullable

Saturn-Pluto

number

nullable

Uranus-Neptune

number

nullable

Uranus-Pluto

number

nullable

Neptune-Pluto

number

nullable

Example

{
  "ok": true,
  "data": {
    "startYear": 2020,
    "endYear": 2030,
    "count": 11,
    "data": [
      {
        "jd": 2458850,
        "year": 2020,
        "total": 573.26,
        "pairs": {
          "Jupiter-Saturn": 14.67,
          "Jupiter-Uranus": 115.9,
          "Jupiter-Neptune": 69.49,
          "Jupiter-Pluto": 15.62,
          "Saturn-Uranus": 101.24,
          "Saturn-Neptune": 54.82,
          "Saturn-Pluto": 0.95,
          "Uranus-Neptune": 46.42,
          "Uranus-Pluto": 100.29,
          "Neptune-Pluto": 53.87
        }
      }
    ]
  }
}

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