API reference

Calendars

Industry calendars per jurisdiction: RDOs, public holidays, school holidays and shutdowns, verified against official lists, and whether a date is a working day. Base URL https://dataquoll.io/api/v1.

GET/calendars

Industry calendar editions

Every industry-calendar edition on the platform, one per jurisdiction (NSW, VIC, QLD, WA, SA, TAS, ACT and NT) and year, with its year, publisher, cover range and per-category counts; past years included. RDOs, public holidays, school holidays and industry shutdowns, read from each branch calendar and verified against the Fair Work Ombudsman list and the education departments' term dates. An edition covers its year and the January it runs into; where two editions cover a date, the one whose year matches the date answers it. Every year is served here and by from and to on /api/v1/calendars/{jurisdiction}. The subscribable phone feeds on the website carry a jurisdiction's current and later editions, or its latest one when none is current; an older year never enters them. counts and discrepancies cover the whole edition, the January it runs into included.

Responses

Status	Description
`200`	The editions
`402`	Pay per request: no key was sent, so the answer is a price. The WWW-Authenticate header carries an MPP Payment challenge; pay it and send the request again with Authorization: Payment. Also sent, with a fresh price, when a payment fails its checks or its price has expired. Only while pay per request is on; otherwise a request without a key gets 401.

Request

curl "https://dataquoll.io/api/v1/calendars" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/calendars/{jurisdiction}

Calendar days for a jurisdiction

The day rows for one jurisdiction across a date range, each date answered by exactly one edition (the one whose year matches the date, else the latest that covers it). Defaults to the current calendar year in the jurisdiction's own time zone; a lone from or to extends to the edge of its own year. Past and future years are read the same way, and a range may cross from one year into the next. editions lists every edition whose coverage overlaps the range, including one that answers no date in it; discrepancies carries only those of the edition answering each date. Recorded disagreements between the calendar and the official list are returned under discrepancies. Rows can be CSV with format=csv.

Parameters

Name	In	Required	Type	Description
`jurisdiction`	path	Yes	`string`	Jurisdiction code
`from`	query	No	`string`	First date, YYYY-MM-DD
`to`	query	No	`string`	Last date, YYYY-MM-DD
`category`	query	No	`string`	Comma-separated categories to include (default all). Values are the CalendarDay category enum.
`format`	query	No	`string`	json (default) or csv. In CSV, a text cell begins with a single quote (') when its first visible character is =, +, - or @ (also after spaces or line breaks, and in fullwidth form) or it starts with a tab, carriage return or single quote, so a spreadsheet opens it as text, never as a formula; numbers, such as a negative latitude, are never changed. To get the original text, remove one single quote from the start of a cell that begins with one.

Responses

Status	Description
`200`	The days in range
`400`	Unknown jurisdiction, malformed date, unknown category, or from after to
`402`	Pay per request: no key was sent, so the answer is a price. The WWW-Authenticate header carries an MPP Payment challenge; pay it and send the request again with Authorization: Payment. Also sent, with a fresh price, when a payment fails its checks or its price has expired. Only while pay per request is on; otherwise a request without a key gets 401.

Request

curl "https://dataquoll.io/api/v1/calendars/{jurisdiction}" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/calendars/{jurisdiction}/{date}

Is this a working day

The answer for one date in one jurisdiction. A jurisdiction-wide public holiday wins, then the weekend, then the calendar's own entries in order (industry shutdown, RDO, part-day holiday, annual leave, industry event); otherwise working. Restricted holidays (a show day for one region, a public-service-only day) never decide it and are returned under restricted for the caller to apply to the employer's area.

Parameters

Name	In	Required	Type	Description
`jurisdiction`	path	Yes	`string`	Jurisdiction code
`date`	path	Yes	`string`	The date, YYYY-MM-DD

Responses

Status	Description
`200`	The verdict
`400`	Unknown jurisdiction or malformed date
`402`	Pay per request: no key was sent, so the answer is a price. The WWW-Authenticate header carries an MPP Payment challenge; pay it and send the request again with Authorization: Payment. Also sent, with a fresh price, when a payment fails its checks or its price has expired. Only while pay per request is on; otherwise a request without a key gets 401.
`404`	No edition covers the date; the detail names the editions that exist

Request

curl "https://dataquoll.io/api/v1/calendars/{jurisdiction}/{date}" \
  -H "Authorization: Bearer YOUR_API_KEY"