# awsdomainchecker

> Query Domain Name availability with node.js via Amazon Web Services SDK for various tld sites. Compatible with any Node.js app, just integrate this into your application. Make requests for domain availiability on the fly

Latest version **1.1.0** (published 2022-02-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install awsdomainchecker
pnpm add awsdomainchecker
yarn add awsdomainchecker
bun add awsdomainchecker
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-02-03 |
| First published | 2017-06-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 6.8 KB |
| Known vulnerabilities | 0 (+8 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Sulayman L. Touray |
| Maintainers | mtrotter |
| Keywords | domain search, dns, route 53 query, aws domain api, domain query, route 53 api, aws domain searcher, aws domain sdk |

## Links

- npm: https://www.npmjs.com/package/awsdomainchecker
- Repository: https://github.com/sudir/awsdomainapi
- Homepage: https://github.com/sudir/awsdomainapi#readme
- Issues: https://github.com/sudir/awsdomainapi/issues
- npm.io page: https://npm.io/package/awsdomainchecker

## Dependencies (4)

- [fs](https://npm.io/package/fs.md) 0.0.1-security
- [aws-sdk](https://npm.io/package/aws-sdk.md) 2.77.0
- [express](https://npm.io/package/express.md) 4.15.3
- [body-parser](https://npm.io/package/body-parser.md) 1.17.2

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2022-02-03
- 1.0.4 — 2017-06-29
- 1.0.3 — 2017-06-27

## README

<p align="center"><img width=12.5% src="http://sudirlaycoders.com/files/sclogo.png"></p>
<p align="center"><h1>awsdomainchecker - v1.0.4</h1></p>
<p align="center"><i>Query Domain Name availability with node.js via Amazon Web Services SDK. 
<br />Compatible with any Node.js app, just integrate this into your application. This is great for use with dns management, domain reservation services, or more advanced logic.</i></p>


## Basic Overview
[![Awsdomainapi License](https://img.shields.io/badge/Licensed-Sulayman%20Touray-orange.svg)](https://github.com/sudir/awsdomainchecker/blob/master/LICENSE.txt)
[![awsdomainchecker](https://img.shields.io/badge/awsdomainchecker-npm-blue.svg)](https://www.npmjs.com/package/awsdomainchecker)
[![SudirlayCoders](https://img.shields.io/badge/SudirlayCoders-Experts-brightgreen.svg)](http://www.sudirlaycoders.com)
[![Matt Trotter Code Gaurantee](https://img.shields.io/badge/Fully%20Tested-v1.0.4-red.svg)]()


<ul> Required IAM setup
<li> <i>Need to configure IAM credentials with access to route53</i>
</ul> 

<br />
Using awsdomainchecker is easy, simply export IAM environment variables for route53 access, 
<br>require my module <i>(awsdomainchecker)</i> in your app and your all done!

## Setup IAM Access for runtme environment security 
<i>See here for instaling pip - https://pip.pypa.io/en/stable/installing/</i>
<br />
<i>See here for configuring IAM policy for route53 - http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/access-control-managing-permissions.html</i>
```bash
pip install awscli
aws configure
```

##### Installing awsdomainchecker: standard npm installation
```bash
npm install awsdomainchecker
```

##### Application integration: In your main app.js file, require this module
```javascript
const awsdomainchecker = require('awsdomainchecker');
```


#### Running awsdomainchecker: After you require the module simply start your app 
<i>Running it is easy, anytime your main app starts awsdomainchecker will auto-start</i>
<i>You should get the returned output:</i>
```bash
awsdomainchecker listening on http://localhost:8135
```


## Making changes to listening port
<i>Locate the node_modules folder where you have my module 'awsdomainchecker', edit the index.js and change listening port</i> 
```javascript
port = 8135;
app.listen(port);
```
## See the neatly coded brains of my index.js
```javascript
app.use(bodyparser.urlencoded({extended: true}));
app.use(bodyparser.json());



app.get('/', function(req, res){
    console.log('GET /')

  const html = fs.readFileSync('index.html');
    res.writeHead(200, {'Content-Type': 'text/html'});
    res.end(html);
});

app.post('/', function(req, res){
    console.log('POST /');
    console.dir(req.body);
const route53domains = new AWS.Route53Domains();
res.writeHead(200, {'Content-Type': 'text/html'});
```
## How to test Domain availability?

#### 
During testing, simply use curl to generate post request only specifying the domain name with top level domain. <i>"domainname.tld"</i>. 
<br />You can add sanitization around this from your application UI side once running. Contributors to this project should also be looking
forward to oauth integration coming soon, in the mean-time security is on you to sanitize for the time being.

```bash
curl -d "DomainName=domain.com" localhost:8135
```

<i>You should get the returned output:</i>
```bash
This Domain is: status <UNAVAILABLE> | <AVAILABLE>
```

<i>More to come soon....</i>
<br />Invented By: <i>Sulayman Touray {C.E.O SudirlayCoders}</i>

---
_Source: https://npm.io/package/awsdomainchecker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
