Yearly Horoscope

POST

/horoscope/yearly

request.sh

curl -X POST https://api.astroway.info/v1/horoscope/yearly \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "sign": "aries", "language": "uk" }'

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

• Production

Generate a year-ahead horoscope (12-month window) with major transit cycles, solar return chart context, and time-lord (profection) for the year.

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

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

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

sign required

string

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

date

string

/^\d{4}-\d{2}-\d{2}$/

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

style

astro (default) names the planets, houses and aspects behind each point. plain uses everyday words with no astrological terms, and is written once in English and translated, so every language says the same thing. Daily, weekly and monthly.

string

Allowed values: astro plain

length

With style: "plain": short (about 70-110 words a day) or medium (default, about 150-230).

string

Allowed values: short medium

topics

Only these sections, in this order, in sections and in horoscope. Default all six.

Array<string>

>= 1 items <= 6 items

Allowed values: overview love career health finance advice

Example

{
  "sign": "aries",
  "language": "uk"
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

year

number

nullable

language

string

nullable

title

string

nullable

body

string

nullable

profectionLord

string

nullable

solarReturn

object

date

string

nullable

Example

{
  "ok": true,
  "data": {
    "year": 2026,
    "language": "uk",
    "title": "Рік відновлення",
    "body": "...",
    "profectionLord": "Mercury",
    "solarReturn": {
      "date": "2026-05-15T14:32:11Z"
    }
  }
}

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