How to use API in Alteryx or in browser?

API Issues
1

I was wondering how I would construct a basic url to query the API, as I could then integrate this url into Alteryx?

2

@akash_bhanot

There are a number of endpoints relating to the API to access specific data, which are all documented in the developer hub: -

https://developer.companieshouse.gov.uk

As an example to return some basic company information for a particular company then you could use the “company profile” endpoint.

To achieve this you will need to: -

  1. Register for an API key on the developer hub.
    https://developer.companieshouse.gov.uk/api/docs/index/gettingStarted/apikey_authorisation.html
  2. Using the company number return basic details from the company profile endpoint, documentation as follows:
    https://developer.companieshouse.gov.uk/api/docs/company/company_number/readCompanyProfile.html

Things to specifically note are the authorisation required, documented in the link given above to register for the API key.

If there are further questions then please let us know.

Thanks,

@mfairhurst

3

Thanks for that!

I’m just not sure how to use a cURL example.

Is it possible to type in a url into my browser to generate a response, e.g:

https://api.companieshouse.gov.uk/company/{company_number}&my_api_key

Or something along those lines?

4

@akash_bhanot

Unfortunately its not as simple as that. You can reference the data as HTML in a browser through our own web site by using: -

for a specific company then the following can be used: -

https://beta.companieshouse.gov.uk/company/{company_number}

If you wish to extract data in JSON format then you will need to develop against the API to query the data.

Thanks

@mfairhurst