Documentation / API v2

v2 endpoints

Every route is a GET, answers JSON and requires X-API-Key. Each one opens in the playground sandbox with the example's parameters already filled in.

Days

GET/api/v2/days/{date}

One liturgical day

Season, colour, week, Sunday name, fast and the celebration that prevailed. Readings, collect, competing celebrations and the explanation come in through include.

Parameter	In	Description
`date`required	path	Date as YYYY-MM-DD, or today.
`book`required	query	Prayer book code, such as loc_2015 or loc_1662_en. Required on every resource whose content depends on the book; v2 has no default book. See GET /api/v2/prayer-books.
`include`	query	Comma-separated list of sub-resources to compute. A child implies its parent: readings.text already brings readings. `readingsreadings.textreadings.morningreadings.eveningreadings.alternativescollectcollect.textcelebrationsexplanation`
`service`	query	Which office's readings to use: daily (default), eucharist, morning, evening or, on readings, all for every office at once. `dailyeucharistmorningevening`
`fields[day]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.
`fields[reading]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.
`fields[collect]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.
`If-None-Match`	header	ETag from an earlier response. If nothing changed, the API answers 304 with no body.

Also accepts the context parameters bible, psalter, lectionary, reading_type and lang.

Example

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"

Try in the sandbox

GET/api/v2/days

Many days at once

The same resource as /days/:date for a range, with from and to or year. Ideal for building a monthly or yearly calendar in one call.

Parameter	In	Description
`book`required	query	Prayer book code, such as loc_2015 or loc_1662_en. Required on every resource whose content depends on the book; v2 has no default book. See GET /api/v2/prayer-books.
`from`	query	First date of the range (YYYY-MM-DD).
`to`	query	Last date of the range, inclusive.
`year`	query	A whole calendar year, instead of from and to.
`include`	query	Comma-separated list of sub-resources to compute. A child implies its parent: readings.text already brings readings. `readingsreadings.textreadings.morningreadings.eveningreadings.alternativescollectcollect.textcelebrationsexplanation`
`service`	query	Which office's readings to use: daily (default), eucharist, morning, evening or, on readings, all for every office at once. `dailyeucharistmorningevening`
`fields[day]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.
`fields[reading]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.
`fields[collect]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.

Also accepts the context parameters bible, psalter, lectionary, reading_type and lang.

Example

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"

Try in the sandbox

Readings and texts

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

Readings for a service

A date's readings as a list of slots. service=all returns every office at once, in services. With include=text, the text comes in the bible translation and in text_format.

Parameter	In	Description
`date`required	path	Date as YYYY-MM-DD, or today.
`book`required	query	Prayer book code, such as loc_2015 or loc_1662_en. Required on every resource whose content depends on the book; v2 has no default book. See GET /api/v2/prayer-books.
`service`	query	Which office's readings to use: daily (default), eucharist, morning, evening or, on readings, all for every office at once. `dailyeucharistmorningeveningall`
`include`	query	Comma-separated list of sub-resources to compute. A child implies its parent: readings.text already brings readings. `textalternatives`
`text_format`	query	Bible text format: verses (default, structured verses), plain or markdown (one string in content). `versesplainmarkdown`
`fields[reading]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.

Also accepts the context parameters bible, psalter, lectionary, reading_type and lang.

Example

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"

Try in the sandbox

GET/api/v2/collects/{date}

Collects for a date

The day's collects without the rest of the calendar. By default only title, kind and reference; include=text adds the body and preface.

Parameter	In	Description
`date`required	path	Date as YYYY-MM-DD, or today.
`book`required	query	Prayer book code, such as loc_2015 or loc_1662_en. Required on every resource whose content depends on the book; v2 has no default book. See GET /api/v2/prayer-books.
`include`	query	Comma-separated list of sub-resources to compute. A child implies its parent: readings.text already brings readings. `text`
`fields[collect]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.

Also accepts the context parameters bible, psalter, lectionary, reading_type and lang.

Example

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"

Try in the sandbox

GET/api/v2/passages

Any Bible passage

Any passage, in any available translation, independent of the lectionary. Does not require book.

Parameter	In	Description
`ref`required	query	Bible reference, such as John 3:16-21.
`bible`required	query	Bible translation for texts, such as nvi or kjv. Defaults to the book's preferred version. See GET /api/v2/bible-versions.
`text_format`	query	Bible text format: verses (default, structured verses), plain or markdown (one string in content). `versesplainmarkdown`

Example

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"

Try in the sandbox

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

Liturgical explanation

Why the day resolved the way it did: precedence, transfers, colour, season and the provenance of each reading, for the office chosen in service.

Parameter	In	Description
`date`required	path	Date as YYYY-MM-DD, or today.
`book`required	query	Prayer book code, such as loc_2015 or loc_1662_en. Required on every resource whose content depends on the book; v2 has no default book. See GET /api/v2/prayer-books.
`service`	query	Which office's readings to use: daily (default), eucharist, morning, evening or, on readings, all for every office at once. `dailyeucharistmorningevening`

Also accepts the context parameters bible, psalter, lectionary, reading_type and lang.

Example

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"

Try in the sandbox

Liturgical year

GET/api/v2/years/{year}

