Skip to content
AstroWay/api v2.325.0 · docs
all systems operational

I Ching Reading (Legge text)

POST
/iching/reading
request.sh
curl -X POST https://api.astroway.info/v1/iching/reading \
-H "X-Api-Key: aw_live_..." \
-H "Content-Type: application/json" \
-d '{ "question": "Should I take the new job?" }'

A full reading in Legge’s public-domain translation: the primary hexagram’s judgment, the text of each changing line, the resulting hexagram, and focus, the texts to read for that count of changing lines by Zhu Xi’s rule (none: the judgment; one: that line; two: both, the upper leads; three: both judgments; four: the two unchanged lines of the resulting hexagram; five: its one unchanged line; six: the use of nines or sixes on Qian and Kun, otherwise the resulting judgment). Send your own six coin totals in lines (6, 7, 8, 9 bottom to top), or a seed (the same cast as /iching/throw-coins), or a question that seeds it.

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
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
Media type application/json
object
lines

Six line values, bottom to top: 6 old yin (changing), 7 young yang, 8 young yin, 9 old yang (changing). Send the coins you threw yourself.

Array
seed
Any of:
number
question

Without lines or seed, the question text seeds the cast, as /iching/by-question does.

string
>= 2 characters <= 500 characters
Example
{
"question": "Should I take the new job?"
}

Successful calculation

Media type application/json
object
ok
boolean
data
object
question
string
nullable
seed
number
nullable
method
string
nullable
lines
Array<object>
nullable
object
position
number
nullable
value
number
nullable
yang
boolean
nullable
changing
boolean
nullable
primary
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
changingLines
Array<object>
nullable
object
position
number
nullable
text
string
nullable
resulting
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
focus
object
rule
string
nullable
texts
Array<object>
nullable
object
hexagram
number
nullable
part
string
nullable
text
string
nullable
source
string
nullable
readingRuleSource
string
nullable
Example
{
"ok": true,
"data": {
"question": "Should I take the new job?",
"seed": 2134755292,
"method": "3-coin throw (Yang=3, Yin=2)",
"lines": [
{
"position": 1,
"value": 8,
"yang": false,
"changing": false
}
],
"primary": {
"number": 47,
"name": "Oppression",
"pinyin": "Kun",
"legge": "Khwăn",
"chinese": "䷮",
"lines": [
0,
1,
0,
1,
1,
0
],
"lowerTrigram": 3,
"upperTrigram": 7,
"judgment": "In (the condition denoted by) Khwăn there may (yet be) progress and success. For the firm and correct, the (really) great man, there will be good fortune. He will fall into no error. If he make speeches, his words cannot be made good."
},
"changingLines": [
{
"position": 3,
"text": "The third line, divided, shows its subject straitened before a (frowning) rock. He lays hold of thorns. He enters his palace, and does not see his wife. There will be evil."
}
],
"resulting": {
"number": 28,
"name": "Preponderance of the Great",
"pinyin": "Da Guo",
"legge": "Tâ Kwo",
"chinese": "䷛",
"lines": [
0,
1,
1,
1,
1,
0
],
"lowerTrigram": 5,
"upperTrigram": 7,
"judgment": "Tâ Kwo suggests to us a beam that is weak. There will be advantage in moving (under its conditions) in any direction whatever; there will be success."
},
"focus": {
"rule": "One changing line: read that line.",
"texts": [
{
"hexagram": 47,
"part": "line 3",
"text": "The third line, divided, shows its subject straitened before a (frowning) rock. He lays hold of thorns. He enters his palace, and does not see his wife. There will be evil."
}
]
},
"source": "James Legge, The Yi King, Sacred Books of the East vol. XVI (1882; 2nd ed. 1899), public domain: the Text (judgments and line statements)",
"readingRuleSource": "Zhu Xi, Yixue Qimeng (1186), ch. 4, on reading changing lines"
}
}

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

Missing or invalid API key

Media type application/json
Example
{
"ok": false,
"error": {
"code": "INVALID_API_KEY",
"message": "Invalid API key"
}
}