Documentação / API v2

Endpoints da v2

Todas as rotas são GET, respondem JSON e exigem X-API-Key. Cada uma abre no sandbox do playground com os parâmetros do exemplo já preenchidos.

Dias

GET/api/v2/days/{date}

Um dia litúrgico

Tempo, cor, semana, nome do domingo, jejum e a celebração que prevaleceu. Leituras, coleta, celebrações concorrentes e explicação entram por include.

Parâmetro	Onde	Descrição
`date`obrigatório	caminho	Data no formato AAAA-MM-DD, ou today.
`book`obrigatório	query	Código do livro de oração, como loc_2015 ou loc_1662_en. Obrigatório em todo recurso cujo conteúdo depende do livro; não há livro padrão na v2. Consulte GET /api/v2/prayer-books.
`include`	query	Lista separada por vírgulas dos sub-recursos a calcular. Um filho implica o pai: readings.text já traz readings. `readingsreadings.textreadings.morningreadings.eveningreadings.alternativescollectcollect.textcelebrationsexplanation`
`service`	query	Ofício cujas leituras são usadas: daily (padrão), eucharist, morning, evening ou, nas leituras, all para todos de uma vez. `dailyeucharistmorningevening`
`fields[day]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.
`fields[reading]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.
`fields[collect]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.
`If-None-Match`	cabeçalho	ETag de uma resposta anterior. Se nada mudou, a API responde 304 sem corpo.

Também aceita os parâmetros de contexto bible, psalter, lectionary, reading_type e lang.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/days/2026-03-25" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "book=loc_2015" \
  --data-urlencode "include=readings,collect"

Testar no sandbox

GET/api/v2/days

Vários dias de uma vez

O mesmo recurso de /days/:date para um intervalo, com from e to ou year. Ideal para montar um calendário mensal ou anual em uma chamada.

Parâmetro	Onde	Descrição
`book`obrigatório	query	Código do livro de oração, como loc_2015 ou loc_1662_en. Obrigatório em todo recurso cujo conteúdo depende do livro; não há livro padrão na v2. Consulte GET /api/v2/prayer-books.
`from`	query	Primeira data do intervalo (AAAA-MM-DD).
`to`	query	Última data do intervalo, inclusive.
`year`	query	Ano civil inteiro, no lugar de from e to.
`include`	query	Lista separada por vírgulas dos sub-recursos a calcular. Um filho implica o pai: readings.text já traz readings. `readingsreadings.textreadings.morningreadings.eveningreadings.alternativescollectcollect.textcelebrationsexplanation`
`service`	query	Ofício cujas leituras são usadas: daily (padrão), eucharist, morning, evening ou, nas leituras, all para todos de uma vez. `dailyeucharistmorningevening`
`fields[day]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.
`fields[reading]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.
`fields[collect]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.

Também aceita os parâmetros de contexto bible, psalter, lectionary, reading_type e lang.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/days" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "book=loc_2015" \
  --data-urlencode "from=2026-03-01" \
  --data-urlencode "to=2026-03-31" \
  --data-urlencode "fields[day]=date,season,color,celebration"

Testar no sandbox

Leituras e textos

GET/api/v2/days/{date}/readings

Leituras de um ofício

As leituras de uma data como lista de slots. service=all devolve todos os ofícios de uma vez, em services. Com include=text, o texto vem na versão de bible e no formato de text_format.

Parâmetro	Onde	Descrição
`date`obrigatório	caminho	Data no formato AAAA-MM-DD, ou today.
`book`obrigatório	query	Código do livro de oração, como loc_2015 ou loc_1662_en. Obrigatório em todo recurso cujo conteúdo depende do livro; não há livro padrão na v2. Consulte GET /api/v2/prayer-books.
`service`	query	Ofício cujas leituras são usadas: daily (padrão), eucharist, morning, evening ou, nas leituras, all para todos de uma vez. `dailyeucharistmorningeveningall`
`include`	query	Lista separada por vírgulas dos sub-recursos a calcular. Um filho implica o pai: readings.text já traz readings. `textalternatives`
`text_format`	query	Formato do texto bíblico: verses (padrão, versículos estruturados), plain ou markdown (uma string em content). `versesplainmarkdown`
`fields[reading]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.

Também aceita os parâmetros de contexto bible, psalter, lectionary, reading_type e lang.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/days/2026-03-25/readings" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "book=loc_2015" \
  --data-urlencode "include=text" \
  --data-urlencode "text_format=plain"

Testar no sandbox

GET/api/v2/collects/{date}

Coletas de uma data

As coletas do dia sem o resto do calendário. Por padrão, só título, tipo e referência; include=text traz o corpo e o prefácio.

Parâmetro	Onde	Descrição
`date`obrigatório	caminho	Data no formato AAAA-MM-DD, ou today.
`book`obrigatório	query	Código do livro de oração, como loc_2015 ou loc_1662_en. Obrigatório em todo recurso cujo conteúdo depende do livro; não há livro padrão na v2. Consulte GET /api/v2/prayer-books.
`include`	query	Lista separada por vírgulas dos sub-recursos a calcular. Um filho implica o pai: readings.text já traz readings. `text`
`fields[collect]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.

