Hexagram Lookup

GET

/iching/lookup/{number}

curl -X GET https://api.astroway.info/v1/iching/lookup/{number} \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json"

const res = await fetch('https://api.astroway.info/v1/iching/lookup/{number}', {
  method: 'GET',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
});
const { ok, data, error } = await res.json();
if (!ok) throw new Error(error.message);
console.log(data);

import os, requests

r = requests.get(
    'https://api.astroway.info/v1/iching/lookup/{number}',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

<?php
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
$r = $client->get('iching/lookup/{number}', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

Fetch hexagram 1-64 by King Wen number.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

number required

integer

>= 1 <= 64

Hexagram number in King Wen order.

Example

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

Responses

200

Successful calculation

application/json

object

boolean

data

object

hexagram

object

number

nullable

name

string

nullable

chinese

string

nullable

trigrams

Array<number>

nullable

lines

Array<object>

nullable

object

value

number

nullable

isYang

boolean

nullable

isChanging

boolean

nullable

upperTrigram

object

name

string

nullable

symbol

string

nullable

lines

Array<number>

nullable

lowerTrigram

object

name

string

nullable

symbol

string

nullable

lines

Array<number>

nullable

source

string

nullable

Example

{
  "ok": true,
  "data": {
    "hexagram": {
      "number": 1,
      "name": "The Creative",
      "chinese": "䷀",
      "trigrams": [
        0
      ],
      "lines": [
        {
          "value": 7,
          "isYang": true,
          "isChanging": false
        }
      ]
    },
    "upperTrigram": {
      "name": "Qian (Heaven)",
      "symbol": "☰",
      "lines": [
        1
      ]
    },
    "lowerTrigram": {
      "name": "Qian (Heaven)",
      "symbol": "☰",
      "lines": [
        1
      ]
    },
    "source": "I Ching ~9th c. BCE; King Wen sequence (PD); Wilhelm-Baynes 1923/1950 names"
  }
}

400

Validation error

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

application/json

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key"
  }
}

Was this helpful?