{ "openapi": "3.0.1", "info": { "title": "ABN Lookup Australia - Business Register Search", "description": "Search the Australian Business Register by name, postcode or ABN and export full ABN records with GST, business names, ASIC, DGR and charity status.", "version": "0.1", "x-build-id": "WtlBu4bz5sXmOfWxf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~abn-lookup-australia-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-abn-lookup-australia-scraper", "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/parseforge~abn-lookup-australia-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-abn-lookup-australia-scraper", "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/parseforge~abn-lookup-australia-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-abn-lookup-australia-scraper", "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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Business names, trading names or keywords to search on ABN Lookup. Each term runs one search. ABN Lookup returns at most 40 matches per search, so use 'Expand by state' or add words to a broad term.", "default": [], "items": { "type": "string" } }, "abns": { "title": "ABNs or ACNs", "type": "array", "description": "Exact ABN, ACN, ARBN, ARSN or ARFN numbers to look up directly. Spaces are ignored, so both '45 004 189 708' and '45004189708' work. These skip the search step entirely.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "ABN Lookup URLs to scrape, either detail pages (abr.business.gov.au/ABN/View?abn=...) or search result pages (abr.business.gov.au/Search/ResultsActive?...).", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: limited to 10 items (preview). Paid users: up to 1,000,000." }, "states": { "title": "States and territories", "type": "array", "description": "Restrict search results to these states and territories. Leave empty for all of Australia. Verified filter: 'coles supermarkets' returns 15 nationally, 3 in NSW and 5 in VIC.", "items": { "type": "string", "enum": [ "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA" ], "enumTitles": [ "Australian Capital Territory", "New South Wales", "Northern Territory", "Queensland", "South Australia", "Tasmania", "Victoria", "Western Australia" ] }, "default": [] }, "postcode": { "title": "Postcode", "type": "string", "description": "Restrict results to one Australian postcode, for example 3000. A postcode on its own only returns rows when 'Search option' is set to Deductible gift recipients or Charity tax concessions; with the All option a postcode needs a search term as well.", "default": "" }, "nameTypes": { "title": "Match these name types", "type": "array", "description": "Which kinds of name a search term is matched against. Leave empty to match all names. Verified filter: 'coles supermarkets' returns 9 entity names, 6 trading names and 2 business names.", "items": { "type": "string", "enum": [ "entityName", "businessName", "tradingName" ], "enumTitles": [ "Entity name", "Business name", "Trading name" ] }, "default": [] }, "searchOption": { "title": "Search option", "enum": [ "all", "dgr", "charity" ], "type": "string", "description": "Restrict results to deductible gift recipients or to entities with charity tax concessions. Verified filter: postcode 6215 returns 9 charities and 2 deductible gift recipients.", "default": "all" }, "includeCancelled": { "title": "Include cancelled ABNs", "type": "boolean", "description": "Search all ABNs instead of active ones only. Cancelled entities keep their record but carry an ABN status of Cancelled and a cancellation date.", "default": false }, "expandByState": { "title": "Expand by state to beat the 40 result cap", "type": "boolean", "description": "ABN Lookup stops every search at 40 matches. Turn this on to run each search term once per state or territory instead of once nationally, which lifts the ceiling to about 320 matches per term. It bills one search query event per state.", "default": false }, "fetchDetails": { "title": "Fetch the full record for every ABN", "type": "boolean", "description": "Open each matching ABN's record page for the full field set: entity type, GST registration, main business location, ASIC number, charity and deductible gift recipient status. Turn this off to emit only the cheap search match rows (ABN, name, name type, status, postcode, state).", "default": true }, "includeBusinessNames": { "title": "Include registered business names", "type": "boolean", "description": "Add every business name registered on the national Business Names Register for this ABN, each with the date it started.", "default": false }, "includeTradingNames": { "title": "Include historical trading names", "type": "boolean", "description": "Add the trading names the ABR recorded before it stopped collecting them in May 2012, each with the date it started.", "default": false }, "includeAsicRegistration": { "title": "Include ASIC registration", "type": "boolean", "description": "Add the ACN, ARBN, ARSN or ARFN and the link to the entity's record on the ASIC register.", "default": false }, "includeDgrStatus": { "title": "Include deductible gift recipient status", "type": "boolean", "description": "Add the deductible gift recipient endorsement: whether the entity is endorsed, the date it was endorsed from and the item of the table in section 30-15 of the Income Tax Assessment Act 1997 it is covered by.", "default": false }, "includeDgrFunds": { "title": "Include deductible gift recipient funds", "type": "boolean", "description": "Add the separate funds, authorities and institutions the entity operates that can receive deductible gifts, each with its DGR item and date range.", "default": false }, "includeAcncRegistration": { "title": "Include ACNC charity registration", "type": "boolean", "description": "Add the Australian Charities and Not-for-profits Commission registration status, the date it was registered from and the link to its ACNC record.", "default": false }, "includeCharityTaxConcessions": { "title": "Include charity tax concessions", "type": "boolean", "description": "Add the charity type, such as Public Benevolent Institution, and every endorsed tax concession with its start date: GST Concession, FBT Exemption, FBT Rebate and Income Tax Exemption.", "default": false }, "includeAcncCharityProfile": { "title": "Include the full ACNC charity profile", "type": "boolean", "description": "Look the ABN up in the ACNC charity register on data.gov.au for the charity's street address, website, size, registration date, number of responsible persons, financial year end, the states it operates in and its charitable purposes. One extra request per ABN, and only charities are found.", "default": false }, "includeHistory": { "title": "Include ABN history", "type": "boolean", "description": "Open the historical details page for each ABN and add the full history of the entity name, ABN status, GST registration and main business location, each with a from and to date. One extra request per ABN.", "default": false }, "includeNameHistory": { "title": "Include business and trading name history", "type": "boolean", "description": "Add the historical business and trading names with their from and to dates, including names that are no longer current. Read from the same request as ABN history, which it turns on automatically.", "default": false }, "includeStatistics": { "title": "Include ABN statistics", "type": "boolean", "description": "Run the ABN Lookup statistical query and emit one row per group with the count of ABNs. This is a separate dataset from the business records and does not need a search term.", "default": false }, "statisticsOption": { "title": "Statistics count option", "enum": [ "AllAbns", "ActiveAbns", "NewAbns" ], "type": "string", "description": "Which ABNs to count: every ABN ever issued, only currently active ABNs, or only ABNs first activated in the selected year.", "default": "ActiveAbns" }, "statisticsYear": { "title": "Statistics year", "enum": [ "1999", "2000", "2001", "2002", "2003", "2004", "2005", "2006", "2007", "2008", "2009", "2010", "2011", "2012", "2013", "2014", "2015", "2016", "2017", "2018", "2019", "2020", "2021", "2022", "2023", "2024", "2025", "2026" ], "type": "string", "description": "Year of initial ABN activation, used only when the count option is 'New registrations for the selected year'.", "default": "2026" }, "statisticsGroupBy": { "title": "Statistics grouping", "enum": [ "NoGrouping", "ParentEntityType", "EntityType" ], "type": "string", "description": "Group the counts by entity type, by entity group, or return a single total with no grouping.", "default": "EntityType" }, "statisticsGstOnly": { "title": "Statistics: only ABNs registered for GST", "type": "boolean", "description": "Count only the ABNs that are currently registered for Goods and Services Tax.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many requests to run at once against ABN Lookup. The default is measured to be comfortable for the register; raise it only if you are hitting the run timeout." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "ABN Lookup is a public register and needs no proxy, so this is off by default. Turn on Apify Proxy only if your runs start getting blocked.", "default": { "useApifyProxy": false } } } }, "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 } } }, "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 } } } } } } } } } }