Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/valexe-technologies/lookup.services
Business Services for Lookup
https://github.com/valexe-technologies/lookup.services
domain-availability domain-availability-checker domain-price domain-registrar lookup nodejs puppeteer
Last synced: 4 months ago
JSON representation
Business Services for Lookup
- Host: GitHub
- URL: https://github.com/valexe-technologies/lookup.services
- Owner: ValEXE-Technologies
- License: gpl-3.0
- Created: 2021-05-18T07:42:50.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-19T16:46:15.000Z (7 months ago)
- Last Synced: 2024-10-12T22:22:06.032Z (4 months ago)
- Topics: domain-availability, domain-availability-checker, domain-price, domain-registrar, lookup, nodejs, puppeteer
- Language: TypeScript
- Homepage:
- Size: 91.8 KB
- Stars: 5
- Watchers: 0
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lookup.Services
[](https://www.npmjs.com/package/@valexe-technologies/lookup.services)
[](https://github.com/ValEXE-Technologies/Lookup.Services/issues)
[](https://github.com/ValEXE-Technologies/Lookup.Services/network/members)
[](https://github.com/ValEXE-Technologies/Lookup.Services/stargazers)
[](https://github.com/ValEXE-Technologies/Lookup.Services/LICENSE)
> Developes are welcome to extend support to integrate their preferred Domain Registrar
`Lookup.Services` is a [Node](https://nodejs.dev/) library which provides a high-level API to check the availability of the internet domain and price across supported registrars.
## Getting Started
### Installation
To use `Lookup.Services` in your project, run:
```bash
npm i @valexe-technologies/lookup.services
```
or
```bash
yarn add @valexe-technologies/lookup.services
```
Note: When you install `Lookup.Services`, it downloads a recent version of [Puppeteer](https://github.com/puppeteer/puppeteer) along with Chromium that is guaranteed to work with the API. To skip the download of Chromium, download into another path, or download a different browser, see [Puppeteer Environment variables](https://github.com/puppeteer/puppeteer/blob/v10.0.0/docs/api.md#environment-variables).
## Usage
`Lookup.Services` provides below listed APIs:
- List of supported `Currencies`
- List of supported `Registrars`
- Domain name is `Available` or not
- `Price` of the domain
### **Example -** Supported `Currencies`
Save file as **index.js**
```js
const lookupServices = require('@valexe-technologies/lookup.services');
(async () => {
const supportedCurrencies = await lookupServices.SUPPORTED_CURRENCIES;
console.log(supportedCurrencies);
})();
```
Execute script on the command line
```bash
node index.js
```
It will print list of supported `Currencies` as JSON object.
```json
[
{
"code": "INR",
"symbol": "₹",
"name": "Indian Rupee"
},
{
"code": "USD",
"symbol": "$",
"name": "United States of America"
}
]
```
### **Example -** Supported `Registrars`
Save file as **index.js**
```js
const lookupServices = require('@valexe-technologies/lookup.services');
(async () => {
const domainServices = new lookupServices.DomainServices();
await domainServices
.init(
false // headless 'false' to show Chromium instance
);
const supportedRegistrars = await domainServices
.domainRegistrarsByCurrency(
'INR' // one of the Supported "Currency Code"
);
console.log(supportedRegistrars);
})();
```
Execute script on the command line
```bash
node index.js
```
It will print list of supported `Registrars` as JSON object.
```json
[
{
"name": "GoDaddy",
"baseUrl": "https://in.godaddy.com",
"currencyCodes": [ "INR", "USD" ],
"features": [ "Basic DNS" ]
},
{
"name": "BigRock",
"baseUrl": "https://www.bigrock.in",
"currencyCodes": [ "INR", "USD" ],
"features": [
"Basic DNS",
"2 Email Accounts",
"Domain Forwarding",
"URL Masking",
"DNS Management",
"Domain Theft Protection"
]
}
]
```
### **Example -** Is Domain `Available` or not
Save file as **index.js**
```js
const lookupServices = require('@valexe-technologies/lookup.services');
const domainTLD = 'com';
const randomDomainName = 'whatblarandomdomainxyz';
const exampleDomainNameWithTLD = `${randomDomainName}.${domainTLD}`;
(async () => {
const domainServices = new lookupServices.DomainServices();
await domainServices
.init(
false // headless 'false' to show Chromium instance
);
const response = await domainServices
.isDomainAvailable(
exampleDomainNameWithTLD
);
console.log(response);
})();
```
Execute script on the command line
```bash
node index.js
```
It will print `true` if domain is available or `false` if domain is not available.
```json
true or false
```
### **Example -** Domain `Price`
Save file as **index.js**
```js
const lookupServices = require('@valexe-technologies/lookup.services');
const domainTLD = 'com';
const randomDomainName = 'whatblarandomdomainxyz';
const exampleDomainNameWithTLD = `${randomDomainName}.${domainTLD}`;
(async () => {
const domainServices = new lookupServices.DomainServices();
await domainServices
.init(
false // headless 'false' to show Chromium instance
);
const response = await domainServices
.domainPrice(
'BigRock', // one of the "Registrar Name"
exampleDomainNameWithTLD,
'INR' // one of the Supported "Currency Code"
);
console.log(response);
})();
```
Execute script on the command line
```bash
node index.js
```
It will print `Registrar` URL and domain `Price` as JSON object.
```json
{
"url": "https://www.bigrock.in",
"price": 799
}
```