API

A public API to check the green credentials of third-party services used on websites.

This page contains a guide on how to get started with the API. Currently you can use to query the name (or partial name) of a third-party service. The API will return any matching results, including a list of known and green domains for that service, and a green rating. Other endpoints may be added at a later date.

This API is free for public use.

If you do end up using it on a project, I'd love to know!! Please also consider supporting this project.

Email me Support this project

API documentation

Query by service name

The name endpoint allows you to query the name of the third-party service. The endpoint returns any matching results, including a list of known and green domains for that service, and a green rating.

Endpoint

https://api.aremythirdpartiesgreen.com/name/THIRD_PARTY_NAME

Required parameters

THIRD_PARTY_NAME

Type: String

The full, or partial, name of a third party service. Spaces are also accepted.

For example: google would return all entities with 'Google' in the title, while google maps would return only the 'Google Maps' entity.

Example valid requests

Request

https://api.aremythirdpartiesgreen.com/name/google maps

Response

{
  "version": "1.0.0",
  "results": [
    {
      "name": "Google Maps",
      "company": "Google",
      "homepage": "https://www.google.com/maps",
      "categories": [
        "utility"
      ],
      "knownDomains": [
        "maps.google.com",
        "maps-api-ssl.google.com",
        "maps.googleapis.com",
        "mts.googleapis.com",
        "maps.gstatic.com"
      ],
      "greenDomains": [
        "maps.google.com",
        "maps-api-ssl.google.com",
        "maps.googleapis.com",
        "mts.googleapis.com",
        "maps.gstatic.com"
      ],
      "greenRating": "green"
    }
  ]
}

Response object

version

Type: String

The current version of the API. Included just in case future changes are made.
results

Type: Array

An array of results that match the searched query string.

Result object

name

Type: String

The name of the third-party service.
company

Type: String

The company that provides the third-party service (if available).
homepage

Type: String

The url of the third-party service (if available).
categories

Type: Array

An array of strings representing the categories of the third-party.
knownDomains

Type: Array

An array of strings listing the known domains used by the third-party service.
greenDomains

Type: Array

An array of strings listing the domains used by the third-party service identified as using green web hosting.
greenRating

Type: String

The green rating of the third-party service. There are three possible values:
- none: No green hosts are used.
- partial: Some green hosts are used.
- green: All domains use green hosts.

Query by company

The company endpoint allows you to query for the company providing a third-party services. The endpoint returns any matching results, including a list of known and green domains for that service, and a green rating.

Endpoint

https://api.aremythirdpartiesgreen.com/company/COMPANY_NAME

Required parameters

COMPANY_NAME

Type: String

The full, or partial, name of a company. Spaces are also accepted.

Example valid requests

Request

https://api.aremythirdpartiesgreen.com/company/adthink

Response

{
  "version": "1.0.0",
  "results": [
    {
      "name": "Adthink",
      "company": "Adthink Media",
      "categories": [
        "ad"
      ],
      "knownDomains": [
        "adxcore.com",
        "dcoengine.com"
      ],
      "greenDomains": [],
      "greenRating": "none"
    },
    {
      "name": "AdThink AudienceInsights",
      "company": "AdThink Media",
      "categories": [
        "analytics"
      ],
      "knownDomains": [
        "audienceinsights.net"
      ],
      "greenDomains": [],
      "greenRating": "none"
    }
  ]
}

Response object

version

Type: String

The current version of the API. Included just in case future changes are made.
results

Type: Array

An array of results that match the searched query string.

Result object

name

Type: String

The name of the third-party service.
company

Type: String

The company that provides the third-party service (if available).
homepage

Type: String

The url of the third-party service (if available).
categories

Type: Array

An array of strings representing the categories of the third-party.
knownDomains

Type: Array

An array of strings listing the known domains used by the third-party service.
greenDomains

Type: Array

An array of strings listing the domains used by the third-party service identified as using green web hosting.
greenRating

Type: String

The green rating of the third-party service. There are three possible values:
- none: No green hosts are used.
- partial: Some green hosts are used.
- green: All domains use green hosts.

Query by URL

The url endpoint allows you to query the URL of a third-party request. The endpoint checks the domain of the URL provided, and returns any matching results.

Endpoint

https://api.aremythirdpartiesgreen.com/url/FULL_URL

Required parameters

FULL_URL

Type: URL

A full URL string for the third-party request to be checked. Must be a valid URL format.

Example valid requests

Request

https://api.aremythirdpartiesgreen.com/url/https://snap.licdn.com/li.lms-analytics/insight.min.js

Response

{
  "version": "1.0.0",
  "source": "https://snap.licdn.com/li.lms-analytics/insight.min.js",
  "results": [
    {
      "url": "licdn.com",
      "name": "LinkedIn Ads",
      "green": false,
      "categories": [
        "ad"
      ]
    }
  ]
}

Response object

version

Type: String

The current version of the API. Included just in case future changes are made.
source

Type: String

The URL being checked.
results

Type: Array

An array of results that match the searched query string.

Result object

url

Type: String

The domain associated with the URL being checked.
name

Type: String

The name of the third-party service.
company

Type: String

The company that provides the third-party service (if available).
green

Type: Boolean

Whether the third-party service is using green web hosting.
categories

Type: Array

An array of strings representing the categories of the third-party.

Legal

Disclaimer

The information on the third-parties (“entities”) is drawn from the third-party-web repository open-source dataset. The Green Web Foundation's (GFW) dataset is used to determine if a third-party resource is hosted in a data center that uses green energy. Both of these datasets are used in good faith. There may be cases of errors in the source data which have not yet been detected.

Therefore no promises are made as to the quality of entities data.

Limitation of Liability

The 'Are my third parties green?' API is provided “AS IS” and on an “IS AVAILABLE” basis without any representations or any kind of warranty made (whether express or implied by law) to the extent permitted by law, including the implied warranties of satisfactory quality, fitness for a particular purpose, non-infringement, compatibility, security and accuracy.

Under no circumstances will we be liable for any of the following losses or damage (whether such losses were foreseen, foreseeable, known or otherwise): (a) loss of data; (b) loss of revenue or anticipated profits; (c) loss of business; (d) loss of opportunity; (e) loss of goodwill or injury to reputation; (f) losses suffered by third parties; or (g) any indirect, consequential, special or exemplary damages arising from the use of Green Web Datasets, regardless of the form of action.