{ "openapi": "3.0.1", "info": { "title": "School Holidays & Term Dates API: UK, Australia, Malaysia", "description": "School term dates, half terms and school holidays by council, state or region for the UK, Australia and Malaysia as clean JSON. Official government sources, a source link and last-verified date on every record, checked weekly.", "version": "0.1", "x-build-id": "Pk54iexNdwvOhpeX5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/messnomore~school-holidays-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-messnomore-school-holidays-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/messnomore~school-holidays-api/runs": { "post": { "operationId": "runs-sync-messnomore-school-holidays-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/messnomore~school-holidays-api/run-sync": { "post": { "operationId": "run-sync-messnomore-school-holidays-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "country" ], "properties": { "country": { "title": "Country", "enum": [ "GB", "AU", "MY" ], "type": "string", "description": "Country of the school calendars.", "default": "GB" }, "regions": { "title": "Regions", "maxItems": 100, "type": "array", "description": "Councils (UK), states or territories (Australia, Malaysia), by name or code: e.g. \"East Sussex\", \"GB-FAL\", \"Northern Ireland\", \"NSW\", \"Victoria\", \"Selangor\". Words like \"County Council\" are ignored. Leave empty for every covered region of the country. See the README for the full list.", "default": [], "items": { "type": "string" } }, "years": { "title": "School years", "maxItems": 10, "type": "array", "description": "Start year of each school year you need, e.g. [2026, 2027]. In the UK, 2026 means the 2026/27 school year (September or August to July); in Australia and Malaysia it is the 2026 school year. Up to 10 years. Leave empty for the current school year, every later year already published, and holidays still running today.", "default": [] }, "types": { "title": "Record types", "type": "array", "description": "Which periods to return. Terms are the school terms, half terms the short breaks inside a term, holidays the breaks between terms (and short closures for all pupils). Public holidays are the official bank holidays (UK only for now), mapped onto the same school years.", "items": { "type": "string", "enum": [ "term", "half_term", "holiday", "public_holiday" ], "enumTitles": [ "Terms", "Half terms", "School holidays", "Public / bank holidays" ] }, "default": [ "term", "half_term", "holiday" ] }, "includeDerived": { "title": "Include derived holidays", "type": "boolean", "description": "Some publishers list only term dates. The holidays between their terms are then worked out from the term dates and marked \"derived\": true. Turn this off to get only periods the source states itself.", "default": true }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Upper limit on returned records. You pay per returned record, so this also caps the cost of a run.", "default": 1000 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }