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

Каталог неподвижных звёзд

Поиск по каталогу неподвижных звёзд по названию, обозначению или яркости. В каталоге 1357 строк, а звёзд среди них 532; остальные строки — альтернативные названия, привязанные к своей звезде. Здесь это важно: Альдебаран — это также Rohini, а Сириус — также Lubdhaka, поэтому искать можно и по ведическим названиям, а простой список выдал бы Сириус трижды. С этого указателя стоит начинать, потому что названия звёзд не угадать. Он не принимает дату и не возвращает положений: для положения нужна дата, поэтому используйте /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. Подробнее — в справочнике ошибок.