Skip to content

endpoints.md

Latest commit

 

History

History
429 lines (412 loc) · 8.27 KB

endpoints.md

File metadata and controls

429 lines (412 loc) · 8.27 KB
Raw

API V3.0 Endpoints

Authenticate

https://esgperformance.sustainalytics.com/api/3.0/authenticate

Input Parameters

Parameter Example Notes
api_key "abc123" Mandatory
format "json" Must be json or xml. Defaults to json if not present.

Resultset

Field Value Notes
datetime "2021-01-01T00:00:00.000-04:00"
format "json"
result {"token": "a4603ebbe8f819cf0f12386bc7ee359c","expires_on": "2021-01-01T00:00:00.000-04:00"}

Organizations

https://esgperformance.sustainalytics.com/api/3.0/organizations

Input Parameters (truncated)

Parameter Example Notes
token "abc123" Mandatory
format "json" Must be json, xml or csv. Defaults to json if not present.
page 1 Defaults to 1 if not present.
keywords "cloud,infrastructure" A comma-separated list of keywords to search by. Returns companies that match given list.
country CA

Resultset (truncated)

Field Value Notes
id 32344
organization_name "EAP"
description "Supplier of premium widgets" First 100 characters
country "CA"

Input Parameters (robust)

Parameter Example Notes
token "abc123" Mandatory
page 1 Defaults to 1 if not present.
format "json" Must be json, xml or csv. Defaults to json if not present.
is_pinned true Returns pinned companies if true. Otherwise, unpinned companies.
tags "EGB Supplier,Service Provider" A comma-separated list of tags. Returns companies that are tagged with the given tags.
esg_risk_rating_category "negligible" A comma-separated list of rating categories. Returns companies that match given list.
nace_codes "A01.11" A comma-separated list of NACE codes. Returns companies that match given list.
unspsc_codes "10000000,11000000" A comma-separated list of UNSPSC codes. Returns companies that match given list.
naics_codes "111110,121110" A comma-separated list of NAICS codes. Returns companies that match given list.
is_claimed true Returns claimed companies if true. Otherwise, unclaimed companies.
is_verified true Returns verified companies if true. Otherwise, unverified companies.
aboriginal_owned true Returns aboriginal owned companies if true. Otherwise, not aboriginal owned companies.
veteran_owned true Returns veteran owned companies if true. Otherwise, not veteran owned companies.
women_owned true Returns women owned companies if true. Otherwise, not women owned companies.
certifications "ISO 9001,ISO 9002" A comma-separated list of certifications. Returns companies that match given list.
organization_type "Corporation,Association" A comma-separated list of organization types. Returns companies that match given list.
countries_exported_to "CA,US" A comma-separated list of countries. Returns companies that match given list.
keywords "aircraft,helicopters" A comma-separated list of keywords to search by. Returns companies that match given list.

Resultset (robust)

Field Value Notes
id 1
description "All colors, all sizes" First 100 characters
organization_name "EAP"
country "CA"
website "https://esgperformance.sustainalytics.com/"
email "info@eap.com"
aboriginal_owned true
veteran_owned true
women_owned true
languages ["eng","fre"]
key_industrial_capabilities "IT Security Architectures"
year_established 2020
telephone 4379179288
ext 4
is_claimed true
is_verified true
organization_types ["Corporation","Government"]
countries_exported_to ["CA","US"]
annual_sales 1000000
annual_exports 2100000
total_employees 3100
major_clients "EAP"
unspsc_codes "84111700"
naics_codes ["523110","522110"]
nace_codes ["K64.1","K64.11"]
nace_codes ["K64.1","K64.11"]
lei_codes ["959800NEP6XY8CHS8G76","549300QE1RU34T50MR69"]
duns 12345678
certifications ["ISO 9001","ISO 9002"]
alliances ["Aerospace PEI","Aerospace Alberta"]
product_and_services ["Private Banking","Investment Banking"]
is_pinned true
esg_risk_rating_score 0.8
esg_risk_rating_category "negligible"
esg_risk_rating_class "1"
esg_risk_exposure_score 0.8
esg_risk_exposure_category "negligible"
esg_risk_management_score 0.8
esg_risk_management_category "negligible"