call_report.fca.catalog.construct_fca_mirror_url#

call_report.fca.catalog.construct_fca_mirror_url(*, period: ReportingPeriod, snapshot: str = 'latest') → str[source]#

Construct the GitHub mirror URL for a period’s Call Report zip archive.

The mirror holds each release zip under the same name FCA gives it. The URL is built from the snapshot and the period alone, so it does not say whether the mirror holds that period. FCAReleaseCatalog.from_github lists the periods it does hold.

Parameters:
periodReportingPeriod

The period to build a URL for.

snapshotstr, default “latest”

Which mirror snapshot to download from. "latest" is the current files. A date such as "2026-10-12" is the mirror as it stood on that date. FCA’s own site keeps no snapshots.

Returns:
str

The full URL to that period’s zip archive on the mirror.

Raises:
PeriodNotAvailableError

If period is before FCA’s first release (2000Q1) or after the quarter containing today’s date.

ValueError

If snapshot is neither "latest" nor a snapshot date.

See also

construct_fca_download_url

Build the FCA URL of a period’s release zip.

FCAReleaseCatalog.from_github

List the periods the mirror holds.

Examples

>>> construct_fca_mirror_url(
...     period=ReportingPeriod.from_period_end(value="2026-03-31")
... )
'https://github.com/predict-ably/call-report/releases/download/fca-call-report-data/2026March.zip'
>>> construct_fca_mirror_url(
...     period=ReportingPeriod.from_period_end(value="2014-09-30"),
...     snapshot="2026-10-12",
... )
'https://github.com/predict-ably/call-report/releases/download/fca-data-2026-10-12/Sept2014.zip'