{ "openapi": "3.0.1", "info": { "title": "ASIC Bulk Company Register (Australia)", "description": "Australian companies from ASIC's official Company Register open data (data.gov.au): ACN, ABN, status, type, registration date. Not a scrape of paid ASIC Connect", "version": "0.1", "x-build-id": "92xMs4Uqblz1scrHq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/knotty_mistveil~asic-company-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-knotty_mistveil-asic-company-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/knotty_mistveil~asic-company-register/runs": { "post": { "operationId": "runs-sync-knotty_mistveil-asic-company-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/knotty_mistveil~asic-company-register/run-sync": { "post": { "operationId": "run-sync-knotty_mistveil-asic-company-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": { "allDates": { "title": "All dates (ignore registration date filter)", "type": "boolean", "description": "Default true. The ~400 MB national file is NOT sorted by registration date, so applying any date filter forces a full streamed scan of the whole file (see 'Limits and freshness' in the README for measured timing). Leaving this ticked keeps the default 'Try it' run cheap: it reads from the start of the file and stops as soon as 'Max results' matching companies are found. Untick it, or set 'Registered from' / 'Registered to' / 'Days back' (any of which also switches this off automatically), to filter by registration date at the cost of the full scan.", "default": true }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 80000, "type": "integer", "description": "Used only when the date filter is active (see 'All dates'). Keep companies registered within this many days before today (or before 'Registered to'). The file refreshes weekly, so a narrow window can land almost entirely after the newest data depending on when in the week you run - widen it or set an explicit range if you get zero results.", "default": 7 }, "dateFrom": { "title": "Registered from (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Earliest registration date to include (inclusive). Setting this (or 'Registered to') switches the date filter on regardless of 'All dates'. Overrides 'Days back'. The register holds companies registered as far back as the 1800s." }, "dateTo": { "title": "Registered to (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Latest registration date to include (inclusive). Defaults to today." }, "statuses": { "title": "Statuses", "uniqueItems": true, "type": "array", "description": "Exact ASIC status codes to keep. Default REGD (currently registered) only - the register also lists deregistered/administration companies (see the README for the full legend). Empty list = every status.", "items": { "type": "string", "enum": [ "REGD", "DRGD", "SOFF", "EXAD", "NOAC", "CNCL", "DISS", "NRGD", "PROV", "DIV3", "PEND" ], "enumTitles": [ "REGD - Registered", "DRGD - Deregistered", "SOFF - Strike-off action in progress", "EXAD - External administration (receivership/liquidation)", "NOAC - Not active", "CNCL - Cancelled (transferred to another law or Act)", "DISS - Dissolved by special Act of Parliament", "NRGD - Not registered", "PROV - Provisional", "DIV3 - Transferred registration via Div 3", "PEND - Pending (schemes)" ] }, "default": [ "REGD" ] }, "types": { "title": "Company types", "uniqueItems": true, "type": "array", "description": "ASIC 'Type' codes to keep. Empty = all types. 99% of the register is APTY (Australian proprietary company).", "items": { "type": "string", "enum": [ "APTY", "APUB", "FNOS", "RACN", "CCIV" ], "enumTitles": [ "APTY - Australian proprietary company", "APUB - Australian public company", "FNOS - Foreign company", "RACN - Registered Australian body", "CCIV - Corporate Collective Investment Vehicle" ] } }, "previousStates": { "title": "Previous state of registration", "uniqueItems": true, "type": "array", "description": "Keep only companies whose 'Previous State of Registration' matches one of these. This field is populated almost exclusively for companies first registered under a State corporate law BEFORE the national Corporations Law scheme (pre-1990s) - about 5% of all companies; every company registered since then has this field empty, so filtering on it does not usefully narrow a 'newly registered' search. Empty list = no filter (default).", "items": { "type": "string", "enum": [ "NSW", "VIC", "QLD", "WA", "SA", "TAS", "ACT", "NT", "NFK" ], "enumTitles": [ "NSW - New South Wales", "VIC - Victoria", "QLD - Queensland", "WA - Western Australia", "SA - South Australia", "TAS - Tasmania", "ACT - Australian Capital Territory", "NT - Northern Territory", "NFK - Norfolk Island" ] } }, "keywords": { "title": "Name keywords", "type": "array", "description": "Case-insensitive substrings; a company is kept when its current name contains any of them (OR). Empty = no name filter.", "items": { "type": "string" } }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 2000000, "type": "integer", "description": "Stop after this many companies. You are charged per result returned. The full register holds about 4 million companies in one ~400 MB file; 500 keeps the default run's cost capped at US$0.50 regardless of how much of the file has to be scanned.", "default": 500 } } }, "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 } } } } } } } } } }