THis is an API based application which is running on FastAPI. It aggregates and standardises company data from a number of different APIs and can be used a single point of entry.
- Docker
- Browser or any other tool to call the API endpoint
- Clone the repository
- Enter the directory and run
docker build -t <IMAGE NAME> .
- Once the build is finishes, run
docker run -dp 8000:8000 <IMAGE NAME>
- The command above will start the application which will be accessible through http://localhost:8000/. You should see the following message once {"message":"Hello to Company Data API!"}, if that's the case everything is running as expected.
- Query company data using the following structure: http://localhost:8000/v1/company/{jurisdiction_code}/{company_number}