Também aceita os parâmetros de contexto bible, psalter, lectionary, reading_type e lang.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/collects/2026-03-25" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "book=loc_2015" \
  --data-urlencode "include=text"

Testar no sandbox

GET/api/v2/passages

Texto bíblico avulso

Qualquer passagem, em qualquer versão disponível, sem depender do lecionário. Não exige book.

Parâmetro	Onde	Descrição
`ref`obrigatório	query	Referência bíblica, como João 3:16-21.
`bible`obrigatório	query	Versão bíblica dos textos, como nvi ou kjv. Padrão: a versão preferida do livro. Consulte GET /api/v2/bible-versions.
`text_format`	query	Formato do texto bíblico: verses (padrão, versículos estruturados), plain ou markdown (uma string em content). `versesplainmarkdown`

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/passages" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "ref=João 3:16-21" \
  --data-urlencode "bible=nvi" \
  --data-urlencode "text_format=verses"

Testar no sandbox

GET/api/v2/liturgical-explanations/{date}

Explicação litúrgica

Por que o dia resolveu como resolveu: precedência, transferências, cor, tempo e a proveniência de cada leitura, para o ofício escolhido em service.

Parâmetro	Onde	Descrição
`date`obrigatório	caminho	Data no formato AAAA-MM-DD, ou today.
`book`obrigatório	query	Código do livro de oração, como loc_2015 ou loc_1662_en. Obrigatório em todo recurso cujo conteúdo depende do livro; não há livro padrão na v2. Consulte GET /api/v2/prayer-books.
`service`	query	Ofício cujas leituras são usadas: daily (padrão), eucharist, morning, evening ou, nas leituras, all para todos de uma vez. `dailyeucharistmorningevening`

Também aceita os parâmetros de contexto bible, psalter, lectionary, reading_type e lang.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/liturgical-explanations/2026-03-25" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "book=loc_1662_en" \
  --data-urlencode "lectionary=revised_1922" \
  --data-urlencode "service=morning"

Testar no sandbox

Ano litúrgico

GET/api/v2/years/{year}

Visão geral do ano

Ciclo litúrgico, ciclos dominical e semanal, estações e datas-chave do ano em uma resposta.

Parâmetro	Onde	Descrição
`year`obrigatório	caminho	Ano com quatro dígitos.
`book`obrigatório	query	Código do livro de oração, como loc_2015 ou loc_1662_en. Obrigatório em todo recurso cujo conteúdo depende do livro; não há livro padrão na v2. Consulte GET /api/v2/prayer-books.
`fields[annual_overview]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.
`fields[season]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.
`fields[key_date]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.

Também aceita os parâmetros de contexto bible, psalter, lectionary, reading_type e lang.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/years/2026" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "book=loc_2015"

Testar no sandbox

GET/api/v2/years/{year}/seasons

Estações do ano

Os tempos litúrgicos do ano com as datas de início e fim.

Parâmetro	Onde	Descrição
`year`obrigatório	caminho	Ano com quatro dígitos.
`book`obrigatório	query	Código do livro de oração, como loc_2015 ou loc_1662_en. Obrigatório em todo recurso cujo conteúdo depende do livro; não há livro padrão na v2. Consulte GET /api/v2/prayer-books.
`fields[season]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.

Também aceita os parâmetros de contexto bible, psalter, lectionary, reading_type e lang.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/years/2026/seasons" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "book=loc_2015"

Testar no sandbox

GET/api/v2/years/{year}/key-dates

Datas-chave

As datas móveis de que o ano depende, como Quarta-feira de Cinzas, Páscoa e Pentecostes.

Parâmetro	Onde	Descrição
`year`obrigatório	caminho	Ano com quatro dígitos.
`book`obrigatório	query	Código do livro de oração, como loc_2015 ou loc_1662_en. Obrigatório em todo recurso cujo conteúdo depende do livro; não há livro padrão na v2. Consulte GET /api/v2/prayer-books.
`fields[key_date]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.

Também aceita os parâmetros de contexto bible, psalter, lectionary, reading_type e lang.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/years/2026/key-dates" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "book=loc_2015"

Testar no sandbox

GET/api/v2/years/{year}/lectionary-cycle

Ciclo do lecionário

Os ciclos dominical e semanal do lecionário para o ano.

Parâmetro	Onde	Descrição
`year`obrigatório	caminho	Ano com quatro dígitos.
`book`obrigatório	query	Código do livro de oração, como loc_2015 ou loc_1662_en. Obrigatório em todo recurso cujo conteúdo depende do livro; não há livro padrão na v2. Consulte GET /api/v2/prayer-books.
`fields[lectionary_cycle]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.

