Biorhythm Compatibility

POST

/wellness/biorhythm/compatibility

request.sh

curl -X POST https://api.astroway.info/v1/wellness/biorhythm/compatibility \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "birthDateA": "1990-06-15", "birthDateB": "1992-03-02" }'

▸ Try it POST /wellness/biorhythm/compatibility

• Production

How closely two people’s 23, 28 and 33-day cycles run together: per cycle the phase offset in days and 50 x (1 + cos(2 pi x offset / period)), and their mean. The offset is set at birth, so the figure never changes. A historical model with no evidential support, returned with that disclaimer.

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

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters /^[\x21-\x7E]+$/

Unique per logical operation, kept across retries. For 24 hours from the first request, a repeat with the same key, method, path, body and query string returns the stored response with Idempotent-Replayed: true and costs 0 credits. The same key with a different body or query string is a 409 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running is a 409 IDEMPOTENCY_IN_PROGRESS. Only 2xx responses are kept. See /idempotency/.

Example

01HXY2A7ZM0ABCDEF

Request Body ^required

Media type application/json

object

birthDateA required

string

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

birthDateB required

string

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

Example

{
  "birthDateA": "1990-06-15",
  "birthDateB": "1992-03-02"
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

birthDateA

string

nullable

birthDateB

string

nullable

daysApart

number

nullable

cycles

Array<object>

nullable

object

name

string

nullable

periodDays

number

nullable

phaseOffsetDays

number

nullable

syncPercent

number

nullable

overallPercent

number

nullable

formula

string

nullable

disclaimer

string

nullable

Example

{
  "ok": true,
  "data": {
    "birthDateA": "1990-06-15",
    "birthDateB": "1992-03-02",
    "daysApart": 626,
    "cycles": [
      {
        "name": "physical",
        "periodDays": 23,
        "phaseOffsetDays": 5,
        "syncPercent": 60
      }
    ],
    "overallPercent": 59,
    "formula": "Per cycle: 50 x (1 + cos(2 pi x offset / period)), where offset is the days between the births modulo the period; 100 means the two curves run together, 0 means one peaks when the other is lowest. Overall is the mean of the three. The offset is fixed at birth, so the figure never changes.",
    "disclaimer": "Biorhythm cycles are a 19th-century numerological construct (Fliess 1897, Swoboda 1904) with no evidential support. Returned for entertainment and for parity with charting tools, not as a prediction."
  }
}

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