API Reference

  1. Getting Started
  2. Method calls
    1. GET companies/
    2. GET metrics/
1. Getting Started

Numerous sources were processed with easIE and numerous metrics about numerous companies were obtained. Thus, on the top of this data, a RESTful API was developed to make these data available to thrird parties. The API returns data as JSON. The endpoint is easie.iti.gr/easIE/csr_api and two basic methods are available.

2. Method Calls

As we have already mentioned, the API is offering two basic methods to access the collected CSR data. Below, we describe in more detail the calls, the available parameters and a number of examples are given.

2.1 GET companies/
This method is responsible for returning a collection of companies, whose name matches a given search term. If no query is defined then the method returns all the available companies in the database. There are several parameters that users can define in order to limit the results. In Table 1, all the available parameters with a small description of GET companies/ method are presented.

Table 1: Available options of GET companies/ method

Examples

(i) Return all companies that contain "Apple" and are located in the United States:

http://easie.iti.gr/csr_api/companies?q=Apple&country=united states

(ii) Return the third page of the results of companies located in Greece:

http://easie.iti.gr/csr_api/companies?country=greece&p=3
2.2 GET metrics

This method is responsible for returning a collection of metrics, whose name matches a given search term. If no query is defined then the method returns all the available metrics in the database. Users can search metrics by name, value, source name and citation year. In Table 2, all the available parameters with a small description of GET metrics/ method are presented.

Table 2: Available options of GET metrics/ method

Examples

(i) Return all the available Conflict Minerals Reports regarding year 2014

http://easie.iti.gr/csr_api/metrics?name=Conflict Minerals Report&citeyear=2014

(ii) Return all the available metrics concerning company with id:"564e1ab8eebeb8dabcb3c7aa" (Becton, Dickinson & Co.)

http://easie.iti.gr/csr_api/metrics?company=564e1ab8eebeb8dabcb3c7aa