{ "openapi": "3.0.1", "info": { "title": "Ofqual Register - 53K Regulated UK Qualifications", "description": "The Ofqual register of regulated qualifications for England (53,049 qualifications from 351 awarding organisations, OGL v3): level, type, status, credits, GLH/TQT, sector subject area, grading, validity dates, apprenticeship standard links and the awarding organisation. Search, filter or aggregate.", "version": "0.0", "x-build-id": "CgGhikEF2RvJkxCs9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~uk-ofqual-qualifications/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-uk-ofqual-qualifications", "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/j0401~uk-ofqual-qualifications/runs": { "post": { "operationId": "runs-sync-j0401-uk-ofqual-qualifications", "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/j0401~uk-ofqual-qualifications/run-sync": { "post": { "operationId": "run-sync-j0401-uk-ofqual-qualifications", "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", "properties": { "mode": { "title": "Mode", "enum": [ "", "search", "aggregate", "warm" ], "type": "string", "description": "search = filter the register. aggregate = one row per group. warm = owner maintenance: rebuild the snapshot from the Ofqual register and upload it (no filters). Leave blank to auto-route: filters -> search, no filters -> aggregate." }, "q": { "title": "Keyword", "type": "string", "description": "Matches the qualification title or qualification number, case-insensitive (e.g. \"electrical installation\")." }, "title": { "title": "Title contains", "type": "string", "description": "Substring of the qualification title only, case-insensitive." }, "organisation": { "title": "Awarding organisation", "type": "string", "description": "Awarding organisation name, acronym or legal name substring, case-insensitive (e.g. \"City & Guilds Limited\", \"Pearson\")." }, "level": { "title": "Qualification level", "type": "string", "description": "Exact Ofqual level: Entry Level, Level 1, Level 2, Level 3 ... Level 8 (also Level 1/Level 2 for combined GCSEs)." }, "type": { "title": "Qualification type", "type": "string", "description": "Qualification type substring, e.g. \"QCF\", \"National Vocational Qualification\", \"End-Point Assessment\", \"GCSE\"." }, "status": { "title": "Qualification status", "enum": [ "", "Available to learners", "No longer available to new learners", "Not yet available to learners", "No longer awarded" ], "type": "string", "description": "Exact Ofqual status. The register keeps retired qualifications, so use \"Available to learners\" for current qualifications." }, "availableOnly": { "title": "Available to learners only", "type": "boolean", "description": "true = only qualifications currently available to learners (status \"Available to learners\"). false (default) = no status filter.", "default": false }, "ssa": { "title": "Sector subject area", "type": "string", "description": "Sector subject area substring, e.g. \"Health and social care\", \"Engineering\"." }, "qualificationNumber": { "title": "Qualification number", "type": "string", "description": "Exact Ofqual qualification number, e.g. \"500/1514/X\" or \"610/1234/5\"." }, "apprenticeshipStandard": { "title": "Apprenticeship standard ref", "type": "string", "description": "Exact apprenticeship standard reference number, e.g. \"ST0384\"." }, "offeredInEngland": { "title": "Offered in England only", "type": "boolean", "description": "true = only qualifications offered in England. false (default) = no filter.", "default": false }, "groupBy": { "title": "Aggregate by", "enum": [ "", "status", "level", "type", "organisation", "ssa", "eqfLevel", "offeredInEngland" ], "type": "string", "description": "status -> Ofqual status; level / eqfLevel -> levels; type -> qualification type; organisation -> awarding organisation; ssa -> sector subject area; offeredInEngland -> England flag. Blank defaults to status." }, "maxResults": { "title": "Max records", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Cap the number of search records pushed (0 = the default 50, maximum 5000). Aggregate returns every group.", "default": 50 } } }, "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 } } } } } } } } } }