这是一个帮助客户访问和QA持续分析数据的包
sustainalytics的Python项目详细描述
简介
这个python包提供了对Sustainalytics API(应用程序编程接口)服务的访问,该服务为开发人员提供了对Sustainalytics的全天候编程访问™ 数据。API是根据市场标准开发的,主要关注安全连接和易用性。它允许用户检索Sustainalytics数据并将其集成到自己的内部系统和定制或第三方应用程序中
本文档旨在为开发人员提供关于Sustainalytics的python示例代码™ API服务。 技术文档也可以在API专用的website上找到。在
安装
连接
要访问API,Sustainalytics团队必须提供clientid和密钥。 请参见python连接
fromsustainalytics.apiimportAPI#Accessclient_id='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'client_secret_key='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'api=API(client_id,client_secret_key)#To verify print token or access headersprint(api.access_headers)
终点
获取产品结构和定义
每个产品都是从data packages构建的,每个数据包都是从field clusters构建的。datafields是产品结构中最小的组件。在
产品结构服务提供Sustainalytics API中可用数据字段的概述,以及链接到每个数据字段的唯一的FieldIds。在这个服务中有三个端点,如下所述。在
下面的代码向您展示了如何从这些端点提取数据
^{pr2}$获取报告
ReportService端点允许用户按ReportId、ReportType和ReportName检索属于access范围的公司的所有可用PDF报告类型的列表。在
下面的代码向您展示了如何从这些端点提取数据
####ReportService#gives all the available report fieldIDs (reportids)report_info=api.get_pdfReportInfo(dtype='dataframe')#by default dtype='json'print(report_info)####ReportService(identifier)(reportid)#replace x with any EntityId (or another security identifier) and y with any reportid. #Multiple values for identifiers and reportids can also be used#returns the url to given pdf report for specified companies (if available)report_identifier_reportid=api.get_pdfReportUrl(identifier='x',reportId='y')print(report_identifier_reportid)
访问范围
UniverseFaccess端点允许用户确定访问范围中包含的实体ID列表(所有许可的证券列表)。在
####UniverseofAccessuniverse=api.get_universe_access(dtype='dataframe')#by default dtype='json'#gets all universe constituentsprint(universe)
#UniverseOfAcesss EntityIdsentityIds=api.get_universe_entityIds(keep_duplicates=True)
获取持续分析数据
数据服务允许用户调用与访问范围内的公司相关联的研究数据。在这个服务中有两个端点,如下所述。在
下面的代码向您展示了如何从这些端点提取数据
获取数据
通过传递以下参数从数据服务终结点检索数据。 只能将标识符参数和其他参数之一组合
- 标识符:安全标识符或实体标识符的列表,用逗号。你可以从api.get_universe_entityIds(保持重复=真)
- 产品标识:产品标识的列表,用逗号。你可以从api.get_产品标识()
- packageIds:由分隔的包id的列表逗号。你可以从获取包ID的列表api.get_包ID()
- fieldClusterID:字段群集ID的列表,用逗号。你可以从获取FieldClusterID的列表api.get_fieldclusterID()
- 字段ID:字段ID的列表,用逗号。你可以从api.get_字段ID()
# a = identifierlist, b = productIdlist , c = packageIdList, d = fieldClusterList, fieldIdListdata=api.get_data(identifiers='a',productIds='b',packageIds='c',fieldClusterIds='d',fieldIds='e')print(data)
- 项目
标签: