POST/api/astro/eclipse/attributes/1 кредит

Параметри затемнення в певний момент

Наскільки глибоке затемнення в певний момент, якщо дивитися з певного місця. Знімок, а не пошук: у цю секунду, з цих координат — яка частка диска покрита, як високо тіло над горизонтом, яка фаза затемнення і до якої серії сарос воно належить. Покриття диска змінюється щохвилини, тож, викликаючи цей ендпоінт крок за кроком протягом затемнення, ви отримаєте криву покриття. Це саме те, що потрібно для відстеження наживо, і цього не дасть список моментів контактів. Цим він відрізняється від /api/astro/eclipse/local/, який шукає наступне затемнення, видиме з певного місця, і повертає моменти його контактів. Цей ендпоінт вимірює момент, який у вас уже є: передайте йому максимум із /local/ або /upcoming/, щоб дізнатися глибину затемнення на піку. Щоб натомість отримати тіньову й півтіньову фази, встановіть kind у "lunar". Для місячного затемнення покриття диска немає — це поняття сонячних затемнень, тож поле відсутнє, а не дорівнює нулю. Якщо в цей момент у цьому місці затемнення немає, відповідь прямо про це повідомляє, а не повертає сторінку нулів, яку легко сплутати зі справжнім вимірюванням.

https://api.occultapi.com/api/astro/eclipse/attributes/

Спробувати запит

Автентифікація

Передавайте ключ у заголовку X-API-Key. Ключ — це серверні облікові дані: ніколи не вставляйте його в JavaScript, що виконується в браузері, чи в мобільний застосунок.

X-API-Key: yt_live_a1b2c3d4_…
Content-Type: application/json

Поля запиту

Поле	Тип	Обов’язкове	Примітки
date_time	string (date-time)	обов’язковий	Момент, для якого виконується розрахунок, у форматі ISO 8601. ЗАВЖДИ вказуйте зміщення або Z у кінці: значення без часового поясу читається як Asia/Kolkata (UTC+05:30), а не UTC, і може повернути результат за попередній день із кодом 200. '2026-09-01T06:00:00Z' і '2026-09-01 06:00:00' — різні моменти, і відповіді для них різні.
latitude	number (double)	обов’язковий	Широта місця в десяткових градусах. Додатні значення — північ, від’ємні — південь. Приклад: 26.9124 для Джайпура, 40.7128 для Нью-Йорка. Хвилини й секунди не приймаються — спершу переведіть їх у градуси. min -89.9 · max 89.9
longitude	number (double)	обов’язковий	Довгота місця в десяткових градусах. Додатні значення — схід, від’ємні — захід. Приклад: 75.7873 для Джайпура, -74.0060 для Нью-Йорка. Зверніть увагу на знак: без мінуса Нью-Йорк опиниться в Китаї. min -180 · max 180
direction	string	необов’язковий	Шукати вперед від date_time чи назад. `afterbefore`
elevation	number (double)	необов’язковий
keys	array	необов’язковий	Які розрахунки повернути, у вигляді списку назв. Див. таблицю ключів цього ендпоінта; через нерозпізнану назву відхиляється весь запит. Один виклик коштує один кредит незалежно від кількості запитаних ключів, тож запитуйте все потрібне одразу, а не кількома викликами.
kind	string	необов’язковий	Затемнення якого тіла вимірювати в цей момент. `solarlunar`
timezone_as_float	number (double)	необов’язковий	Зміщення місця від UTC у годинах, десятковим дробом. Приклад: 5.5 для Індії (UTC+05:30), -5 для Нью-Йорка взимку, 5.75 для Непалу. Його НЕ звіряють із date_time: якщо значення розходяться, ви отримаєте успішну відповідь для неправильного моменту, тож беріть обидва з одного джерела. Використовуйте зміщення, чинне на ту дату, а не сьогоднішнє: для народження влітку в країні з переходом на літній час потрібне літнє зміщення. min -12 · max 14

Приклад запиту

curl -X POST https://api.occultapi.com/api/astro/eclipse/attributes/ \
  -H "X-API-Key: $OCCULT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"date_time":"2026-08-12T17:46:00+00:00","timezone_as_float":0,"latitude":64.1466,"longitude":-21.9426,"kind":"solar"}'

Відповідь

{
  "data": {
    "kind": "solar",
    "in_progress": true,
    "type": "partial",
    "moment": "2026-08-12T17:46:00Z",
    "place": {
      "latitude": 64.1466,
      "longitude": -21.9426,
      "elevation": 0
    },
    "attributes": {
      "solar_diameter_fraction_covered": 0.9694113526477836,
      "lunar_to_solar_diameter_ratio": 1.0392513179040108,
      "obscuration": 0.9698071068665648,
      "core_shadow_diameter_km": -132.45757926321468,
      "sun_azimuth": 72.06950998795764,
      "sun_true_altitude": 24.78900312370976,
      "sun_apparent_altitude": 24.824074556487865,
      "moon_elongation": 0.026420359347729915,
      "magnitude_nasa": 0.9694113526477836,
      "saros_series": 126,
      "saros_member": 48
    },
    "saros": {
      "series": 126,
      "member": 48
    }
  },
  "status": 200,
  "is_error": false,
  "message": "successful"
}

Записано з реального виклику з точно таким запитом, як вище. Результати лежать у data.

Помилки

Помилки обліку кредитів мають вигляд { "error": "…", "message": "<code>", "is_error": true }. Людям показуйте error, а логіку будуйте на message. Детальніше — у довіднику помилок.