Ir para o conteúdo
POST/api/astro/eclipse/attributes/1 crédito

Atributos do eclipse em um momento

A profundidade de um eclipse em um instante, vista de um local. Um instantâneo, não uma busca: neste segundo, a partir destas coordenadas, que fração do disco está coberta, a que altura o corpo está acima do horizonte, qual é a magnitude e a qual série Saros o eclipse pertence. O obscurecimento muda minuto a minuto ao longo de um eclipse; por isso, chamando este endpoint em intervalos ao longo do evento, você obtém a curva de cobertura — o que um rastreador ao vivo precisa e uma lista de horários de contato não oferece. Não confunda com /api/astro/eclipse/local/, que busca o próximo eclipse visível de um local e retorna os horários de contato. Este endpoint mede um momento que você já tem: passe o máximo obtido em /local/ ou /upcoming/ para saber a profundidade no pico. Defina kind como "lunar" para receber as magnitudes umbral e penumbral. Eclipse lunar não tem obscurecimento — esse é um conceito solar, e o campo fica ausente em vez de valer zero. Se nenhum eclipse estiver ocorrendo naquele local naquele instante, a resposta diz isso, em vez de devolver uma página de zeros com cara de medição real.

https://api.occultapi.com/api/astro/eclipse/attributes/
Testar requisição

Autenticação

Envie sua chave no cabeçalho X-API-Key. A chave é uma credencial de servidor — nunca a coloque no JavaScript do navegador nem num app mobile.

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

Campos da requisição

CampoTipoObrigatórioObservações
date_timestring (date-time)obrigatório

O momento a calcular, em ISO 8601. SEMPRE inclua um deslocamento ou um Z no final - um valor sem fuso horário é lido como Asia/Kolkata (UTC+05:30), não como UTC, e pode retornar o resultado do dia anterior com um 200. '2026-09-01T06:00:00Z' e '2026-09-01 06:00:00' são instantes diferentes e dão respostas diferentes.

latitudenumber (double)obrigatório

Latitude do local, em graus decimais. Positivo é norte, negativo é sul. Exemplo: 26.9124 para Jaipur, 40.7128 para Nova York. Minutos e segundos não são aceitos - converta antes.

min -89.9 · max 89.9

longitudenumber (double)obrigatório

Longitude do local, em graus decimais. Positivo é leste, negativo é oeste. Exemplo: 75.7873 para Jaipur, -74.0060 para Nova York. Atenção ao sinal: sem o sinal de menos, Nova York vai parar na China.

min -180 · max 180

directionstringopcional

Direção da busca a partir de date_time: para a frente ou para trás.

afterbefore
elevationnumber (double)opcional
keysarrayopcional

Quais cálculos retornar, como uma lista de nomes. Veja a tabela de chaves deste endpoint; um nome não reconhecido rejeita a requisição inteira. Uma chamada custa um crédito, não importa quantas chaves você peça, então solicite tudo o que precisa de uma vez em vez de fazer várias chamadas.

kindstringopcional

Corpo cujo eclipse será medido neste momento.

solarlunar
timezone_as_floatnumber (double)opcional

Deslocamento UTC do local, em horas, como número decimal. Exemplo: 5.5 para a Índia (UTC+05:30), -5 para Nova York no inverno, 5.75 para o Nepal. Este valor NÃO é conferido com date_time: se os dois divergirem, você recebe uma resposta bem-sucedida para o momento errado. Por isso, tire os dois da mesma fonte. Use o deslocamento em vigor naquela data, não o de hoje: quem nasceu no verão, em um país com horário de verão, precisa do deslocamento de verão.

min -12 · max 14

Exemplo de requisição

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

Resposta

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

Capturada de uma chamada real, com exatamente a requisição acima. Os resultados ficam em data.

Erros

Erros de consumo de créditos retornam { "error": "…", "message": "<code>", "is_error": true }. Mostre error para o usuário e use message para decidir o que fazer no código. Consulte a referência de erros.