@tgwf/url2green

An npm module for quickly checking a domain against the The Green Web Foundation url2green dataset

Usage no npm install needed!

<script type="module">
  import tgwfUrl2green from 'https://cdn.skypack.dev/@tgwf/url2green';
</script>

README

url2green-js

An npm module for local analysis and checks of domains against the Green Web Foundation datasets.

Normally you can check domain against the The Green Web Foundation url2green dataset, the co2 module. Assuming you have installed it with npm install @tgwf/co2, you can then check a domain like so:


const greencheck = require('@tgwf/hosting')

// returns true if green, otherwise false
greencheck.check("google.com")

// returns an array of the green domains, in this case ["google"].
greencheck.check(["google.com", "kochindustries.com"])"]

Usage

The above checks work by sending a request to the Green Web Foundation Greencheck API, visible at api.thegreenwebfoundation.org.

For speed, privacy or reliability reasons, you may prefer to perform the same kinds of checks against the url2green dataset, a local snapshot of the dataset used when hitting the API.

To do so, install this module with npm install @tgwf/url2green. You can then use the same API to check against a local SQLite database.


const hostingDB = require('@tgwf/hosting-database');

// returns true if green, otherwise false
hostingDB.check("google.com", "path/to/database.db");

// returns an array of the green domains, in this case ["google.
hostingDB.check(["google.com", "kochindustries.com"], "path/to/database.db");

Fetching the latest copy of the url2green dataset

By default, the url2green module includes a recent copy of the url2green dataset, and is accessible at data/url2green.db.

You can generate a simple JSON list of the domains to check against, with dumpDomains.

const hostingDB = require('@tgwf/hosting-database');

hostingDB.dumpDomains("path/to/database.db", "path/to/output.json");

In cases where you don't want to rely on SQLite, this will generate a JSON file that allows you to perform the same lookups, using the @tgwf/co2 module.

Fetching updated snapshots from the Green Web Foundation

You can fetch the most recent copy of the url2green dataset from The Green Web Foundation.

https://www.thegreenwebfoundation.org/green-web-datasets/

Licensing

We encourage the use of this in tooling and services, where you might rely on the Green Web Foundation Greencheck API - this helps with managing load on our servers, and we hope it will enable uses we haven't thought of yet. If you have questions, please file an issue

The code is licensed under the Apache 2.0 license.

The dataset is provided under the Open Database License