Lookup.Api

Lookup.Api is a Node library which provides the RESTApi wrapper over Lookup.Services.

Getting Started

To setup and run Lookup.Api in your local machine, follow 3 simple steps:

Clone github Repo

git clone https://github.com/ValEXE-Technologies/Lookup.Api.git

Install npm packages

npm i

Run

npm run start

This should start nodemon secure server on Port# 5001 and you should see message on console

Lookup RESTApi listening at https://localhost:5001

RESTApi

Check Status

The status API to check whether application is up and running and is in healthy state to serve the requests.

/api/status

Usage

curl https://localhost:5001/api/status

Response

{
  "status": "Successful",
  "message": "Lookup RESTApi is up and running",
  "data": null
}

Supported Currencies

/api/referenceData/currencies

Usage

curl https://localhost:5001/api/referenceData/currencies

Response

Returns JSON object with value of data property as collection of supported currencies.

{
  "status": "Successful",
  "message": null,
  "data": [
    {
        "code": "INR",
        "symbol": "₹",
        "name": "Indian Rupee"
    },
    {
        "code": "USD",
        "symbol": "$",
        "name": "United States of America"
    }
  ]
}

Registrars

:currency must be value of currency code from Supported Currencies; like INR, USD, etc.

/api/domain/:currency/registrars

Usage

curl https://localhost:5001/api/domain/INR/registrars

Response

Returns JSON object with value of data property as collection of registrars.

{
  "status": "Successful",
  "message": null,
  "data": [
    {
        "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"
        ]
    }
  ]
}

Domain Availability

:domainNameWithTLD must be complete domain name including TLD; like .com, .co.in, etc.

/api/domain/isAvailable/:domainNameWithTLD

Usage

curl https://localhost:5001/api/domain/isAvailable/whatblarandomdomainxyz.com

Response

Returns JSON object with value of data property as true if domain is available and false if domain is not available.

{
  "status": "Successful",
  "message": null,
  "data": true or false
}

Domain Price

:currency must be value of currency code from Supported Currencies; like INR, USD, etc.

:registrar must be value of registrar name from Registrars; like GoDaddy, BigRock, etc.

:domainNameWithTLD must be complete domain name including TLD; like .com, .co.in, etc.

/api/domain/:currency/:registrar/:domainNameWithTLD/price

Usage

curl https://localhost:5001/api/domain/INR/BigRock/whatblarandomdomainxyz.com/price

Response

Returns JSON object with value of data property with domain price and registrar url.

{
  "status": "Successful",
  "message": null,
  "data": {
    "url": "https://www.bigrock.in",
    "price": 799
  }
}