Year overview

Liturgical cycle, Sunday and weekday cycles, seasons and key dates of the year in one response.

Parameter	In	Description
`year`required	path	Four-digit year.
`book`required	query	Prayer book code, such as loc_2015 or loc_1662_en. Required on every resource whose content depends on the book; v2 has no default book. See GET /api/v2/prayer-books.
`fields[annual_overview]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.
`fields[season]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.
`fields[key_date]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.

Also accepts the context parameters bible, psalter, lectionary, reading_type and lang.

Example

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

Try in the sandbox

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

Seasons of the year

The liturgical seasons of the year with their start and end dates.

Parameter	In	Description
`year`required	path	Four-digit year.
`book`required	query	Prayer book code, such as loc_2015 or loc_1662_en. Required on every resource whose content depends on the book; v2 has no default book. See GET /api/v2/prayer-books.
`fields[season]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.

Also accepts the context parameters bible, psalter, lectionary, reading_type and lang.

Example

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

Try in the sandbox

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

Key dates

The movable dates the year turns on, such as Ash Wednesday, Easter and Pentecost.

Parameter	In	Description
`year`required	path	Four-digit year.
`book`required	query	Prayer book code, such as loc_2015 or loc_1662_en. Required on every resource whose content depends on the book; v2 has no default book. See GET /api/v2/prayer-books.
`fields[key_date]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.

Also accepts the context parameters bible, psalter, lectionary, reading_type and lang.

Example

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"

Try in the sandbox

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

Lectionary cycle

The lectionary's Sunday and weekday cycles for the year.

Parameter	In	Description
`year`required	path	Four-digit year.
`book`required	query	Prayer book code, such as loc_2015 or loc_1662_en. Required on every resource whose content depends on the book; v2 has no default book. See GET /api/v2/prayer-books.
`fields[lectionary_cycle]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.

Also accepts the context parameters bible, psalter, lectionary, reading_type and lang.

Example

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"

Try in the sandbox

Catalogues

GET/api/v2/celebrations

Search celebrations

The book's catalogue of celebrations, with name search and filters by type, month, day and movability. With year, it resolves effective dates and includes Sundays. Cursor-paginated.

Parameter	In	Description
`book`required	query	Prayer book code, such as loc_2015 or loc_1662_en. Required on every resource whose content depends on the book; v2 has no default book. See GET /api/v2/prayer-books.
`q`	query	Search by celebration name.
`type`	query	Celebration type. sunday requires year, because Sundays depend on that year's calendar. `principal_feastmajor_holy_dayfestivallesser_feastcommemorationsunday`
`month`	query	Month (1 to 12).
`day`	query	Day of the month. Requires month or year.
`year`	query	Resolves the effective dates from that year's calendar and includes the Sundays.
`movable`	query	true for movable celebrations only, false for fixed ones only. `truefalse`
`limit`	query	Items per page, from 1 to 100. Default: 50.
`cursor`	query	Opaque cursor from links.next. Reuse it with the same filters and the same book.
`fields[celebration]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.

Also accepts the context parameters bible, psalter, lectionary, reading_type and lang.

Example

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"

Try in the sandbox

GET/api/v2/celebrations/{id}

One celebration

The details of one of the book's celebrations. The id comes from the celebration list.

Parameter	In	Description
`id`required	path	Numeric celebration id, from GET /api/v2/celebrations.
`book`required	query	Prayer book code, such as loc_2015 or loc_1662_en. Required on every resource whose content depends on the book; v2 has no default book. See GET /api/v2/prayer-books.

Also accepts the context parameters bible, psalter, lectionary, reading_type and lang.

Example

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

Try in the sandboxReplace the part in braces with a real value before running it.

GET/api/v2/celebrations/types

Celebration types

The types accepted by the type filter, with their name in the requested language.

Parameter	In	Description
`lang`	query	Response language, such as pt-BR or en. Defaults to the book's language. On catalogues, filters by language.
`fields[celebration_type]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.

Example

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

Try in the sandbox

GET/api/v2/prayer-books

Prayer books

The catalogue of books available to API keys, with language, jurisdiction, year and capabilities.

Parameter	In	Description
`lang`	query	Response language, such as pt-BR or en. Defaults to the book's language. On catalogues, filters by language.
`fields[prayer_book]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.

Example

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"

Try in the sandbox

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

One prayer book

A book's details, with typed capabilities: lectionary variants and reading types, and the offices it has.

Parameter	In	Description
`code`required	path	Prayer book code.

Example

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

Try in the sandbox

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

A book's preferences

The preferences the book accepts, with options and defaults. This is where the valid values of bible, lectionary and reading_type come from.

Parameter	In	Description
`code`required	path	Prayer book code.

Example

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

Try in the sandbox

GET/api/v2/bible-versions

Bible versions

Active Bible translations with language, publisher and licence. lang also matches compatible languages: en-CA finds the en versions.

Parameter	In	Description
`lang`	query	Response language, such as pt-BR or en. Defaults to the book's language. On catalogues, filters by language.
`fields[bible_version]`	query	Comma-separated list of attributes to return for that resource type. Trims the response without changing what is computed.

Example

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

Try in the sandbox