Company count

API definition

The API definition for company count is available at https://services.cro.ie/cws/help/operations/companycount

URL

The URL for getting the company count is:

https://services.cro.ie/cws/companycount?company_num={COMPANY_NUM}&company_name={COMPANY_NAME}&alpha={ALPHA}
&company_bus_ind={COMPANY_BUS_IND}&searchType={SEARCHTYPE}&address={ADDRESS}

Query string values

The following values will only be applicable for using company count:


	company_num
	company_bus_ind
	company_name
	address
	searchType

Please see the company search help page for explanations of the above parameters.

Uses

The purpose of this method is to allow you to retrieve the number of matches that would occur if you supplied the same search parameters to the company search method. This method is most useful when you wish to paginate your search results.

Examples of calls to implement paging

Let's say you want to paginate results for the following example:

You are trying to search for a company called "Smith". This could return hundreds of matches.

Calling the company count service is done as follows:

 https://services.cro.ie/cws/companycount?company_name=smith

Suppose the above call returned a value of 450.

If we wish to list 10 rows on each page, we would have 45 pages of 10 rows. Consequently, the first call to company search will be:

 https://services.cro.ie/cws/companies?company_name=smith&skip=0&max=10

The link to go to the second page of the results will be acheived by setting "skip" to 10:

 https://services.cro.ie/cws/companies?company_name=smith&skip=10&max=10

To go to the 15th page, the link will be acheived by multiplying 10x15, and setting "skip" to the result (150):

 https://services.cro.ie/cws/companies?company_name=smith&skip=150&max=10

© 2022 - Companies Registration Office, Bloom House, Gloucester Place Lower, Dublin 1, Ireland.