POST/api/astro/fixed-star/catalog/1 кредит

Каталог нерухомих зір

Пошук у каталозі нерухомих зір за назвою, позначенням чи яскравістю. 1357 рядків, що охоплюють 532 різні зорі; решта рядків — альтернативні назви, прив’язані до своєї зорі. Тут це важливо: Альдебаран — це також Рохіні, а Сіріус — також Лубдхака, тож шукати можна й за ведичними назвами, а простий перелік повернув би Сіріус тричі. З цього покажчика варто почати, перш ніж запитувати щось інше, бо назви зір не вгадаєш. Він не приймає дати й не повертає положень: для положення потрібна дата, тож для цього використовуйте /positions/.

https://api.occultapi.com/api/astro/fixed-star/catalog/

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

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

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

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

Поля запиту

Поле	Тип	Обов’язкове	Примітки
limit	integer	необов’язковий	min 1 · max 500
max_magnitude	number (double)	необов’язковий
preset	string	необов’язковий	`majorbehenianbrightestall`
search	string	необов’язковий	Шукати за назвою або позначенням Баєра.

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

curl -X POST https://api.occultapi.com/api/astro/fixed-star/catalog/ \
  -H "X-API-Key: $OCCULT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"search":"aldebaran","preset":"all","limit":25}'

Відповідь

{
  "data": {
    "distinct_stars": 532,
    "matched": 1,
    "returned": 1,
    "stars": [
      {
        "star": "Aldebaran",
        "designation": "alTau",
        "magnitude": 0.86,
        "aliases": [
          "Rohini"
        ]
      }
    ]
  },
  "status": 200,
  "is_error": false,
  "message": "successful"
}

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

Помилки

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