Click here for the V2.3 draft version of The CSRHub Specification for REST Access (CSRA) API.
The previous archived versions (1.05, 2.01, 2.1, 2.2) are available below.
The CSRHub Specification for REST Access (CSRA) API
The CSRHub Specification for REST Access (CSRA) API offers a simple way to request information from the CSRHub database. A developer can easily write code that requests CSRHub overall, category or subcategory ratings. Applications can also use the CSRA API to:
- Enter tickers or variants of company names and receive a standard name or CSRHub invariant ID number for any company in the database.
- Request information about companies such as their industry, location (address, city, state, country, zip code, and/or phone number), web site, and/or the web location for their CSR information.
- Request a list of the data sources that have reported information on a company (or a total of the number of sources).
- Request individual data items for any of around 7,000 different data elements from around 512 different data sources.
- Request average values for all companies in an industry or geographic area.
- Request historic data for any month from the present back to December 2008.
CSRA is designed to allow developers to create their applications without requiring support or programming resources from CSRHub. To implement CSRA, developers architect their back-end server to respond to specifically structured REST requests in an expected way. A developer must either begin each session with a login transaction (and then include in each request appropriate authentication credentials) or use a static API key. The CSRHub server inspects these credentials and uses them to associate the request with a user ID and profile ID. It then delivers a profile-adjusted rating to the requesting application. User profile information also determines the default month for the data set that the user receives. Because CSRA is conditioned by user profiles, it is easy for an application to adjust CSRHub ratings to meet the particular views and needs of each different user of the application.
CSRA supplements several other methods that CSRHub provides to those who want to use or redistribute its data. These methods include:
- A remote procedure call-based (RPC-based) widget that can display a snapshot of the ratings for any company in the database. This widget can be installed directly as an HTML call or via a WordPress plug in.
- Stable URLs that point directly to each of the companies that CSRHub tracks.
- Stable URLs for any search that can be executed on the CSRHub site. Using these URLs, a user can reliably refer to all of the companies covered by a source, all companies in a geography or industry, or to all of the companies that are affected by a special issue. These URLs can incorporate complex AND/OR logic.
- A set of function calls that can be embedded in either an Excel or a Google spreadsheet. These calls allow users to integrate CSRHub into their own analysis and charts without the need for developer support.
Click here for the 1.05 draft (old documentation/history) of The CSRHub Specification for REST Access (CSRA) API.
Click here for the V2.01 draft version of The CSRHub Specification for REST Access (CSRA) API.
Click here for the V2.1 draft version of The CSRHub Specification for REST Access (CSRA) API.
Click here for the V2.2 draft version of The CSRHub Specification for REST Access (CSRA) API.