Também aceita os parâmetros de contexto bible, psalter, lectionary, reading_type e lang.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/years/2026/lectionary-cycle" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "book=loc_2015"

Testar no sandbox

Catálogos

GET/api/v2/celebrations

Buscar celebrações

O catálogo de celebrações do livro, com busca por nome e filtros por tipo, mês, dia e mobilidade. Com year, resolve as datas efetivas e inclui os domingos. Paginado por cursor.

Parâmetro	Onde	Descrição
`book`obrigatório	query	Código do livro de oração, como loc_2015 ou loc_1662_en. Obrigatório em todo recurso cujo conteúdo depende do livro; não há livro padrão na v2. Consulte GET /api/v2/prayer-books.
`q`	query	Busca pelo nome da celebração.
`type`	query	Tipo de celebração. sunday exige year, porque os domingos dependem do calendário do ano. `principal_feastmajor_holy_dayfestivallesser_feastcommemorationsunday`
`month`	query	Mês (1 a 12).
`day`	query	Dia do mês. Exige month ou year.
`year`	query	Resolve as datas efetivas pelo calendário daquele ano e inclui os domingos.
`movable`	query	true para só as móveis, false para só as fixas. `truefalse`
`limit`	query	Itens por página, de 1 a 100. Padrão: 50.
`cursor`	query	Cursor opaco de links.next. Reutilize com os mesmos filtros e o mesmo book.
`fields[celebration]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.

Também aceita os parâmetros de contexto bible, psalter, lectionary, reading_type e lang.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/celebrations" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "book=loc_2015" \
  --data-urlencode "month=3" \
  --data-urlencode "limit=20"

Testar no sandbox

GET/api/v2/celebrations/{id}

Uma celebração

Os detalhes de uma celebração do livro. O id vem da listagem de celebrações.

Parâmetro	Onde	Descrição
`id`obrigatório	caminho	Identificador numérico da celebração, vindo de GET /api/v2/celebrations.
`book`obrigatório	query	Código do livro de oração, como loc_2015 ou loc_1662_en. Obrigatório em todo recurso cujo conteúdo depende do livro; não há livro padrão na v2. Consulte GET /api/v2/prayer-books.

Também aceita os parâmetros de contexto bible, psalter, lectionary, reading_type e lang.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/celebrations/{id}" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "book=loc_2015"

Testar no sandboxTroque o trecho entre chaves por um valor real antes de executar.

GET/api/v2/celebrations/types

Tipos de celebração

Os tipos aceitos pelo filtro type, com o nome no idioma pedido.

Parâmetro	Onde	Descrição
`lang`	query	Idioma da resposta, como pt-BR ou en. Padrão: o idioma do livro. Nos catálogos, filtra por idioma.
`fields[celebration_type]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/celebrations/types" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "lang=pt-BR"

Testar no sandbox

GET/api/v2/prayer-books

Livros de oração

O catálogo de livros disponíveis para chaves de API, com idioma, jurisdição, ano e capacidades.

Parâmetro	Onde	Descrição
`lang`	query	Idioma da resposta, como pt-BR ou en. Padrão: o idioma do livro. Nos catálogos, filtra por idioma.
`fields[prayer_book]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/prayer-books" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "fields[prayer_book]=code,name,language,year"

Testar no sandbox

GET/api/v2/prayer-books/{code}

Um livro de oração

Os detalhes de um livro, com as capacidades tipadas: variantes e tipos de leitura do lecionário e os ofícios que ele tem.

Parâmetro	Onde	Descrição
`code`obrigatório	caminho	Código do livro de oração.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/prayer-books/loc_2015" \
  -H "X-API-Key: $ESTEVAO_API_KEY"

Testar no sandbox

GET/api/v2/prayer-books/{code}/preferences

Preferências de um livro

As preferências que o livro aceita, com opções e valores padrão. É daqui que saem os valores válidos de bible, lectionary e reading_type.

Parâmetro	Onde	Descrição
`code`obrigatório	caminho	Código do livro de oração.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/prayer-books/loc_2015/preferences" \
  -H "X-API-Key: $ESTEVAO_API_KEY"

Testar no sandbox

GET/api/v2/bible-versions

Versões da Bíblia

As versões bíblicas ativas, com idioma, editora e licença. lang também aceita idiomas compatíveis: en-CA encontra as versões en.

Parâmetro	Onde	Descrição
`lang`	query	Idioma da resposta, como pt-BR ou en. Padrão: o idioma do livro. Nos catálogos, filtra por idioma.
`fields[bible_version]`	query	Lista separada por vírgulas dos atributos a devolver para aquele tipo de recurso. Recorta a resposta sem mudar o que é calculado.

Exemplo

curl -G "https://api.caminhoanglicano.com.br/api/v2/bible-versions" \
  -H "X-API-Key: $ESTEVAO_API_KEY" \
  --data-urlencode "lang=pt"

Testar no sandbox