{ "openapi": "3.0.1", "info": { "title": "CRICOS Register Lookup (Australia)", "description": "Australian education providers registered to enrol overseas students (CRICOS): search by name, state, type or postcode, or look up codes. One row per provider with its type, state, postcode, city, capacity and course counts. Names are left out when they show no organisation cue. CC BY 2.5 AU.", "version": "0.1", "x-build-id": "bMq50Z0mlWCv7pRfq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yappman~cricos-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yappman-cricos-register", "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/yappman~cricos-register/runs": { "post": { "operationId": "runs-sync-yappman-cricos-register", "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/yappman~cricos-register/run-sync": { "post": { "operationId": "run-sync-yappman-cricos-register", "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", "lookup" ], "type": "string", "description": "search: rows for the providers that pass your filters, sorted by provider code. lookup: rows for the provider codes you list in providerCodes (1 to 20). Allowed values: search, lookup. Default: search. Cost: $0.002 per row returned, flat on every Apify plan; refused, empty and source-problem runs are not charged.", "default": "search" }, "nameContains": { "title": "Name contains (search)", "type": "string", "description": "Search only. Optional text of 2 to 80 characters, matched without regard to capitals against the provider name shown in the output; providers whose name is left out never match. Default: no name filter. Cost: $0.002 per row returned, flat on every Apify plan." }, "states": { "title": "States (search)", "maxItems": 8, "type": "array", "description": "Search only. Optional list of up to 8 states from ACT, NSW, NT, QLD, SA, TAS, VIC, WA (any capitals), matched to the provider's postal address state. Default: all states. Cost: $0.002 per row returned, flat on every Apify plan.", "items": { "type": "string" } }, "institutionTypes": { "title": "Institution types (search)", "maxItems": 20, "type": "array", "description": "Search only. Optional list of up to 20 institution types spelled as the register spells them, for example Government or Private (any capitals). A type the register does not have refuses the run before anything is charged. Default: all types. Cost: $0.002 per row returned, flat on every Apify plan.", "items": { "type": "string" } }, "postcodes": { "title": "Postcodes (search)", "maxItems": 50, "type": "array", "description": "Search only. Optional list of up to 50 four-digit postcodes as text, for example \"3000\", matched to the provider's postal address postcode. Default: all postcodes. Cost: $0.002 per row returned, flat on every Apify plan.", "items": { "type": "string" } }, "providerCodes": { "title": "Provider codes (lookup)", "maxItems": 20, "type": "array", "description": "Lookup only, and required there: 1 to 20 CRICOS provider codes, five digits and a capital letter, for example 00001K. Codes not in the register are listed in RUN_SUMMARY notFound; the run is refused if none is found. Cost: $0.002 per row returned, flat on every Apify plan.", "items": { "type": "string" } }, "maxItems": { "title": "Max rows (search)", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Search only: the most rows returned, and so the most you can be charged for ($0.002 per row returned, flat on every Apify plan). Whole number from 1 to 2,000. Default: 100 through the API; the Console form starts at 10. Not used in lookup, which returns one row for each code found.", "default": 100 } } }, "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 } } } } } } } } } }