fakefilter 0.1.1401 → 1.1.12

package/README.md

@@ -1,77 +1,27 @@
-# FakeFilter
-The intention of this project is to sweep temporary and fake email addresses from registrations. We collect fake email providers and their domains and want to publish them here in different formats. We want that site owners use this repo as reliable source to find out all fake/temp provider registration attempts.
+# Fakefilter Service
 
-# Why FakeFilter
-There are other lists like https://gist.github.com/adamloving/4401361 , https://disify.com/ , https://github.com/wesbos/burner-email-providers , https://github.com/disposable-email-domains/disposable-email-domains , https://github.com/elliotjreed/disposable-emails-filter-php , https://github.com/Propaganistas/Laravel-Disposable-Email , https://github.com/disposable/disposable  - they do work with submissions. This is greatly appreciated service for the community. We want to thank to them. FakeFilter has different approach: we do actively monitor all known providers and get their domains almost realtime and distribute daily. All our system is automated. Your help is still required; if you submit us new providers, we will write services to watch those providers REALTIME. Users do have rights to fake their emails, but also service providers do have the right to know about this fact. We have nothing against free/fake services, this service aims to be automated and reliable.
+this project will harvest domains of fake/temp-email providers and store them in mysql table.  This project stores everything to mysql database. The `repo/` folder is mapped to `https://github.com/7c/fakefilter` repo which is supposed to be the distribution repo
 
