Hexagram Compatibility

POST

/iching/compatibility

request.sh

curl -X POST https://api.astroway.info/v1/iching/compatibility \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "hexagramA": 11, "hexagramB": 12 }'

▸ Try it POST /iching/compatibility

• Production

Compares two hexagrams: matching and differing lines, named relations (identical, complement, inverse, nuclear, shared or swapped trigrams), five-phase relations of the lower and of the upper trigrams, and a 0-100 score whose formula is stated in the response (a convention of this API, not a classical measure).

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

hexagramA required

King Wen number of the first hexagram.

integer

>= 1 <= 64

hexagramB required

King Wen number of the second hexagram.

integer

>= 1 <= 64

Example

{
  "hexagramA": 11,
  "hexagramB": 12
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

a

object

number

number

nullable

name

string

nullable

pinyin

string

nullable

legge

string

nullable

chinese

string

nullable

lines

Array<number>

nullable

lowerTrigram

number

nullable

upperTrigram

number

nullable

judgment

string

nullable

b

object

number

number

nullable

name

string

nullable

pinyin

string

nullable

legge

string

nullable

chinese

string

nullable

lines

Array<number>

nullable

lowerTrigram

number

nullable

upperTrigram

number

nullable

judgment

string

nullable

matchingLines

number

nullable

differingLines

Array<number>

nullable

relations

Array<string>

nullable

phases

object

lower

object

a

string

nullable

b

string

nullable

relation

string

nullable

upper

object

a

string

nullable

b

string

nullable

relation

string

nullable

score

number

nullable

scoreRule

string

nullable

source

string

nullable

Example

{
  "ok": true,
  "data": {
    "a": {
      "number": 11,
      "name": "Peace",
      "pinyin": "Tai",
      "legge": "Thâi",
      "chinese": "䷊",
      "lines": [
        1,
        1,
        1,
        0,
        0,
        0
      ],
      "lowerTrigram": 0,
      "upperTrigram": 1,
      "judgment": "In Thâi (we see) the little gone and the great come. (It indicates that) there will be good fortune, with progress and success."
    },
    "b": {
      "number": 12,
      "name": "Standstill",
      "pinyin": "Pi",
      "legge": "Phî",
      "chinese": "䷋",
      "lines": [
        0,
        0,
        0,
        1,
        1,
        1
      ],
      "lowerTrigram": 1,
      "upperTrigram": 0,
      "judgment": "In Phî there is the want of good understanding between the (different classes of) men, and its indication is unfavourable to the firm and correct course of the superior man. We see in it the great gone and the little come."
    },
    "matchingLines": 0,
    "differingLines": [
      1,
      2,
      3,
      4,
      5,
      6
    ],
    "relations": [
      "complement",
      "inverse",
      "trigrams swapped"
    ],
    "phases": {
      "lower": {
        "a": "metal",
        "b": "earth",
        "relation": "generated-by"
      },
      "upper": {
        "a": "earth",
        "b": "metal",
        "relation": "generates"
      }
    },
    "score": 45,
    "scoreRule": "A convention of this API, not a classical measure: 40 x matching lines / 6, plus 30 for each pair of trigrams (lower with lower, upper with upper) scaled by their phases: same 1, one generates the other 0.75, one controls the other 0.25.",
    "source": "Shuo Gua ch. 4-11 (Legge, Sacred Books of the East vol. XVI, Appendix V, 1882, public domain) for image, attribute, family, animal and body part; Fu Xi (Earlier Heaven) and King Wen (Later Heaven) arrangements for numbers and directions; Han-era five-phase correspondence."
  }
}

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