Ephemeris Range

POST

/ephemeris

request.sh

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

▸ Спробувати POST /ephemeris

• Production

Return planet positions for a date range with configurable step (min 0.01 days). Max range: 1 year for sub-day steps, 5 years otherwise. Optionally filter by planetIds.

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

nullable

planetIds

Array<integer>

<= 32 items

Example

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

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

ephemeris

Array<object>

nullable

object

jd

number

nullable

date

string

nullable

positions

Array<object>

nullable

object

planetId

number

nullable

longitude

number

nullable

isRetrograde

boolean

nullable

Example

{
  "ok": true,
  "data": {
    "ephemeris": [
      {
        "jd": 2460311,
        "date": "2024-01-01T12:00:00.000Z",
        "positions": [
          {
            "planetId": 0,
            "longitude": 280.5484942560719,
            "isRetrograde": false
          }
        ]
      }
    ]
  }
}

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