Retrograde Periods

POST

/retrograde-periods

request.sh

curl -X POST https://api.astroway.info/v1/retrograde-periods \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "planetIds": [ 2 ], "startDate": "2024-01-01", "endDate": "2024-12-31" }'

▸ Спробувати POST /retrograde-periods

• Production

Retrograde periods of the planets in planetIds (default Mercury) within a date range: the two stations and their longitudes, plus shadowStart (the planet first reaches the longitude of its direct station) and shadowEnd (it regains the longitude of its retrograde station).

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}$/

planetIds

Array<integer>

<= 32 items

Example

{
  "planetIds": [
    2
  ],
  "startDate": "2024-01-01",
  "endDate": "2024-12-31"
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

periods

Array<object>

nullable

object

planetId

number

nullable

planetName

string

nullable

retroStart

string

nullable

retroEnd

string

nullable

stationRetroLong

number

nullable

stationDirectLong

number

nullable

shadowStart

string

nullable

shadowEnd

string

nullable

Example

{
  "ok": true,
  "data": {
    "periods": [
      {
        "planetId": 2,
        "planetName": "Mercury",
        "retroStart": "2024-04-01T22:14:30Z",
        "retroEnd": "2024-04-25T12:54:07Z",
        "stationRetroLong": 27.218618740069505,
        "stationDirectLong": 15.981207506060022,
        "shadowStart": "2024-03-19T03:39:08Z",
        "shadowEnd": "2024-05-13T09:01:24Z"
      }
    ]
  }
}

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