-# Stats
-## Daily Coverage
-Amount of coverage, actions against all known Disposable Email Providers per Day
-![Monthly Coverage](https://fakefilter.net/public/img/dynamic/chart1.png)
+## Testing specific provider for Development
+You may want to start every provider seperatly (for development reasons for example) just by calling `node providers/<name>.js`, this would open the puppeteer in non-headless mode. This will allow you to debug
 
-## Monthly Unique Disposable Domains
-Number of unique known validated Disposable Domains in Total at given Month
-![Monthly Disposable Domains](https://fakefilter.net/public/img/dynamic/chart3.png)
+## Fetching specific provider
+`node fetch.js <providerName> [<providerName> <providerName>]`
 
+## Repo/ folder
+this is seperate [github](https://github.com/7c/fakefilter) repo. Use `repo-update.js` from crontab to populate it. 
 
-## Success Rate Charts
-We monitor every disposable email provider we know about and make charts about success rate in % per day. You can access provider based success rate charts at [here](CHARTS.md)
-
-## Adding new Providers
-Please help us to add new Providers to this list, simply create an issue with the title as providers main sitedomain, this way we can group them by domain. Your help is appreciated.
-
-## Online Formats
-We have implemented a RESTful API, you can check the API at [fakefilter.net](https://fakefilter.net/static/docs/restful/). This database is aimed to serve realtime, so once we detect a new domain, this API will have it. We recommend using the Offline format as backup since we cannot guarantee the uptime.
-
-## Offline Formats
-You may use one of these formats to have access to the information flow in your favorite programming language:
-
-[Markdown](markdown/README.md)
-
-[Json](json/data.json)
-This format supports firstseen,lastseen,randomSubdomain properties
-
-[Json v2](json/data_version2.json)
-A fakedomain might belong to multiple providers, in this format we list their PSL (Public Suffix List) based domain and all known hostnames belonging to this PSL domain. Ths version also supports IDN domains, all domains are punycode.
-
-[Txt](txt/data.txt)
-
-## Expired Domains
-Our service removes domains from fakefilter (json/api/markdown/txt) after a year of inactivity. If these domains reappear, they are reinstated in our database for a minimum of 365 days. You can find the list of expired domains per provider [here](markdown/EXPIRED.md)
-
-## Whitelist
-We whitelist major well-known providers from being blocked from fakefilter, just to make sure we do not add them automatically from our system. Some providers offer @gmail<dot>com emails, adding such domains would be painful for the community.
-
-## Javascript Interface
-We have implemented npm/javascript interface for Javascript Developers as demonstration
-
-`npm i --save fakefilter`
-
-You have to make sure that this npm package is always up2date in order this static implementation to work as designed.
-
-Offline Lookup:
+## repo-update.sh
 ```
-const { isFakeDomain, isFakeEmail } = require('fakefilter')
-
-console.log(isFakeDomain('domain.com'))
-console.log(isFakeEmail('user@domain.com'))
-```
-
-
-Online Lookup:
-
-this version does not throw at all. You either get null (which indicates any error) or false or the object as reply
+--dry   will not write to files
 ```
-## also see examples/online.js
-const { isFakeDomainOnline, isFakeEmailOnline } = require('fakefilter')
 
-console.log(await isFakeDomainOnline('domain.com'))
-console.log(await isFakeEmailOnline('user@domain.com'))
+## chart-update.sh
+this is responsible to draw charts using external module
 
-```
 
+## Docs
+docs/website are/is made with Docusaurus, the source is inside apiserver/docs/. You can use `npm run serve` to develop and `npm run build` to build. This docs page serves as the main entry point for https://fakefilter.net
 
-Test:
-```
-node index.js
-```
+## events.js
+use this tool to pull events for specific provider from mysql

package/apiserver/api/ext_result.js

@@ -0,0 +1,51 @@
+const { reply } = require('../inc/shared')
+const vars = require('../../vars')
+const { validEmail } = require('mybase')
+const { validateParameters } = require('@7c/autovalidate')
+const { getDomainPart, domainFromEmail } = require('../../shared')
+const { Sentry } = require('../../config')
+
+async function api_ext_result(req, res, next) {
+    let validation = validateParameters(req.body,
+        [
+            { key: 'emails', type: ['array'], required: true },
+            { key: 'provider', type: ['string'], required: true },
+        ])
+    if (!validation.validated) return reply(res, { retcode: -50, validation })
+
+    let { provider, emails } = validation.values
+
+    try {
+        for (email of emails) {
+            if (validEmail(email)) {
+                console.log(`adding new email ${email}`)
+                let thedomain = getDomainPart(domainFromEmail(email))
+                await vars.models.Harvested.create({
+                    provider,
+                    t: Date.now(),
+                    domain: thedomain
+                })
+
+                await vars.models.Events.create({
+                    provider,
+                    t: Date.now(),
+                    event: 'fetch',
+                    result: 'success'
+                })
+                console.log(`added new email ${email} domain ${thedomain}`)
+            }
+        }
+
+        return reply(res, {
+            retcode: 200,
+            validation
+        })
+    } catch (err) {
+        console.log(err)
+        Sentry.captureException(err)
+        return reply(res, { retcode: -1 })
+    }
+
+}
+
+module.exports = { api_ext_result }

package/apiserver/api/ext_tasks.js

@@ -0,0 +1,151 @@
+const { reply } = require('../inc/shared')
+const vars = require('../../vars')
+
+
+
+function api_ext_tasks(req, res, next) {
+    let jobs = [
+        {
+            id:'temp-mail.org',
+            start_url:'https://temp-mail.org',
+            domains:['temp-mail.org','www.temp-mail.org'],
+            scripts:['https://code.jquery.com/jquery-3.6.0.min.js','https://fakefilter.net/public/shared.js','https://fakefilter.net/public/temp-mail.org.js'],
+            remind_every:18 // hours
+        },
+        {
+            id:'10minemail.com',
+            start_url:'https://10minemail.com',
+            domains:['10minemail.com','www.10minemail.com'],
+            scripts:['https://code.jquery.com/jquery-3.6.0.min.js','https://fakefilter.net/public/shared.js','https://fakefilter.net/public/10minemail.com.js'],
+            remind_every:18 // hours
+        },
+        
+        {
+            id:'throwawaymail.com',
+            start_url:'https://throwawaymail.com',
+            domains:['throwawaymail.com','www.throwawaymail.com'],
+            scripts:['https://code.jquery.com/jquery-3.6.0.min.js','https://fakefilter.net/public/shared.js','https://fakefilter.net/public/throwawaymail.com.js'],
+            remind_every:48 // hours   
+        },         
+      
+        {
+            id:'crazymailing.com',
+            start_url:'https://crazymailing.com',
+            domains:['crazymailing.com','www.crazymailing.com'],
+            scripts:['https://code.jquery.com/jquery-3.6.0.min.js',
+            'https://fakefilter.net/public/shared.js',
+            'https://fakefilter.net/public/crazymailing.com.js'],
+            remind_every:78 // hours   
+        },
+
+
+        {
+            id:'gettempmail.com',
+            start_url:'https://gettempmail.com',
+            domains:['gettempmail.com','www.gettempmail.com'],
+            scripts:['https://code.jquery.com/jquery-3.6.0.min.js',
+            'https://fakefilter.net/public/shared.js',
+            'https://fakefilter.net/public/gettempmail.com.js'],
+            remind_every:18 // hours   
+        },
+        {
+            id:'tempmailid.com',
+            start_url:'https://tempmailid.com',
+            domains:['tempmailid.com','www.tempmailid.com'],
+            scripts:['https://code.jquery.com/jquery-3.6.0.min.js',
+            'https://fakefilter.net/public/shared.js',
+            'https://fakefilter.net/public/tempmailid.com.js'],
+            remind_every:78 // hours   
+        },
+
+        {
+            id:'10minutemail.com',
+            start_url:'https://10minutemail.com',
+            domains:['10minutemail.com','www.10minutemail.com'],
+            scripts:['https://code.jquery.com/jquery-3.6.0.min.js',
+            'https://fakefilter.net/public/shared.js',
+            'https://fakefilter.net/public/10minutemail.com.js'],
+            remind_every:18 // hours   
+        },
+
+
+        {
+            id:'10minuteemails.com',
+            start_url:'https://10minuteemails.com',
+            domains:['10minuteemails.com','www.10minuteemails.com'],
+            scripts:['https://code.jquery.com/jquery-3.6.0.min.js',
+            'https://unpkg.com/validator@latest/validator.min.js',
+            'https://fakefilter.net/public/shared.js',
+            'https://fakefilter.net/public/10minuteemails.com.js'],
+            remind_every:17 // hours   
+        },
+
+        {
+            id:'tempmail.net',
+            start_url:'https://tempmail.net',
+            domains:['tempmail.net','www.tempmail.net'],
+            scripts:['https://code.jquery.com/jquery-3.6.0.min.js',
+            'https://unpkg.com/validator@latest/validator.min.js',
+            'https://fakefilter.net/public/shared.js',
+            'https://fakefilter.net/public/tempmail.net.js'],
+            remind_every:36 // hours   
+        },
+        {
+            id:'onetempmail.com',
+            start_url:'https://onetempmail.com',
+            domains:['onetempmail.com','www.onetempmail.com'],
+            scripts:['https://code.jquery.com/jquery-3.6.0.min.js',
+            'https://unpkg.com/validator@latest/validator.min.js',
+            'https://fakefilter.net/public/shared.js',
+            'https://fakefilter.net/public/onetempmail.com.js'],
+            remind_every:36 // hours   
+        },
+        {
+            id:'tempmail.com.tr',
+            start_url:'https://tempmail.com.tr',
+            domains:['tempmail.com.tr','www.tempmail.com.tr'],
+            scripts:['https://code.jquery.com/jquery-3.6.0.min.js',
+            'https://unpkg.com/validator@latest/validator.min.js',
+            'https://fakefilter.net/public/shared.js',
+            'https://fakefilter.net/public/tempmail.com.tr.js'
+            ],
+            // 'https://fakefilter.net/public/thnen.com.js'],
+            remind_every:36 // hours   
+        },
+        {
+            id:'tempmailo.org',
+            start_url:'https://tempmailo.org',
+            domains:['tempmailo.org'],
+            scripts:['https://code.jquery.com/jquery-3.6.0.min.js',
+            'https://unpkg.com/validator@latest/validator.min.js',
+            'https://fakefilter.net/public/shared.js',
+            'https://fakefilter.net/public/tempmailo.org.js'
+            ],
+            // 'https://fakefilter.net/public/thnen.com.js'],
+            remind_every:36 // hours   
+        },
+
+        // {
+        //     id:'tempmailid.com',
+        //     start_url:'https://tempmailid.com',
+        //     click_to:'input#random[type="submit"]',
+        //     preconditions:[
+        //         'div#email_id',
+        //     ],
+
+        //     send:'body',
+        //     remind_every:18 // hours
+        // },
+    ]
+
+    return reply(res, {
+        retcode: 200,
+        jobs,
+        config:{
+            fetch_config: 6 // fetch the config every 6 hours
+        }
+        
+    })
+}
+
+module.exports = { api_ext_tasks }

package/apiserver/api/is_fakedomain.js

@@ -0,0 +1,39 @@
+const punycode = require('punycode/')
+const { reply } = require('../inc/shared')
+const { validateParameters } = require('@7c/autovalidate')
+const { validHostname } = require('mybase')
+const vars = require('../../vars')
+const { is_domain_banned } = require('../../shared')
+
+// GET
+function api_is_fakedomain(req, res, next) {
+    let response = validateParameters(req.params, [{ key: 'domain', type: ['string'], validator: (v) => v.search(/\./) > 0 }])
+    let { validated } = response
+    if (!validated) return reply(res, { retcode: -50 })
+    let { domain } = response.values
+    let original_domain = domain
+
+    // is it an idn domain (unicode formatted)
+    if (punycode.toASCII(domain)!==domain) 
+        domain = punycode.toASCII(domain)
+    
+    if (!validHostname(domain))  return reply(res, { retcode: -50 })
+
+    try {
+        let outcome = is_domain_banned(domain,vars.current_filter)
+        if (outcome!==null) { // null indicates problem with the domain
+            vars.coadmin_service_apiserver.report_every(1,'is_fakedomain')
+            return reply(res, {
+                retcode: 200,
+                isFakeDomain:typeof outcome==='object' ? original_domain : false,
+                details: typeof outcome==='object' ? outcome : null
+            })
+        }        
+    } catch (err) {
+        console.log(err)
+        Sentry.captureException(err)
+    }
+    return reply(res, { retcode: -1 })
+}
+
+module.exports = { api_is_fakedomain }

package/apiserver/api/is_fakeemail.js

@@ -0,0 +1,17 @@
+const { reply, hostnameFromEmailAddress } = require('../inc/shared')
+const { validateParameters } = require('@7c/autovalidate')
+const { validEmail } = require('mybase')
+const vars = require('../../vars')
+const { api_is_fakedomain } = require('./is_fakedomain')
+
+// GET
+function api_is_fakeemail(req, res, next) {
+    let response = validateParameters(req.params, [{ key: 'email', type: ['string'], validator: (v) => validEmail(v) }])
+    let { validated, values } = response
+    if (!validated) return reply(res, { retcode: -50 })
+    let { email } = response.values
+    req.params.domain = hostnameFromEmailAddress(email)
+    api_is_fakedomain(req,res,next)
+}
+
+module.exports = { api_is_fakeemail }

package/apiserver/api/ping.js

@@ -0,0 +1,12 @@
+const { reply } = require('../inc/shared')
+// var debug=require('debug')('apiserver')
+
+// GET
+function api_ping (req, res, next) {
+    reply(res,{
+        retcode: 200,
+        message: 'pong',
+    })
+}
+
+module.exports = { api_ping }

package/apiserver/docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

package/apiserver/docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

package/apiserver/docs/blog/2019-05-28-first-blog-post.md

@@ -0,0 +1,12 @@
+---
+slug: first-blog-post
+title: First Blog Post
+authors:
+  name: Gao Wei
+  title: Docusaurus Core Team
+  url: https://github.com/wgao19
+  image_url: https://github.com/wgao19.png
+tags: [hola, docusaurus]
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

package/apiserver/docs/blog/2019-05-29-long-blog-post.md

@@ -0,0 +1,44 @@
+---
+slug: long-blog-post
+title: Long Blog Post
+authors: endi
+tags: [hello, docusaurus]
+---
+
+This is the summary of a very long blog post,
+
+Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
+
+<!--truncate-->
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

package/apiserver/docs/blog/2021-08-01-mdx-blog-post.mdx

@@ -0,0 +1,20 @@
+---
+slug: mdx-blog-post
+title: MDX Blog Post
+authors: [slorber]
+tags: [docusaurus]
+---
+
+Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
+
+:::tip
+
+Use the power of React to create interactive blog posts.
+
+```js
+<button onClick={() => alert('button clicked!')}>Click me!</button>
+```
+
+<button onClick={() => alert('button clicked!')}>Click me!</button>
+
+:::

package/apiserver/docs/blog/2021-08-26-welcome/index.md

@@ -0,0 +1,25 @@
+---
+slug: welcome
+title: Welcome
+authors: [slorber, yangshun]
+tags: [facebook, hello, docusaurus]
+---
+
+[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
+
+Simply add Markdown files (or folders) to the `blog` directory.
+
+Regular blog authors can be added to `authors.yml`.
+
+The blog post date can be extracted from filenames, such as:
+
+- `2019-05-30-welcome.md`
+- `2019-05-30-welcome/index.md`
+
+A blog post folder can be convenient to co-locate blog post images:
+
+![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
+
+The blog supports tags as well!
+
+**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.

package/apiserver/docs/blog/authors.yml

@@ -0,0 +1,17 @@
+endi:
+  name: Endilie Yacop Sucipto
+  title: Maintainer of Docusaurus
+  url: https://github.com/endiliey
+  image_url: https://github.com/endiliey.png
+
+yangshun:
+  name: Yangshun Tay
+  title: Front End Engineer @ Facebook
+  url: https://github.com/yangshun
+  image_url: https://github.com/yangshun.png
+
+slorber:
+  name: Sébastien Lorber
+  title: Docusaurus maintainer
+  url: https://sebastienlorber.com
+  image_url: https://github.com/slorber.png

package/apiserver/docs/docs/intro.md

@@ -0,0 +1,16 @@
+---
+sidebar_position: 1
+---
+
+# About FakeFilter
+
+FakeFilter`s aim is to monitor Fake/Temp Email providers and offer site operators the chance to distinguish between fake- and real emails. Even though anonimity is a right of clients, site operators also do have rights to know about this. This way they can decide whether they want to accept registrations or not.
+
+## Repo
+
+Main repo can be found at [Github](https://github.com/7c/fakefilter/), this repo hosts different formats such as [JSON](https://github.com/7c/fakefilter/blob/main/json/data.json), [Markdown](https://github.com/7c/fakefilter/tree/main/markdown), [Txt](https://github.com/7c/fakefilter/blob/main/txt/data.txt). These formats are designed for you to implement FakeFilter into different backends.
+
+## Offline databases
+
+Offline Database is distributed through the repo, updated daily at 00:00 UTC time in different formats. You may `git pull` the repo right after 00:00 UTC to get latest formats. You may also `npm update` to get latest npm package if you are using NodeJS. We increase the package version daily.
+

package/apiserver/docs/docs/nodejs/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "NodeJS API",
+  "position": 2
+}

package/apiserver/docs/docs/nodejs/index.md

@@ -0,0 +1,30 @@
+# NodeJS API
+
+## Installation
+`npm i --save fakefilter`
+
+## Usage
+We provide isFakeDomain and isFakeEmail functions to be implemented from NodeJS.Both return boolean `false` if there is no match, otherwise they will return the domain which has matched
+
+
+### Basic Usage
+See [index.js](https://github.com/7c/fakefilter/blob/82c5fe3851418813d605a678e48b34d84bad3fcc/index.js#L40) for tests and how to use it.
+
+```
+const { isFakeDomain, isFakeEmail } = require('fakefilter')
+
+console.log(isFakeDomain('domain.com')) // will return false
+console.log(isFakeEmail('user@domain.com')) // will return false
+
+// domain lookup
+console.log(isFakeDomain('afakedomain.com')) // will return 'afakedomain.com'
+console.log(isFakeDomain('sub.afakedomain.com')) // will return 'afakedomain.com'
+console.log(isFakeDomain('subafakedomain.com')) // will return false
+
+// email lookup
+console.log(isFakeEmail('user@afakedomain.com')) // will return 'afakedomain.com'
+console.log(isFakeEmail('user@sub.afakedomain.com')) // will return 'afakedomain.com'
+console.log(isFakeEmail('user@asubafakedomain.com')) // will return false
+
+```
+

package/apiserver/docs/docs/restful/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "RESTful API",
+  "position": 3
+}

package/apiserver/docs/docs/restful/index.md

@@ -0,0 +1,59 @@
+# RESTFul API
+
+fakefilter providers a RESTFul API for `isFakeDomain` and `isFakeEmail` functionalities. The queries are more recent than offline versions but we do not provide any reliability of our backend. You may want to try..catch and use offline versions in case our endpoint is down
+
+
+## API
+
+### GET /api/ping
+Use this endpoint to see if our backend is ready
+```
+curl https://fakefilter.net/api/ping
+{
+  "retcode": 200,
+  "message": "pong"
+}
+```
+
+### GET /api/is/fakedomain/:domain
+```
+curl https://fakefilter.net/api/is/fakedomain/fakefilter.net
+{
+  "retcode": 200,
+  "isFakeDomain": false,
+  "details": null
+}
+
+curl https://fakefilter.net/api/is/fakedomain/10minmail.de
+{
+  "retcode": 200,
+  "isFakeDomain": "10minmail.de",
+  "details": {
+    "provider": "muellmail.com",
+    "firstseen": 1646140000,
+    "lastseen": 1646140000,
+    "randomSubdomain": false
+  }
+}
+```
+### GET /api/is/fakeemail/:email
+```
+curl https://fakefilter.net/api/is/fakeemail/user@fakefilter.net
+{
+  "retcode": 200,
+  "isFakeEmail": false,
+  "details": null
+}
+
+curl https://fakefilter.net/api/is/fakeemail/10minmail.de
+{
+  "retcode": 200,
+  "isFakeEmail": "10minmail.de",
+  "details": {
+    "provider": "muellmail.com",
+    "firstseen": 1646140000,
+    "lastseen": 1646140000,
+    "randomSubdomain": false
+  }
+}
+```