NAV Navigation
PHP Ruby Go JavaScript Node.JS Python Java iOS

DEV.ME API Documentation v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

DEV.ME API Documenation Currency Conversion and Exchange Rates API - IP2Location, IP Country, IP Information API - Email Validation, Mailbox Verification - Phone Number Validation. You can learn more at dev.me. For this example you can use api key demo-key to test theapis

Base URLs:

Terms of service Email: Support License: Proprietary license

Authentication

currency-api

Exchange Rates, Currency Conversion, Currency List

Currency Exchange Rates Product Page

Get Currency Exhcnage Rate and Converted Amount

Code samples



$client = new http\Client;
$request = new http\Client\Request;

$request->setRequestUrl('https://prod.dev.me/currency/exchange-rate');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString(array(
  'to' => 'USD',
  'from' => 'GBP'
)));

$request->setHeaders(array(
  'accept' => 'application/json'
));

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();
require 'uri'
require 'net/http'

url = URI("https://prod.dev.me/currency/exchange-rate?to=USD&from=GBP")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'

response = http.request(request)
puts response.read_body
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://prod.dev.me/currency/exchange-rate?to=USD&from=GBP"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://prod.dev.me/currency/exchange-rate?to=USD&from=GBP",
  "method": "GET",
  "headers": {
    "accept": "application/json"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require("request");

var options = {
  method: 'GET',
  url: 'https://prod.dev.me/currency/exchange-rate',
  qs: { to: 'USD', from: 'GBP' },
  headers: { accept: 'application/json' }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import http.client

conn = http.client.HTTPSConnection("prod.dev.me")

headers = { 'accept': "application/json" }

conn.request("GET", "/currency/exchange-rate?to=USD&from=GBP", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://prod.dev.me/currency/exchange-rate?to=USD&from=GBP")
  .get()
  .addHeader("accept", "application/json")
  .build();

Response response = client.newCall(request).execute();
import Foundation

let headers = ["accept": "application/json"]

var request = NSMutableURLRequest(URL: NSURL(string: "https://prod.dev.me/currency/exchange-rate?to=USD&from=GBP")!,
                                        cachePolicy: .UseProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.HTTPMethod = "GET"
request.allHTTPHeaderFields = headers

let session = NSURLSession.sharedSession()
let dataTask = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    println(error)
  } else {
    let httpResponse = response as? NSHTTPURLResponse
    println(httpResponse)
  }
})

dataTask.resume()

GET /currency/exchange-rate

Parameters

Name In Type Required Description
from query string true Currency Code (ISO 3 Letters) to convert from
to query string true Currency Code (ISO 3 Letters) to convert to
amount query number false Amount to be converted

Example responses

200 Response

{
  "from": "GBP",
  "to": "USD",
  "exchange_rate": 0.27225,
  "rate_datetime": "2019-05-31T20:25:30.900Z",
  "original_amount": 1,
  "converted_amount": 3.79,
  "converted_text": "1 AED equal to 0.27225 USD"
}

Responses

Status Meaning Description Schema
200 OK Currency Conversion and Exhcnage Rate currencyExchangeRate
400 Bad Request Bad request, Validation error. 400
401 Unauthorized Authorization information is missing or invalid. 401
403 Forbidden Forbidden, you are not allowed to access this resource. 403
404 Not Found Resource not found. 404
5XX Unknown Unexpected error. None

Get list of all Currencies with all information (Name, ISO Code, Symbol, Country using this currency,...)

Code samples



$client = new http\Client;
$request = new http\Client\Request;

$request->setRequestUrl('https://prod.dev.me/currency/list');
$request->setRequestMethod('GET');
$request->setHeaders(array(
  'accept' => 'application/json'
));

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();
require 'uri'
require 'net/http'

url = URI("https://prod.dev.me/currency/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'

response = http.request(request)
puts response.read_body
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://prod.dev.me/currency/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://prod.dev.me/currency/list",
  "method": "GET",
  "headers": {
    "accept": "application/json"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require("request");

var options = {
  method: 'GET',
  url: 'https://prod.dev.me/currency/list',
  headers: { accept: 'application/json' }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import http.client

conn = http.client.HTTPSConnection("prod.dev.me")

headers = { 'accept': "application/json" }

conn.request("GET", "/currency/list", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://prod.dev.me/currency/list")
  .get()
  .addHeader("accept", "application/json")
  .build();

Response response = client.newCall(request).execute();
import Foundation

let headers = ["accept": "application/json"]

var request = NSMutableURLRequest(URL: NSURL(string: "https://prod.dev.me/currency/list")!,
                                        cachePolicy: .UseProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.HTTPMethod = "GET"
request.allHTTPHeaderFields = headers

let session = NSURLSession.sharedSession()
let dataTask = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    println(error)
  } else {
    let httpResponse = response as? NSHTTPURLResponse
    println(httpResponse)
  }
})

dataTask.resume()

GET /currency/list

Example responses

200 Response

[
  {
    "code": "GBP",
    "country": [
      "US"
    ],
    "decimal_digits": 2,
    "rounding": 0,
    "flag": "AE",
    "symbol": "AED",
    "symbol_native": "د.إ.‏",
    "name": "United Arab Emirates Dirham",
    "name_plural": "UAE dirhams"
  }
]

Responses

Status Meaning Description Schema
200 OK Currency List currencyList
400 Bad Request Bad request, Validation error. 400
401 Unauthorized Authorization information is missing or invalid. 401
403 Forbidden Forbidden, you are not allowed to access this resource. 403
404 Not Found Resource not found. 404
5XX Unknown Unexpected error. None

ip-location-api

IP2Location, IP Geolocation, IP Country, IP Information Data

IP Location Product Page

Get IP Location, IP Country, IP Information

Code samples



$client = new http\Client;
$request = new http\Client\Request;

$request->setRequestUrl('https://prod.dev.me/ip/info');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString(array(
  'ip' => '81.17.21.67'
)));

$request->setHeaders(array(
  'accept' => 'application/json'
));

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();
require 'uri'
require 'net/http'

url = URI("https://prod.dev.me/ip/info?ip=81.17.21.67")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'

response = http.request(request)
puts response.read_body
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://prod.dev.me/ip/info?ip=81.17.21.67"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://prod.dev.me/ip/info?ip=81.17.21.67",
  "method": "GET",
  "headers": {
    "accept": "application/json"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require("request");

var options = {
  method: 'GET',
  url: 'https://prod.dev.me/ip/info',
  qs: { ip: '81.17.21.67' },
  headers: { accept: 'application/json' }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import http.client

conn = http.client.HTTPSConnection("prod.dev.me")

headers = { 'accept': "application/json" }

conn.request("GET", "/ip/info?ip=81.17.21.67", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://prod.dev.me/ip/info?ip=81.17.21.67")
  .get()
  .addHeader("accept", "application/json")
  .build();

Response response = client.newCall(request).execute();
import Foundation

let headers = ["accept": "application/json"]

var request = NSMutableURLRequest(URL: NSURL(string: "https://prod.dev.me/ip/info?ip=81.17.21.67")!,
                                        cachePolicy: .UseProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.HTTPMethod = "GET"
request.allHTTPHeaderFields = headers

let session = NSURLSession.sharedSession()
let dataTask = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    println(error)
  } else {
    let httpResponse = response as? NSHTTPURLResponse
    println(httpResponse)
  }
})

dataTask.resume()

GET /ip/info

Parameters

Name In Type Required Description
ip query string true IP Address

Example responses

200 Response

{
  "city": {
    "accuracy_radius": 100,
    "latitude": 47.1449,
    "longitude": 8.1551,
    "time_zone": "Europe/Zurich"
  },
  "country_code": "CH",
  "registered_country_code": "CH",
  "country": {
    "code": "CH",
    "calling_code": "41",
    "continent": {
      "name": "Europe",
      "code": "EU"
    },
    "currency": {
      "symbol": "CHF",
      "name_plural": "Swiss francs",
      "code": "CHF",
      "symbol_native": "CHF",
      "decimal_digits": 2,
      "name": "Swiss Franc",
      "rounding": 0
    },
    "date_format": "dd.MM.yyyy",
    "info": {
      "timezone": "Europe/Zurich",
      "capital": "Berne",
      "gdp": 646200000000,
      "tld": "ch"
    },
    "iso": {
      "alpha2": "CH",
      "alpha3": "CHE",
      "numeric": 756
    },
    "name": "Switzerland"
  },
  "datetime": "2019-06-01T00:40:20.661Z",
  "asn": 15802,
  "aso": "Emirates Integrated Telecommunications Company PJSC (EITC-DU)",
  "ip": "81.17.21.67"
}

Responses

Status Meaning Description Schema
200 OK IP Location & Information ipInfo
400 Bad Request Bad request, Validation error. 400
401 Unauthorized Authorization information is missing or invalid. 401
403 Forbidden Forbidden, you are not allowed to access this resource. 403
404 Not Found Resource not found. 404
5XX Unknown Unexpected error. None

email-validation-api

Email Validation, Email Verification

Email Validation Product Page

Validate Email Address, Verify Mailbox

Code samples



$client = new http\Client;
$request = new http\Client\Request;

$request->setRequestUrl('https://prod.dev.me/email/validate');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString(array(
  'email' => 'john.doe@yopmail.com'
)));

$request->setHeaders(array(
  'accept' => 'application/json'
));

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();
require 'uri'
require 'net/http'

url = URI("https://prod.dev.me/email/validate?email=john.doe%40yopmail.com")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'

response = http.request(request)
puts response.read_body
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://prod.dev.me/email/validate?email=john.doe%40yopmail.com"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://prod.dev.me/email/validate?email=john.doe%40yopmail.com",
  "method": "GET",
  "headers": {
    "accept": "application/json"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require("request");

var options = {
  method: 'GET',
  url: 'https://prod.dev.me/email/validate',
  qs: { email: 'john.doe@yopmail.com' },
  headers: { accept: 'application/json' }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import http.client

conn = http.client.HTTPSConnection("prod.dev.me")

headers = { 'accept': "application/json" }

conn.request("GET", "/email/validate?email=john.doe%40yopmail.com", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://prod.dev.me/email/validate?email=john.doe%40yopmail.com")
  .get()
  .addHeader("accept", "application/json")
  .build();

Response response = client.newCall(request).execute();
import Foundation

let headers = ["accept": "application/json"]

var request = NSMutableURLRequest(URL: NSURL(string: "https://prod.dev.me/email/validate?email=john.doe%40yopmail.com")!,
                                        cachePolicy: .UseProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.HTTPMethod = "GET"
request.allHTTPHeaderFields = headers

let session = NSURLSession.sharedSession()
let dataTask = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    println(error)
  } else {
    let httpResponse = response as? NSHTTPURLResponse
    println(httpResponse)
  }
})

dataTask.resume()

GET /email/validate

Parameters

Name In Type Required Description
email query string true Email Address

Example responses

200 Response

{
  "email": "john.doe@yopmail.com",
  "valid_format": true,
  "valid_domain": true,
  "valid_mailbox": true,
  "is_disposable": true,
  "is_free": true,
  "score": 0.8
}

Responses

Status Meaning Description Schema
200 OK IP Location & Information emailValidation
400 Bad Request Bad request, Validation error. 400
401 Unauthorized Authorization information is missing or invalid. 401
403 Forbidden Forbidden, you are not allowed to access this resource. 403
404 Not Found Resource not found. 404
5XX Unknown Unexpected error. None

phone-validation-api

Phone Number Validation, Phone Number Information

Phone Validation Product Page

Valdiate Phone Number and Get Information

Code samples



$client = new http\Client;
$request = new http\Client\Request;

$request->setRequestUrl('https://prod.dev.me/phone/validate');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString(array(
  'phone' => '14378003244'
)));

$request->setHeaders(array(
  'accept' => 'application/json'
));

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();
require 'uri'
require 'net/http'

url = URI("https://prod.dev.me/phone/validate?phone=14378003244")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'

response = http.request(request)
puts response.read_body
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://prod.dev.me/phone/validate?phone=14378003244"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://prod.dev.me/phone/validate?phone=14378003244",
  "method": "GET",
  "headers": {
    "accept": "application/json"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require("request");

var options = {
  method: 'GET',
  url: 'https://prod.dev.me/phone/validate',
  qs: { phone: '14378003244' },
  headers: { accept: 'application/json' }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import http.client

conn = http.client.HTTPSConnection("prod.dev.me")

headers = { 'accept': "application/json" }

conn.request("GET", "/phone/validate?phone=14378003244", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://prod.dev.me/phone/validate?phone=14378003244")
  .get()
  .addHeader("accept", "application/json")
  .build();

Response response = client.newCall(request).execute();
import Foundation

let headers = ["accept": "application/json"]

var request = NSMutableURLRequest(URL: NSURL(string: "https://prod.dev.me/phone/validate?phone=14378003244")!,
                                        cachePolicy: .UseProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.HTTPMethod = "GET"
request.allHTTPHeaderFields = headers

let session = NSURLSession.sharedSession()
let dataTask = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    println(error)
  } else {
    let httpResponse = response as? NSHTTPURLResponse
    println(httpResponse)
  }
})

dataTask.resume()

GET /phone/validate

Parameters

Name In Type Required Description
phone query string true Phone Number

Example responses

200 Response

{
  "number": "+14378003244",
  "valid": true,
  "country": "US",
  "calling_code": "1",
  "is_disposable": true,
  "national_number": "4378003244",
  "type": "FIXED_LINE_OR_MOBILE"
}

Responses

Status Meaning Description Schema
200 OK IP Location & Information phoneValidation
400 Bad Request Bad request, Validation error. 400
401 Unauthorized Authorization information is missing or invalid. 401
403 Forbidden Forbidden, you are not allowed to access this resource. 403
404 Not Found Resource not found. 404
5XX Unknown Unexpected error. None

country-api

Country List, Country Information

Productivity and Developer Tools Page

Get list of all countries with rich infroamtion (Currency, Capital, Continent, ISO Code alpah2, alpha3, Phone Code...)

Code samples



$client = new http\Client;
$request = new http\Client\Request;

$request->setRequestUrl('https://prod.dev.me/country/list');
$request->setRequestMethod('GET');
$request->setHeaders(array(
  'accept' => 'application/json'
));

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();
require 'uri'
require 'net/http'

url = URI("https://prod.dev.me/country/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'

response = http.request(request)
puts response.read_body
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://prod.dev.me/country/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://prod.dev.me/country/list",
  "method": "GET",
  "headers": {
    "accept": "application/json"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require("request");

var options = {
  method: 'GET',
  url: 'https://prod.dev.me/country/list',
  headers: { accept: 'application/json' }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import http.client

conn = http.client.HTTPSConnection("prod.dev.me")

headers = { 'accept': "application/json" }

conn.request("GET", "/country/list", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://prod.dev.me/country/list")
  .get()
  .addHeader("accept", "application/json")
  .build();

Response response = client.newCall(request).execute();
import Foundation

let headers = ["accept": "application/json"]

var request = NSMutableURLRequest(URL: NSURL(string: "https://prod.dev.me/country/list")!,
                                        cachePolicy: .UseProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.HTTPMethod = "GET"
request.allHTTPHeaderFields = headers

let session = NSURLSession.sharedSession()
let dataTask = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    println(error)
  } else {
    let httpResponse = response as? NSHTTPURLResponse
    println(httpResponse)
  }
})

dataTask.resume()

GET /country/list

Example responses

200 Response

[
  {
    "code": "CH",
    "calling_code": "41",
    "continent": {
      "name": "Europe",
      "code": "EU"
    },
    "currency": {
      "symbol": "CHF",
      "name_plural": "Swiss francs",
      "code": "CHF",
      "symbol_native": "CHF",
      "decimal_digits": 2,
      "name": "Swiss Franc",
      "rounding": 0
    },
    "date_format": "dd.MM.yyyy",
    "info": {
      "timezone": "Europe/Zurich",
      "capital": "Berne",
      "gdp": 646200000000,
      "tld": "ch"
    },
    "iso": {
      "alpha2": "CH",
      "alpha3": "CHE",
      "numeric": 756
    },
    "name": "Switzerland"
  }
]

Responses

Status Meaning Description Schema
200 OK Country List countryList
400 Bad Request Bad request, Validation error. 400
401 Unauthorized Authorization information is missing or invalid. 401
403 Forbidden Forbidden, you are not allowed to access this resource. 403
404 Not Found Resource not found. 404
5XX Unknown Unexpected error. None

Schemas

400

{
  "resError": {
    "msg": "from invalid value from invalid currency value",
    "type": "E",
    "errors": [
      {
        "location": "query",
        "param": "from",
        "value": "invalid_value",
        "msg": "Invalid currency value"
      }
    ]
  },
  "resStatus": 400
}

Properties

Name Type Required Restrictions Description
resError object false none none
» msg string false none none
» type string false none none
» errors [object] false none none
»» location string false none none
»» param string false none none
»» value string false none none
»» msg string false none none
» resStatus number false none none

401

{
  "resError": {
    "msg": "Unauthenticated request",
    "type": "E"
  },
  "resStatus": 401
}

Properties

Name Type Required Restrictions Description
resError object false none none
» msg string false none none
» type string false none none
resStatus number false none none

403

{
  "resError": {
    "msg": "Unauthorized request",
    "type": "E"
  },
  "resStatus": 403
}

Properties

Name Type Required Restrictions Description
resError object false none none
» msg string false none none
» type string false none none
resStatus number false none none

404

{
  "resError": {
    "msg": "An error has occurred while processing your request, please try again",
    "type": "E"
  },
  "resStatus": 404
}

Properties

Name Type Required Restrictions Description
resError object false none none
» msg string false none none
» type string false none none
resStatus number false none none

currencyExchangeRate

{
  "from": "GBP",
  "to": "USD",
  "exchange_rate": 0.27225,
  "rate_datetime": "2019-05-31T20:25:30.900Z",
  "original_amount": 1,
  "converted_amount": 3.79,
  "converted_text": "1 AED equal to 0.27225 USD"
}

Properties

Name Type Required Restrictions Description
from string false none none
to string false none none
exchange_rate number false none none
rate_datetime string(date-time) false none none
original_amount number false none none
converted_amount number false none none
converted_text string false none none

currencyList

[
  {
    "code": "GBP",
    "country": [
      "US"
    ],
    "decimal_digits": 2,
    "rounding": 0,
    "flag": "AE",
    "symbol": "AED",
    "symbol_native": "د.إ.‏",
    "name": "United Arab Emirates Dirham",
    "name_plural": "UAE dirhams"
  }
]

List of All Currencies

Properties

Name Type Required Restrictions Description
code string false none none
country [string] false none none
decimal_digits number false none none
rounding number false none none
flag string false none none
symbol string false none none
symbol_native string false none none
name string false none none
name_plural string false none none

countryList

[
  {
    "code": "CH",
    "calling_code": "41",
    "continent": {
      "name": "Europe",
      "code": "EU"
    },
    "currency": {
      "symbol": "CHF",
      "name_plural": "Swiss francs",
      "code": "CHF",
      "symbol_native": "CHF",
      "decimal_digits": 2,
      "name": "Swiss Franc",
      "rounding": 0
    },
    "date_format": "dd.MM.yyyy",
    "info": {
      "timezone": "Europe/Zurich",
      "capital": "Berne",
      "gdp": 646200000000,
      "tld": "ch"
    },
    "iso": {
      "alpha2": "CH",
      "alpha3": "CHE",
      "numeric": 756
    },
    "name": "Switzerland"
  }
]

List of All Countries

Properties

Name Type Required Restrictions Description
code string false none none
calling_code string false none none
continent object false none none
» name string false none none
» code string false none none
currency object false none none
» symbol string false none none
» name_plural string false none none
» code string false none none
» symbol_native string false none none
» decimal_digits number false none none
» name string false none none
» rounding number false none none
date_format string false none none
info object false none none
» timezone string false none none
» capital string false none none
» gdp number false none none
» tld string false none none
iso object false none none
» alpha2 string false none none
» alpha3 string false none none
» numeric number false none none
name string false none none

ipInfo

{
  "city": {
    "accuracy_radius": 100,
    "latitude": 47.1449,
    "longitude": 8.1551,
    "time_zone": "Europe/Zurich"
  },
  "country_code": "CH",
  "registered_country_code": "CH",
  "country": {
    "code": "CH",
    "calling_code": "41",
    "continent": {
      "name": "Europe",
      "code": "EU"
    },
    "currency": {
      "symbol": "CHF",
      "name_plural": "Swiss francs",
      "code": "CHF",
      "symbol_native": "CHF",
      "decimal_digits": 2,
      "name": "Swiss Franc",
      "rounding": 0
    },
    "date_format": "dd.MM.yyyy",
    "info": {
      "timezone": "Europe/Zurich",
      "capital": "Berne",
      "gdp": 646200000000,
      "tld": "ch"
    },
    "iso": {
      "alpha2": "CH",
      "alpha3": "CHE",
      "numeric": 756
    },
    "name": "Switzerland"
  },
  "datetime": "2019-06-01T00:40:20.661Z",
  "asn": 15802,
  "aso": "Emirates Integrated Telecommunications Company PJSC (EITC-DU)",
  "ip": "81.17.21.67"
}

IP Location and Information

Properties

Name Type Required Restrictions Description
city object false none none
» accuracy_radius number false none none
» latitude number false none none
» longitude number false none none
» time_zone string false none none
country_code string false none none
registered_country_code string false none none
country object false none none
» code string false none none
» calling_code string false none none
» continent object false none none
»» name string false none none
»» code string false none none
» currency object false none none
»» symbol string false none none
»» name_plural string false none none
»» code string false none none
»» symbol_native string false none none
»» decimal_digits number false none none
»» name string false none none
»» rounding number false none none
» date_format string false none none
» info object false none none
»» timezone string false none none
»» capital string false none none
»» gdp number false none none
»» tld string false none none
» iso object false none none
»» alpha2 string false none none
»» alpha3 string false none none
»» numeric number false none none
» name string false none none
datetime string(date-time) false none none
asn number false none Autonomous System Number
aso string false none Address Supporting Organization "ISP"
ip string false none none

emailValidation

{
  "email": "john.doe@yopmail.com",
  "valid_format": true,
  "valid_domain": true,
  "valid_mailbox": true,
  "is_disposable": true,
  "is_free": true,
  "score": 0.8
}

Properties

Name Type Required Restrictions Description
email string(email) false none none
valid_format boolean false none none
valid_domain boolean false none none
valid_mailbox boolean false none none
is_disposable boolean false none none
is_free boolean false none none
score number false none none

phoneValidation

{
  "number": "+14378003244",
  "valid": true,
  "country": "US",
  "calling_code": "1",
  "is_disposable": true,
  "national_number": "4378003244",
  "type": "FIXED_LINE_OR_MOBILE"
}

Properties

Name Type Required Restrictions Description
number string false none none
valid boolean false none none
country string false none none
calling_code string false none none
is_disposable boolean false none none
national_number string false none none
type string false none none