{ "openapi": "3.0.1", "info": { "title": "Australian Business (ABN) Lookup & Enrichment", "description": "Bulk-check ABNs, ACNs and business names against the official Australian Business Register. Clean CRM and supplier lists: ABN status, cancelled date, entity name and type, GST, state, postcode, business names, ACN and a fuzzy match score. CSV in, enriched rows out.", "version": "0.1", "x-build-id": "Pi1fdG8Ocgp0DU73R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/luke-main~abn-lookup-enrichment/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-luke-main-abn-lookup-enrichment", "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/luke-main~abn-lookup-enrichment/runs": { "post": { "operationId": "runs-sync-luke-main-abn-lookup-enrichment", "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/luke-main~abn-lookup-enrichment/run-sync": { "post": { "operationId": "run-sync-luke-main-abn-lookup-enrichment", "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": { "queries": { "title": "ABNs, ACNs or business names", "type": "array", "description": "One per line. Mix freely: 11-digit ABNs, 9-digit ACNs (spaces OK) and business or company names. Each is detected automatically.", "items": { "type": "string" } }, "csvUrl": { "title": "CSV file URL (optional)", "type": "string", "description": "Public URL of a CSV to enrich (e.g. a Google Sheet published as CSV, Dropbox or Apify key-value store link). Every original column is kept in `sourceRow`." }, "csvColumn": { "title": "CSV column with the ABN / ACN / name", "type": "string", "description": "Header name. Leave empty to auto-detect (abn, acn, company, business name, name...)." }, "csvStateColumn": { "title": "CSV column with the state (optional)", "type": "string", "description": "Per-row state (NSW, VIC...) used to narrow name searches." }, "csvPostcodeColumn": { "title": "CSV column with the postcode (optional)", "type": "string", "description": "Per-row postcode used to narrow name searches." }, "states": { "title": "Only these states", "type": "array", "description": "Limit name searches (and filter results) to these states. Empty = all of Australia.", "items": { "type": "string", "enum": [ "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA" ] } }, "postcode": { "title": "Only this postcode", "type": "string", "description": "Limit name searches to one postcode (main business location)." }, "activeOnly": { "title": "Active ABNs only", "type": "boolean", "description": "Ignore cancelled ABNs in name searches and filter them from results.", "default": false }, "nameMatchMode": { "title": "Name match mode", "enum": [ "best", "all" ], "type": "string", "description": "Best match = one row per name, ideal for enriching a list. Top matches = several candidate rows per name, for research.", "default": "best" }, "maxMatchesPerName": { "title": "Max matches per name (top matches mode)", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many candidates to return per name in top matches mode.", "default": 5 }, "minimumScore": { "title": "Minimum ABR name score", "minimum": 0, "maximum": 100, "type": "integer", "description": "ABR's own relevance score cut-off (0-100) for name searches. Lower = more, looser candidates.", "default": 70 }, "enrichNameMatches": { "title": "Full details for name matches", "type": "boolean", "description": "Fetch the full ABN record (GST, entity type, ACN, business names) for every name match. Turn off for a faster, lighter search.", "default": true }, "includeNotFound": { "title": "Include not-found and invalid rows", "type": "boolean", "description": "Output a row (found = false, with a reason) for inputs with no match or a bad check digit, so your list stays aligned. These rows are free.", "default": true }, "abrGuid": { "title": "ABN Lookup GUID (optional)", "type": "string", "description": "Your own free ABN Lookup web services GUID (register at abr.business.gov.au/Tools/WebServices). Leave empty to use the Actor's built-in key." }, "maxItems": { "title": "Max inputs to process", "minimum": 0, "type": "integer", "description": "0 = no limit.", "default": 0 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many ABR requests run at once. Keep it modest to be polite to the register.", "default": 4 } } }, "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 } } } } } } } } } }