Planet Ingresses

POST

/ingresses

request.sh

curl -X POST https://api.astroway.info/v1/ingresses \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "planetId": 5, "startDate": "2024-01-01", "endDate": "2025-12-31" }'

▸ Try it POST /ingresses

• Production

Find all sign ingresses for a planet within a date range (including retrograde re-entries).

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

planetId required

number

nullable

startDate required

string

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

endDate required

string

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

Example

{
  "planetId": 5,
  "startDate": "2024-01-01",
  "endDate": "2025-12-31"
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

ingresses

Array<object>

nullable

object

jd

number

nullable

date

string

nullable

signIndex

number

nullable

signI18nKey

string

nullable

signSymbol

string

nullable

longitude

number

nullable

isRetrograde

boolean

nullable

planetId

number

nullable

Example

{
  "ok": true,
  "data": {
    "ingresses": [
      {
        "jd": 2460456.4687805176,
        "date": "2024-05-25T23:15:03.000Z",
        "signIndex": 2,
        "signI18nKey": "sign_gemini",
        "signSymbol": "♊",
        "longitude": 60.000034547003246,
        "isRetrograde": false,
        "planetId": 5
      }
    ]
  }
}

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