/api/astro/panchang_element_birth_effect/1 кредитВпливи панчанги народження (довідкова таблиця)
Кожна складова панчанги — день тижня, тітхі, карана, йога й пакша, а також планетарна хора — має класичне тлумачення характеру людини, народженої під нею. Цей ендпоінт — довідник цих тлумачень. Це суто довідковий текст: нічого не обчислюється, а дату, час чи місце не надсилають. Тітхі народження, день тижня тощо ви визначаєте окремо (наприклад, через /api/astro/panchanga/) і передаєте назви, щоб отримати відповідний абзац для кожної. Шість ключів довідника — get_vaara_during_birth, get_birth_tithi_effects, get_birth_karana_effects, get_birth_panchang_yoga_effects, get_birth_paksha_effects і get_birth_hora_result; кожен приймає поле запиту з відповідною назвою. Кожне прийнятне значення — транслітерація в нижньому регістрі, і точне написання важливе — 'shula', а не 'shoola', 'priti', а не 'preeti', — а хору називають санскритською назвою планети (surya, chandra, mangala…), а не днем тижня. Шість допоміжних ключів get_all_*_keys повертають списки прийнятних значень, а get_all_keys_summary — усі шість одразу; беріть словник із них, а не прописуйте його в коді вручну. Нерозпізнане значення не спричиняє помилки: повертається HTTP 200 із рядком, що перелічує допустимі варіанти.
https://api.occultapi.com/api/astro/panchang_element_birth_effect/Автентифікація
Передавайте ключ у заголовку X-API-Key. Ключ — це серверні облікові дані: ніколи не вставляйте його в JavaScript, що виконується в браузері, чи в мобільний застосунок.
X-API-Key: yt_live_a1b2c3d4_…
Content-Type: application/jsonПоля запиту
| Поле | Тип | Обов’язкове | Примітки |
|---|---|---|---|
| keys | array | обов’язковий | Які розрахунки повернути, у вигляді списку назв. Див. таблицю ключів цього ендпоінта; через нерозпізнану назву відхиляється весь запит. Один виклик коштує один кредит незалежно від кількості запитаних ключів, тож запитуйте все потрібне одразу, а не кількома викликами. |
| hora | string | необов’язковий | suryachandramangalabudhabrihaspatishukrashaniНевідоме значення повертає рядок "Invalid hora: <x>. Available options: [...]" з HTTP 200, а не статус помилки; ендпоінт також має допоміжний ключ 'get_all_hora_keys', який повертає саме цей список під час виконання. Зважайте на стиль транслітерації: 'shula'/'priti'/'siddha'/'siddhi'/'aindra' (а не shoola/preeti/indra), а значення hora — санскритські назви планет (surya/chandra/mangala/budha/brihaspati/shukra/shani), а не англійські назви днів тижня чи планет. |
| karana | string | необов’язковий | bavabalavakaulavataitilagaravanijavishtishakunichatushpadanagakimstughnaНевідоме значення повертає рядок "Invalid karana: <x>. Available options: [...]" з HTTP 200, а не статус помилки; ендпоінт також має допоміжний ключ 'get_all_karana_keys', який повертає саме цей список під час виконання. Зважайте на стиль транслітерації: 'shula'/'priti'/'siddha'/'siddhi'/'aindra' (а не shoola/preeti/indra), а значення hora — санскритські назви планет (surya/chandra/mangala/budha/brihaspati/shukra/shani), а не англійські назви днів тижня чи планет. |
| paksha | string | необов’язковий | shuklakrishnaНевідоме значення повертає рядок "Invalid paksha: <x>. Available options: [...]" з HTTP 200, а не статус помилки; ендпоінт також має допоміжний ключ 'get_all_paksha_keys', який повертає саме цей список під час виконання. Зважайте на стиль транслітерації: 'shula'/'priti'/'siddha'/'siddhi'/'aindra' (а не shoola/preeti/indra), а значення hora — санскритські назви планет (surya/chandra/mangala/budha/brihaspati/shukra/shani), а не англійські назви днів тижня чи планет. |
| tithi | string | необов’язковий | pratipadadvitiyatritiyachaturthipanchamishashthisaptamiashtaminavamidashamiekadashidvadashiНевідоме значення повертає рядок "Invalid tithi: <x>. Available options: [...]" з HTTP 200, а не статус помилки; ендпоінт також має допоміжний ключ 'get_all_tithi_keys', який повертає саме цей список під час виконання. Зважайте на стиль транслітерації: 'shula'/'priti'/'siddha'/'siddhi'/'aindra' (а не shoola/preeti/indra), а значення hora — санскритські назви планет (surya/chandra/mangala/budha/brihaspati/shukra/shani), а не англійські назви днів тижня чи планет. |
| vaara | string | необов’язковий | sundaymondaytuesdaywednesdaythursdayfridaysaturdayНевідоме значення повертає рядок "Invalid vaara: <x>. Available options: [...]" з HTTP 200, а не статус помилки; ендпоінт також має допоміжний ключ 'get_all_vaara_keys', який повертає саме цей список під час виконання. Зважайте на стиль транслітерації: 'shula'/'priti'/'siddha'/'siddhi'/'aindra' (а не shoola/preeti/indra), а значення hora — санскритські назви планет (surya/chandra/mangala/budha/brihaspati/shukra/shani), а не англійські назви днів тижня чи планет. |
| yoga | string | необов’язковий | vishkumbhapritiayushmansaubhagyashobhanaatigandasukarmadhritishulagandavriddhidhruvaНевідоме значення повертає рядок "Invalid yoga: <x>. Available options: [...]" з HTTP 200, а не статус помилки; ендпоінт також має допоміжний ключ 'get_all_yoga_keys', який повертає саме цей список під час виконання. Зважайте на стиль транслітерації: 'shula'/'priti'/'siddha'/'siddhi'/'aindra' (а не shoola/preeti/indra), а значення hora — санскритські назви планет (surya/chandra/mangala/budha/brihaspati/shukra/shani), а не англійські назви днів тижня чи планет. |
Доступні ключі (13)
Перелічіть у keys саме ті розрахунки, які вам потрібні. Один невідомий ключ — і відхиляється весь запит. Скільки б ключів ви не запитали, спишеться 1 кредит, тож збирайте їх в один виклик.
| Ключ | Додаткові поля | Опис |
|---|---|---|
| get_all_hora_keys | — | Сім назв хор, які приймає цей ендпоінт, у вигляді списку санскритських назв планет у нижньому регістрі. |
| get_all_karana_keys | — | Одинадцять назв каран, які приймає цей ендпоінт, у вигляді списку рядків у нижньому регістрі. |
| get_all_keys_summary | — | Усі прийнятні значення для всіх шести категорій одним об’єктом із ключами vaara_keys, hora_keys, paksha_keys, tithi_keys, karana_keys і yoga_keys. Один виклик замість шести. |
| get_all_paksha_keys | — | Дві назви пакш, які приймає цей ендпоінт, у вигляді списку рядків у нижньому регістрі: shukla і krishna. |
| get_all_tithi_keys | — | Шістнадцять назв тітхі, які приймає цей ендпоінт, у вигляді списку рядків у нижньому регістрі. Заповнюйте ним список вибору, а не прописуйте написання в коді вручну. |
| get_all_vaara_keys | — | Сім назв днів тижня, які приймає цей ендпоінт, у вигляді списку англійських назв днів у нижньому регістрі. |
| get_all_yoga_keys | — | Двадцять сім назв нітья-йог, які приймає цей ендпоінт, у вигляді списку рядків у нижньому регістрі. |
| get_birth_hora_result | hora | Тлумачення для планетарної хори, яка діє в момент народження. Приймає hora як санскритську назву планети в нижньому регістрі — surya, chandra, mangala, budha, brihaspati, shukra, shani — і повертає короткий абзац тексту англійською. |
| get_birth_karana_effects | karana | Тлумачення для карани народження. Приймає karana як одну з одинадцяти назв у нижньому регістрі (bava, balava, kaulava, taitila, gara, vanija, vishti, shakuni, chatushpada, naga, kimstughna) і повертає абзац тексту англійською. |
| get_birth_paksha_effects | paksha | Тлумачення для народження у світлу чи темну пакшу. Приймає paksha як 'shukla' або 'krishna' і повертає абзац тексту англійською. |
| get_birth_panchang_yoga_effects | yoga | Тлумачення для нітья-йоги, що діє в момент народження. Приймає yoga як одну з двадцяти семи назв у нижньому регістрі, від vishkumbha до vaidhriti, і повертає абзац тексту англійською. |
| get_birth_tithi_effects | tithi | Тлумачення для тітхі народження. Приймає tithi як одну з шістнадцяти назв у нижньому регістрі — від pratipada до chaturdashi, а також purnima і amavasya — і повертає абзац тексту англійською. Одна назва охоплює цю тітхі в будь-якій пакші. |
| get_vaara_during_birth | vaara | Тлумачення характеру людини, народженої в певний день тижня. Приймає vaara як англійську назву дня в нижньому регістрі і повертає абзац тексту англійською. Нерозпізнане значення повертає рядок зі списком допустимих варіантів — і все одно з HTTP 200. |
Приклад запиту
curl -X POST https://api.occultapi.com/api/astro/panchang_element_birth_effect/ \
-H "X-API-Key: $OCCULT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"keys":["get_vaara_during_birth"],"vaara":"sunday","hora":"surya","paksha":"shukla","tithi":"pratipada","karana":"bava","yoga":"vishkumbha"}'Відповідь
{
"data": {
"get_vaara_during_birth": "Individuals born on Sunday typically possess a steady and determined nature with a fearless approach to life. They often have a naturally authoritative disposition and demonstrate skillfulness in their endeavors. These individuals tend to be honorable and maintain high standards of purity in their conduct. They may have a tendency toward bilious temperament and often exhibit leadership qualities with a noble bearing."
},
"status": 200,
"is_error": false,
"message": "successful"
}Записано з реального виклику з точно таким запитом, як вище. Результати лежать у data під тими ключами, які ви запитали.
Помилки
Помилки обліку кредитів мають вигляд { "error": "…", "message": "<code>", "is_error": true }. Людям показуйте error, а логіку будуйте на message. Детальніше — у довіднику помилок.