{"id":15062233,"url":"https://github.com/valexe-technologies/lookup.services","last_synced_at":"2025-04-10T10:04:14.976Z","repository":{"id":40703470,"uuid":"368443193","full_name":"ValEXE-Technologies/Lookup.Services","owner":"ValEXE-Technologies","description":"Business Services for Lookup","archived":false,"fork":false,"pushed_at":"2024-06-19T16:46:15.000Z","size":94,"stargazers_count":5,"open_issues_count":5,"forks_count":3,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-24T08:54:41.654Z","etag":null,"topics":["domain-availability","domain-availability-checker","domain-price","domain-registrar","lookup","nodejs","puppeteer"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ValEXE-Technologies.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-18T07:42:50.000Z","updated_at":"2024-08-12T20:13:06.000Z","dependencies_parsed_at":"2025-04-10T10:03:58.075Z","dependency_job_id":null,"html_url":"https://github.com/ValEXE-Technologies/Lookup.Services","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ValEXE-Technologies%2FLookup.Services","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ValEXE-Technologies%2FLookup.Services/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ValEXE-Technologies%2FLookup.Services/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ValEXE-Technologies%2FLookup.Services/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ValEXE-Technologies","download_url":"https://codeload.github.com/ValEXE-Technologies/Lookup.Services/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248198878,"owners_count":21063627,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["domain-availability","domain-availability-checker","domain-price","domain-registrar","lookup","nodejs","puppeteer"],"created_at":"2024-09-24T23:32:46.094Z","updated_at":"2025-04-10T10:04:14.923Z","avatar_url":"https://github.com/ValEXE-Technologies.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lookup.Services\n\n\u003cimg src=\"https://user-images.githubusercontent.com/75196744/123205334-512ea280-d4d7-11eb-9e27-6f974170bbc7.png\" height=\"140\" align=\"right\"\u003e\n\n[![npm @valexe-technologies/lookup.services package](https://img.shields.io/npm/v/@valexe-technologies/lookup.services)](https://www.npmjs.com/package/@valexe-technologies/lookup.services)\n[![github @valexe-technologies/lookup.services issues](https://img.shields.io/github/issues/ValEXE-Technologies/Lookup.Services)](https://github.com/ValEXE-Technologies/Lookup.Services/issues)\n[![github @valexe-technologies/lookup.services forks](https://img.shields.io/github/forks/ValEXE-Technologies/Lookup.Services)](https://github.com/ValEXE-Technologies/Lookup.Services/network/members)\n[![github @valexe-technologies/lookup.services stargazers](https://img.shields.io/github/stars/ValEXE-Technologies/Lookup.Services)](https://github.com/ValEXE-Technologies/Lookup.Services/stargazers)\n[![github @valexe-technologies/lookup.services license](https://img.shields.io/github/license/ValEXE-Technologies/Lookup.Services)](https://github.com/ValEXE-Technologies/Lookup.Services/LICENSE)\n\n\u003e Developes are welcome to extend support to integrate their preferred Domain Registrar\n\n`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.\n\n## Getting Started\n\n### Installation\n\nTo use `Lookup.Services` in your project, run:\n\n```bash\nnpm i @valexe-technologies/lookup.services\n```\n\nor\n\n```bash\nyarn add @valexe-technologies/lookup.services\n```\n\nNote: 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).\n\n## Usage\n\n`Lookup.Services` provides below listed APIs:\n\n- List of supported `Currencies`\n- List of supported `Registrars`\n- Domain name is `Available` or not\n- `Price` of the domain\n\n### **Example -** Supported `Currencies`\n\nSave file as **index.js**\n\n```js\nconst lookupServices = require('@valexe-technologies/lookup.services');\n\n(async () =\u003e {\n    const supportedCurrencies = await lookupServices.SUPPORTED_CURRENCIES;\n\n    console.log(supportedCurrencies);\n})();\n```\n\nExecute script on the command line\n\n```bash\nnode index.js\n```\n\nIt will print list of supported `Currencies` as JSON object.\n\n```json\n[\n  {\n    \"code\": \"INR\",\n    \"symbol\": \"₹\",\n    \"name\": \"Indian Rupee\"\n  },\n  {\n    \"code\": \"USD\",\n    \"symbol\": \"$\",\n    \"name\": \"United States of America\"\n  }\n]\n```\n\n### **Example -** Supported `Registrars`\n\nSave file as **index.js**\n\n```js\nconst lookupServices = require('@valexe-technologies/lookup.services');\n\n(async () =\u003e {\n    const domainServices = new lookupServices.DomainServices();\n    await domainServices\n        .init(\n            false // headless 'false' to show Chromium instance\n        );\n    \n    const supportedRegistrars = await domainServices\n        .domainRegistrarsByCurrency(\n            'INR' // one of the Supported \"Currency Code\"\n        );\n\n    console.log(supportedRegistrars);\n})();\n```\n\nExecute script on the command line\n\n```bash\nnode index.js\n```\n\nIt will print list of supported `Registrars` as JSON object.\n\n```json\n[\n  {\n    \"name\": \"GoDaddy\",\n    \"baseUrl\": \"https://in.godaddy.com\",\n    \"currencyCodes\": [ \"INR\", \"USD\" ],  \n    \"features\": [ \"Basic DNS\" ]\n  },\n  {\n    \"name\": \"BigRock\",\n    \"baseUrl\": \"https://www.bigrock.in\",\n    \"currencyCodes\": [ \"INR\", \"USD\" ],\n    \"features\": [\n      \"Basic DNS\",\n      \"2 Email Accounts\",\n      \"Domain Forwarding\",\n      \"URL Masking\",\n      \"DNS Management\",\n      \"Domain Theft Protection\"\n    ]\n  }\n]\n```\n\n### **Example -** Is Domain `Available` or not\n\nSave file as **index.js**\n\n```js\nconst lookupServices = require('@valexe-technologies/lookup.services');\n\nconst domainTLD = 'com';\nconst randomDomainName = 'whatblarandomdomainxyz';\nconst exampleDomainNameWithTLD = `${randomDomainName}.${domainTLD}`;\n\n(async () =\u003e {\n    const domainServices = new lookupServices.DomainServices();\n    await domainServices\n        .init(\n            false // headless 'false' to show Chromium instance\n        );\n\n    const response = await domainServices\n        .isDomainAvailable(\n            exampleDomainNameWithTLD\n        );\n\n    console.log(response);\n})();\n```\n\nExecute script on the command line\n\n```bash\nnode index.js\n```\n\nIt will print `true` if domain is available or `false` if domain is not available.\n\n```json\ntrue or false\n```\n\n### **Example -** Domain `Price`\n\nSave file as **index.js**\n\n```js\nconst lookupServices = require('@valexe-technologies/lookup.services');\n\nconst domainTLD = 'com';\nconst randomDomainName = 'whatblarandomdomainxyz';\nconst exampleDomainNameWithTLD = `${randomDomainName}.${domainTLD}`;\n\n(async () =\u003e {\n    const domainServices = new lookupServices.DomainServices();\n    await domainServices\n        .init(\n            false // headless 'false' to show Chromium instance\n        );\n\n    const response = await domainServices\n        .domainPrice(\n            'BigRock', // one of the \"Registrar Name\"\n            exampleDomainNameWithTLD,\n            'INR' // one of the Supported \"Currency Code\"\n        );\n\n    console.log(response);\n})();\n```\n\nExecute script on the command line\n\n```bash\nnode index.js\n```\n\nIt will print `Registrar` URL and domain `Price` as JSON object.\n\n```json\n{\n  \"url\": \"https://www.bigrock.in\",\n  \"price\": 799\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalexe-technologies%2Flookup.services","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvalexe-technologies%2Flookup.services","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalexe-technologies%2Flookup.services/lists"}