Loading...
Sign in to see the examples with your own API key.

Companies

The Companies API suggests Australian businesses as a name, ABN or ACN is typed: for a supplier, sign-up or invoicing form that needs the legal entity behind a name. It searches every active ABN on the Australian Business Register, by legal name and by the business and trading names each ABN goes by. It is on every plan.

Step 1.

Request

GET https://api.getaddress.io/companies/{term}?api-key={your-api-key}

Response, for 'bbc hardw'

{
    "suggestions":
    [
        {
            "name": "BBC HARDWARE LIMITED",
            "name_type": "legal",
            "legal_name": null,
            "abn": "11000003378",
            "abn_status": "active",
            "state": "VIC",
            "postcode": "3121",
            "url": "/company/11000003378",
            "id": "11000003378"
        },
        {
            "name": "BBC HARDWARE",
            "name_type": "trading",
            "legal_name": "BBC HARDWARE LIMITED",
            "abn": "11000003378",
            "abn_status": "active",
            "state": "VIC",
            "postcode": "3121",
            "url": "/company/11000003378",
            "id": "11000003378"
        }
    ]
}

Every typed word matches the start of a word of the name, so 'hardw bbc' finds the same names. A name needs at least 3 characters. Type an 11-digit ABN or a 9-digit ACN instead, with or without spaces, and the one business that holds it comes back; a number whose check digit fails comes back empty.

Step 2.

The selected 'Id' is passed to the 'Company' API for the full record.

GET https://api.getaddress.io/company/{id}?api-key={your-api-key}

Parameters

Parameter Description
top Number of suggestions to return, 1 to 20. Default 6.
state Only businesses whose main location is in this state: NSW, VIC, QLD, SA, WA, TAS, NT or ACT.

Suggestion Fields

Field Description
nameThe name that matched, as the register spells it.
name_typelegal, business (a registered business name), trading or other.
legal_nameThe ABN's legal name, when the name that matched is a business or trading name. Null for a sole trader.
abnThe 11-digit ABN.
abn_statusAlways active: only active ABNs are searched.
state, postcodeThe main business location. The register publishes no street address.
url, idThe full record's relative URL, and the ABN to pass to Company.

Sole traders

A sole trader's ABN belongs to a person. The Companies API finds one only by a business or trading name, or by ABN, and never suggests the owner's own name, so it cannot be used to search for people.

Usage

  • The Companies API is rate limited but does not count against your plan's allowance.
  • It accepts a domain token in place of an API key, for use in the browser.
  • The data is the Australian Business Register's weekly extract: a change shows from the next week's extract.

Rate Limiting

Your subscription's plan will limit the number of requests per 5 minute span. Exceeding your plan's rate limit will return a HTTP 429 response.
The Retry-After HTTP header contains the number of seconds until a successful retry can be made.

Top