AMEE Open Business (Independent Publisher) (Preview)
Access business data on over 20 million companies including financial risk, carbon emissions, carbon efficiency ratings, and more sustainability and business information such as address and contact details. Embed data into your application to link company profiles and automate monitoring changes to credit and environmental ratings.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Paul Culmsee |
URL | https://sevensigma.com.au |
paul.culmsee@sevensigma.com.au |
Connector Metadata | |
---|---|
Publisher | Paul Culmsee |
Website | https://www.amee.com/api |
Privacy policy | https://www.amee.com/privacy-policy |
Categories | Data |
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
API Key | securestring | The API Key for this api | True |
API Secret | securestring | The API Secret for this api | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Get Companies |
Returns a set of companies |
Get Company |
Returns a company based on ID. The ID defaults to an AMEE company id, but you can also search via a CRO number by setting the 'type' parameter. |
Get Companies
Returns a set of companies
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Results per page
|
limit | integer |
Number of results per page, max 50, default 20 |
|
Page number of results
|
page | integer |
Page number of results, max 100, default 1 |
|
Company Name
|
company_name | string |
Fuzzy search on company_name |
|
Parent Company ID
|
gup_amee_company_id | integer |
Search on companies with same parent ID |
|
Filters for parent companies
|
is_gup | boolean |
Filters for parent companies |
|
City
|
city | string |
Exact search on city |
|
Postcode
|
postcode | integer |
Exact search on postcode |
|
Province Name
|
province_name | string |
Exact search on province_name |
|
Standard Industrial Classification
|
uk_sic_2007 | string |
Exact search on uk_sic_2007 |
|
Min Number of Employees
|
min_employees | integer |
minimum value for employees_total |
|
Max Number of Employees
|
max_employees | integer |
maximum value for employees_total |
|
Min Annual Sales
|
min_annual_sales_local | integer |
minimum value for annual_sales_local |
|
Max Annual Sales
|
max_annual_sales_local | integer |
maximum value for annual_sales_local |
|
Min Amee Industry Score
|
min_score | integer |
minimum value for amee_industry_score |
|
Max Amee Industry Score
|
max_score | integer |
maximum value for amee_industry_score |
|
Latitude/Longitude of a point to search around
|
from_lat_lon | string |
must be used together with with distance param, e.g.: 51.623,-0.0732 and distance=20 |
|
Radius in KM to search by Lat/Lon
|
distance | integer |
e.g.: from_location=51.623,-0.0732 and distance=20 |
|
Returns a list of values at the end of the results
|
stats | string |
Returns 'count', 'total', 'min', 'max', 'mean', 'sum_of_squares', 'variance' and 'std_deviation'. |
Returns
Name | Path | Type | Description |
---|---|---|---|
companies
|
companies | array of CompanyModel |
Companies |
total
|
total | integer |
total |
Get Company
Returns a company based on ID. The ID defaults to an AMEE company id, but you can also search via a CRO number by setting the 'type' parameter.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Company ID
|
id | True | string |
ID of company that needs to be fetched, e.g. 000662801 |
Company Type
|
type | string |
Allowed values: 'amee', 'CRO'. Defaults to 'amee' |
Returns
Name | Path | Type | Description |
---|---|---|---|
company
|
company | CompanyModel |
Definitions
CompanyModel
Name | Path | Type | Description |
---|---|---|---|
Amee Company Id
|
amee_company_id | string |
amee_company_id |
ID of Company Global Ultimate Parent
|
gup_amee_company_id | string |
gup_amee_company_id |
Is Company a Global Ultimate Parent?,
|
is_gup | boolean |
is_gup |
Company Name
|
name | string |
name |
Amee Industry Score
|
amee_industry_score | integer |
amee_industry_score |
AMEE Score Status
|
amee_score_status | string |
amee_score_status |
Annual Sales Locally
|
annual_sales_local | integer |
annual_sales_local |
City
|
city | string |
city |
Country Code
|
country_code | string |
country_code |
Currency Code
|
currency_code | string |
currency_code |
Scope 1 Emissions
|
emissions_scope1_tco2e | string |
emissions_scope1_tco2e |
Scope 2 Emissions
|
emissions_scope2_tco2e | string |
emissions_scope2_tco2e |
Status of Emissions Data ('modelled', 'updated', 'sourced' or 'no_data')
|
emissions_status | string |
emissions_status |
Tonnes of Carbon Dioxide Equivalent.
|
emissions_total_tco2e | integer |
emissions_total_tco2e |
Total Employees
|
employees_total | integer |
employees_total |
Standard Industrial Classification (UK SIC 2007)
|
uk_sic_2007 | integer |
uk_sic_2007 |
National Identification Number
|
national_identification_number | string |
national_identification_number |
Postcode
|
postcode | string |
postcode |
Province Name
|
province_name | string |
province_name |
Street Address 1
|
street_address_1 | string |
street_address_1 |
Street Address 2
|
street_address_2 | string |
street_address_2 |
Street Address 3
|
street_address_3 | string |
street_address_3 |
Street Address 4
|
street_address_4 | string |
street_address_4 |
Sustainability Report URL
|
sustainability_report_url | string |
sustainability_report_url |
Sustainability Report Year
|
sustainability_report_year | string |
sustainability_report_year |
Total Assets Local
|
total_assets_local | string |
total_assets_local |
waste_hazardous_kg
|
waste_hazardous_kg | string |
waste_hazardous_kg |
Non Hazardous Waste (kg)
|
waste_non_hazardous_kg | string |
waste_non_hazardous_kg |
Status of Waste Data ('modelled', 'updated', 'sourced' or 'no_data')
|
waste_status | string |
waste_status |
Status of Water Data ('modelled', 'updated', 'sourced' or 'no_data')
|
water_status | string |
water_status |
Water Withdrawn
|
water_withdrawn_l | string |
water_withdrawn_l |
Amee Industry Score Icon (URL of score icon, available in 3 styles. Default is style1, to access others replace style string in URL,)
|
amee_industry_score_icon | string |
amee_industry_score_icon |
Line of Business
|
line_of_business | string |
line_of_business |
Latitude
|
lat | float |
lat |
Longitude
|
lon | float |
lon |
Trading Status
|
trading_status | string |
trading_status |