Crystal Recommendations

POST

/esoteric/crystals/recommend

• Production

Recommend crystals scored against natal sign placements (Sun/Moon/Asc) and intent keywords. Returns top-N matches with score.

Authorizations

• ApiKeyAuth

Code Samples

cURL

curl -X POST https://api.astroway.info/v1/esoteric/crystals/recommend \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "sunSign": "Aries", "moonSign": "Cancer", "intent": "courage", "limit": 5 }'

Node.js

const res = await fetch('https://api.astroway.info/v1/esoteric/crystals/recommend', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "sunSign": "Aries",
    "moonSign": "Cancer",
    "intent": "courage",
    "limit": 5
  }),
});
const { ok, data, error } = await res.json();
if (!ok) throw new Error(error.message);
console.log(data);

Python

import os, requests

r = requests.post(
    'https://api.astroway.info/v1/esoteric/crystals/recommend',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      'sunSign': "Aries",
      'moonSign': "Cancer",
      'intent': "courage",
      'limit': 5
    },
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

PHP

<?php
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
$r = $client->post('esoteric/crystals/recommend', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
    'json' => [
        'sunSign' => 'Aries',
        'moonSign' => 'Cancer',
        'intent' => 'courage',
        'limit' => 5,
    ],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

Request Body ^required

object

Example

{
  "sunSign": "Aries",
  "moonSign": "Cancer",
  "intent": "courage",
  "limit": 5
}

Responses

200

Successful calculation

object

ok

boolean

Example

true

data

object

recommendations

Array<object>

object

name

string

matchScore

number

count

number

criteria

object

signs

Array<string>

intent

string

400

Validation error

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

Example

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