Algol Minimum

POST

/algol-minimum

request.sh

curl -X POST https://api.astroway.info/v1/algol-minimum \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "startDate": "2024-06-01", "endDate": "2024-06-30" }'

• Production

Find the nearest minimum brightness moment of Algol (Beta Persei) — the eclipsing variable star — within a date range.

Authorizations

• ApiKeyAuth

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

longitude

number

nullable

Example

{
  "startDate": "2024-06-01",
  "endDate": "2024-06-30"
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

minima

Array<object>

object

date

string

time

string

jd

number

period

string

Example

{
  "ok": true
}

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