Compatibility Horoscope

POST

/horoscope/compatibility

request.sh

curl -X POST https://api.astroway.info/v1/horoscope/compatibility \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "sign1": "aries", "sign2": "leo" }'

▸ Спробувати POST /horoscope/compatibility

• Production

Generate a relationship horoscope based on synastry between two charts: strengths, friction points, and themes for the next 30 days.

Authorizations

• ApiKeyAuth

Parameters

Header Parameters

Accept-Language

string

Allowed values: uk en de ru pl es pt fr it nl cs ro hu el tr ar hi ja ko vi id

Target language for response text fields. RFC 7231 q-weighted. Falls back to ?lang= query param, then body.language, then source uk. Unknown codes silently fall through to uk.

Example

de

X-Provider

string

Allowed values: openai anthropic google groq mistral openrouter deepseek together

Bring your own model key: the LLM provider that should run this completion. Send together with X-Provider-Key or the request is refused: a key with no provider bills us for tokens you meant to pay for, and a provider with no key would look like it worked. The endpoint is fixed per provider on our side and is never taken from the request. There is no fallback to our own chain: if your key fails you get the provider’s status and message.

Example

anthropic

X-Provider-Key

string

Your own credential for X-Provider. Never logged, stored or cached: it travels in a header because the request body is hashed into two cache keys, and a BYOK turn bypasses both caches in each direction. A provider error that quotes the key back is redacted before it reaches our logs or your response. Such a turn costs 5 credits instead of the endpoint price, and only when a completion actually ran on your key.

Example

sk-ant-...

X-Provider-Model

string

<= 120 characters

Optional model id, overriding the default for that provider. Defaults: openai → gpt-4o-mini, anthropic → claude-sonnet-4-5, google → gemini-2.5-flash, groq → openai/gpt-oss-120b, mistral → mistral-large-latest, openrouter → meta-llama/llama-3.3-70b-instruct, deepseek → deepseek-chat, together → meta-llama/Llama-3.3-70B-Instruct-Turbo.

Example

claude-sonnet-4-5

Query Parameters

lang

string

Allowed values: uk en de ru pl es pt fr it nl cs ro hu el tr ar hi ja ko vi id

Alternative to Accept-Language for clients without header control.

Example

hi

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

Request Body ^required

Media type application/json

object

sign1 required

string

Allowed values: aries taurus gemini cancer leo virgo libra scorpio sagittarius capricorn aquarius pisces

sign2 required

string

Allowed values: aries taurus gemini cancer leo virgo libra scorpio sagittarius capricorn aquarius pisces

language

string

Allowed values: uk en de pl es pt fr it nl cs ro hu el tr ar hi ja ko vi id ru

disclaimer_inline

boolean

Example

{
  "sign1": "aries",
  "sign2": "leo"
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

score

number

nullable

language

string

nullable

summary

string

nullable

strengths

Array<string>

nullable

challenges

Array<string>

nullable

Example

{
  "ok": true,
  "data": {
    "score": 72,
    "language": "uk",
    "summary": "Сильна емоційна резонансність, але…",
    "strengths": [
      "Sun-Moon trine",
      "Venus-Mars sextile"
    ],
    "challenges": [
      "Saturn-Mars square"
    ]
  }
}

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