GeoRanker - Accurate data from Search Engines

Welcome to the GeoRanker documentation. You'll find comprehensive guides and tutorials to help you start working with GeoRanker as quickly as possible, as well as community support if you get stuck.

Get Started
Suggest Edits

Reads the User Account information

Read the user account information.

 

Query Auth

 Authentication is required for this endpoint.
gethttp://api.highvolume.georanker.com/user
curl --request GET \
  --url 'http://api.highvolume.georanker.com/user?apikey=apikey'
var request = require("request");

var options = { method: 'GET',
  url: 'http://api.highvolume.georanker.com/user',
  qs: { apikey: 'apikey' } };

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

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.highvolume.georanker.com/user?apikey=apikey")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.highvolume.georanker.com/user?apikey=apikey");

xhr.send(data);
import requests

url = "http://api.highvolume.georanker.com/user"

querystring = {"apikey":"apikey"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

apikey
string
required

The user account apikey

Response

The user account data.

createdAtstring

When this user was created.

emailsarray

The list email from user.

profileobject
profile.namestring

The user name.

profile.organizationstring

The organization name.

profile.websitestring

The website name.

profile.genderstring

The gender from user.

profile.countryCodestring

The user's country code.

creditsarray

The list email from user.

Bad input parameter. The error message should indicate which one and why.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Bad API Key. Your key may have been mistyped or you do not have access to our API.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Internal server error.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Your app is making too many requests and is being rated limited. 503s can trigger on a per-IP or per-user basis.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Suggest Edits

Create a new Search Engine Ranking Page (SERP) request.

Create a request to our system to do a search on the search engine using the keywords, regions, and other settings. This search will be done asynchronously and this request will return a SERP object with an ID that can be used to download the data later.

 

Query Auth

 Authentication is required for this endpoint.
posthttp://api.highvolume.georanker.com/serp/new
curl --request POST \
  --url 'http://api.highvolume.georanker.com/serp/new?apikey=apikey'
var request = require("request");

var options = { method: 'POST',
  url: 'http://api.highvolume.georanker.com/serp/new',
  qs: { apikey: 'apikey' } };

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

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.highvolume.georanker.com/serp/new?apikey=apikey")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://api.highvolume.georanker.com/serp/new?apikey=apikey");

xhr.send(data);
import requests

url = "http://api.highvolume.georanker.com/serp/new"

querystring = {"apikey":"apikey"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

apikey
string
required

The user account apikey

Body Params

keyword
string
required

The keyword to be used when doing the search. We will not automatically append any city name to the keyword. The search will be done using the exact same keyword sent.

region
string
required

A valid canonical region name or a ISO-3166-1 alpha-2 country code. If the name does not match with a canonical name from our list, we will try to match with its formatted name, local name, id or a country code.

searchEngine
string
required

The search engine used to search the content. List of Search Engines (google, googlelocal, yahoo, bing, yandex, youtube, naverwebdocs, naverlocal, baidu,googlenews, googleimages). Default: google.

callback
string

A URL that will be called when this SERP Request is ready to be downloaded. We will do a POST HTTP request with the SERP id (serpId) to the callback URL as soon the data is ready on our database.

maxResults
int32

The total amount of organic results we will collect from the search engine. The maximum value of this variable is determined by the user plan.

isMobile
boolean

If True, we will do the search using a mobile browser. By default, this variable is False.

language
string

Two letters ISO 639-1 language code. If this field is not provided, we will use the default language for the country.

Response

SERP Request created

idstring

A unique id created for this SERP object. This id can be used to read or update this object.

keywordstring

The keyword to be used when doing the search. We will not automatically append any city name to the keyword. The search will be done using the exact same keyword sent.

regionobject
region.idstring

Unique and persistent assigned ID for the region.

region.namestring

Best available English name of the geo region.

region.localNamestring

The name of the region in the local language.

region.formattedNamestring

Fully qualified region name in a human readable format.

region.canonicalNamestring

The constructed fully qualified English name consisting of the region's own name, and that of its parent and country. This is unique and should be used when sending Regions names via our API.

region.placeIdstring

ID code of the region in google maps API.

region.parentIdstring

If the region is inside another region, this field contains the parent's region ID.

region.countryCodestring

The ISO-3166-1 alpha-2 country code that is associated with the region.

region.typestring

The type of the region.

region.populationinteger

The approximate total population of the region.

region.latitudenumber

The latitude of the center of the region.

region.longitudenumber

The longitude of the center of the region.

searchEnginestring

The search engine used to search the content. List of Search Engines (google, googlelocal, yahoo, bing, yandex, youtube, naverwebdocs, naverlocal, baidu,googlenews, googleimages). Default: google.

callbackstring

A URL that will be called when this SERP Request is ready to be downloaded. We will do a POST HTTP request with the SERP id to the callback url as soon the data is ready on our database.

maxResultsinteger

The total amount of organic results we will collect from the search engine. The maximum value of this variable is determined by the user plan.

isMobileboolean

If True, we will do the search using a mobile browser. By default, this variable is False.

languagestring

Two letters ISO 639-1 language code. If this field is not provided, we will use the default language for the country.

readyboolean

If this object is false, means that the SERP data is not ready yet and we are still processing it. If true, the data can be consumed.

isFromApiboolean

If true, this SERP was created by our API

queuedboolean

True if the SERP request was already sent to one of our crawlers.

createdAtstring

When this search was requested to be processed.

generatedAtstring

When this Search was performed at the search engine.

dataobject
data.totalResultsinteger

The amount of results the search engine has indexed to that keyword.

data.organicarray

The organic list of results for this search. This can include some special data like, for example, Google Maps Pack.

data.advertisersarray

The list of advertisers that was displayed when doing this search.

Bad input parameter. The error message should indicate which one and why.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Bad API Key. Your key may have been mistyped or you do not have access to our API.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Internal server error.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Your app is making too many requests and is being rated limited. 503s can trigger on a per-IP or per-user basis.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

The user has no credits left.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Suggest Edits

Create several Search Engine Ranking Page (SERP) requests from a list.

Create several SERPs Request to our system to do a search on the search engine using the keywords, regions, and other settings. This search will be done asynchronously and this request will return a list of SERP object with IDs that can be used to download the data later.

 

Query Auth

 Authentication is required for this endpoint.
posthttp://api.highvolume.georanker.com/serp/new/list
curl --request POST \
  --url 'http://api.highvolume.georanker.com/serp/new/list?apikey=apikey'
var request = require("request");

var options = { method: 'POST',
  url: 'http://api.highvolume.georanker.com/serp/new/list',
  qs: { apikey: 'apikey' } };

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

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.highvolume.georanker.com/serp/new/list?apikey=apikey")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://api.highvolume.georanker.com/serp/new/list?apikey=apikey");

xhr.send(data);
import requests

url = "http://api.highvolume.georanker.com/serp/new/list"

querystring = {"apikey":"apikey"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

apikey
string
required

The user account apikey

Response

A list of Full SERP data that was created. If the data is not ready yet for a specific SERP, the flag `ready` will be false for that object and the data field object may be null. This function ignores the SERPs that do not exist or are duplicated.

Bad input parameter. The error message should indicate which one and why.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Bad API Key. Your key may have been mistyped or you do not have access to our API.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

SERP not found or you don't have permission to read it.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Internal server error.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Your app is making too many requests and is being rated limited. 503s can trigger on a per-IP or per-user basis.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

The user has no credits left.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Suggest Edits

Display the current SERP data for a provided ID.

Return the full SERP data based on the ID. If the data is not ready yet, the flag ready will be false and the data object may be null.

 

Query Auth

 Authentication is required for this endpoint.
gethttp://api.highvolume.georanker.com/serp/id
curl --request GET \
  --url 'http://api.highvolume.georanker.com/serp/id?apikey=apikey'
var request = require("request");

var options = { method: 'GET',
  url: 'http://api.highvolume.georanker.com/serp/id',
  qs: { apikey: 'apikey' } };

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

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.highvolume.georanker.com/serp/id?apikey=apikey")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.highvolume.georanker.com/serp/id?apikey=apikey");

xhr.send(data);
import requests

url = "http://api.highvolume.georanker.com/serp/id"

querystring = {"apikey":"apikey"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

ID of SERP that needs to be fetched

Query Params

apikey
string
required

The user account apikey

Response

SERP Request created

idstring

A unique id created for this SERP object. This id can be used to read or update this object.

keywordstring

The keyword to be used when doing the search. We will not automatically append any city name to the keyword. The search will be done using the exact same keyword sent.

regionobject
region.idstring

Unique and persistent assigned ID for the region.

region.namestring

Best available English name of the geo region.

region.localNamestring

The name of the region in the local language.

region.formattedNamestring

Fully qualified region name in a human readable format.

region.canonicalNamestring

The constructed fully qualified English name consisting of the region's own name, and that of its parent and country. This is unique and should be used when sending Regions names via our API.

region.placeIdstring

ID code of the region in google maps API.

region.parentIdstring

If the region is inside another region, this field contains the parent's region ID.

region.countryCodestring

The ISO-3166-1 alpha-2 country code that is associated with the region.

region.typestring

The type of the region.

region.populationinteger

The approximate total population of the region.

region.latitudenumber

The latitude of the center of the region.

region.longitudenumber

The longitude of the center of the region.

searchEnginestring

The search engine used to search the content. List of Search Engines (google, googlelocal, yahoo, bing, yandex, youtube, naverwebdocs, naverlocal, baidu,googlenews, googleimages). Default: google.

callbackstring

A URL that will be called when this SERP Request is ready to be downloaded. We will do a POST HTTP request with the SERP id to the callback url as soon the data is ready on our database.

maxResultsinteger

The total amount of organic results we will collect from the search engine. The maximum value of this variable is determined by the user plan.

isMobileboolean

If True, we will do the search using a mobile browser. By default, this variable is False.

languagestring

Two letters ISO 639-1 language code. If this field is not provided, we will use the default language for the country.

readyboolean

If this object is false, means that the SERP data is not ready yet and we are still processing it. If true, the data can be consumed.

isFromApiboolean

If true, this SERP was created by our API

queuedboolean

True if the SERP request was already sent to one of our crawlers.

createdAtstring

When this search was requested to be processed.

generatedAtstring

When this Search was performed at the search engine.

dataobject
data.totalResultsinteger

The amount of results the search engine has indexed to that keyword.

data.organicarray

The organic list of results for this search. This can include some special data like, for example, Google Maps Pack.

data.advertisersarray

The list of advertisers that was displayed when doing this search.

Bad input parameter. The error message should indicate which one and why.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Bad API Key. Your key may have been mistyped or you do not have access to our API.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

SERP not found or you don't have permission to read it.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Internal server error.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Your app is making too many requests and is being rated limited. 503s can trigger on a per-IP or per-user basis.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

The user has no credits left.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Suggest Edits

Deletes a SERP request from our database.

Remove from our database a SERP object that is not necessary anymore. This will not give the credits back to the user account.

 

Query Auth

 Authentication is required for this endpoint.
deletehttp://api.highvolume.georanker.com/serp/id
curl --request DELETE \
  --url 'http://api.highvolume.georanker.com/serp/id?apikey=apikey'
var request = require("request");

var options = { method: 'DELETE',
  url: 'http://api.highvolume.georanker.com/serp/id',
  qs: { apikey: 'apikey' } };

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

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.highvolume.georanker.com/serp/id?apikey=apikey")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "http://api.highvolume.georanker.com/serp/id?apikey=apikey");

xhr.send(data);
import requests

url = "http://api.highvolume.georanker.com/serp/id"

querystring = {"apikey":"apikey"}

response = requests.request("DELETE", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

ID of SERP that needs to be deleted

Query Params

apikey
string
required

The user account apikey

Response

SERP request deleted. Please note that the code 204 means "No Content" and the response body will be empty.

Bad input parameter. The error message should indicate which one and why.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Bad API Key. Your key may have been mistyped or you do not have access to our API.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

SERP not found or you don't have permission to read it.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Internal server error.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Your app is making too many requests and is being rated limited. 503s can trigger on a per-IP or per-user basis.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Suggest Edits

Read a list of SERPs by Ids

Return a list of full SERP data based on the IDs sent. If the data is not ready yet for a specific SERP, the flag ready will be false for that object and the data field object may be null.

 

Query Auth

 Authentication is required for this endpoint.
posthttp://api.highvolume.georanker.com/serp/list
curl --request POST \
  --url 'http://api.highvolume.georanker.com/serp/list?apikey=apikey'
var request = require("request");

var options = { method: 'POST',
  url: 'http://api.highvolume.georanker.com/serp/list',
  qs: { apikey: 'apikey' } };

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

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.highvolume.georanker.com/serp/list?apikey=apikey")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://api.highvolume.georanker.com/serp/list?apikey=apikey");

xhr.send(data);
import requests

url = "http://api.highvolume.georanker.com/serp/list"

querystring = {"apikey":"apikey"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

apikey
string
required

The user account apikey

Response

A list of Full SERP data. If the data is not ready yet for a specific SERP, the flag `ready` will be false for that object and the data field object may be null. This function ignores the SERPs that do not exist or are duplicated.

Bad input parameter. The error message should indicate which one and why.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Bad API Key. Your key may have been mistyped or you do not have access to our API.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

SERP not found or you don't have permission to read it.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Internal server error.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Your app is making too many requests and is being rated limited. 503s can trigger on a per-IP or per-user basis.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

The user has no credits left.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Suggest Edits

Read a list of regions

Read and filter a list of regions. The region list is static and can be cached on the client side.

 

Query Auth

 Authentication is required for this endpoint.
gethttp://api.highvolume.georanker.com/region/list
curl --request GET \
  --url 'http://api.highvolume.georanker.com/region/list?apikey=apikey'
var request = require("request");

var options = { method: 'GET',
  url: 'http://api.highvolume.georanker.com/region/list',
  qs: { apikey: 'apikey' } };

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

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.highvolume.georanker.com/region/list?apikey=apikey")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.highvolume.georanker.com/region/list?apikey=apikey");

xhr.send(data);
import requests

url = "http://api.highvolume.georanker.com/region/list"

querystring = {"apikey":"apikey"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

countryCode
string

The two letters ISO-3166-1 alpha-2 country code to use to filter the region list.

type
string

The type of the region

items
integer

The total number of items to return on the search

page
integer

The page to download

apikey
string
required

The user account apikey

Response

The list of regions that was found using the filters

pageinteger

Current page number

totalinteger

The total amount of results for this search.

itemsarray

The name of the region in the local language.

Bad input parameter. The error message should indicate which one and why.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Bad API Key. Your key may have been mistyped or you do not have access to our API.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Internal server error.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Your app is making too many requests and is being rated limited. 503s can trigger on a per-IP or per-user basis.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Suggest Edits

Get whois data and contact information from a domain name

Return the whois data from a domain name. The response includes informations of the domain's server, it's social media links and contacts of the responsible personal of the domain.

 

Query Auth

 Authentication is required for this endpoint.
gethttp://api.highvolume.georanker.com/whois/domain
curl --request GET \
  --url 'http://api.highvolume.georanker.com/whois/domain?apikey=apikey'
var request = require("request");

var options = { method: 'GET',
  url: 'http://api.highvolume.georanker.com/whois/domain',
  qs: { apikey: 'apikey' } };

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

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.highvolume.georanker.com/whois/domain?apikey=apikey")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.highvolume.georanker.com/whois/domain?apikey=apikey");

xhr.send(data);
import requests

url = "http://api.highvolume.georanker.com/whois/domain"

querystring = {"apikey":"apikey"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

domain
string
required

Domain name of whois data that needs to be fetched

Query Params

apikey
string
required

The user account apikey

source
string

This is the data source to generate the whois data.
The possible values are:
auto: This is the default option. Our System chooses the best data source based on the domain TLD.

website: This will make the request try to be solved using the website scraping algorithm. This will only work for a small and very specific list of TLDs.
whois: Most of the time, we will use this data source to get the data. This is equivalent to run the whois via command line on a linux machine and, after, extract each single piece of data.

Response

The Whois object with the contact and social links information collected.

domainstring

The domain used to gather informations.

tldstring

The domain's tld. If the domain is an IP address, this field will be NULL. This field never starts with a dot.

statusarray

The list of status of the domain.

createdAtstring

When this domain was created.

updatedAtstring

When this domain was last updated.

expiredAtstring

When this domain will expire.

nameServersarray

The list of the names of the domain.

contactsobject

The contact data object related to the domain.

contacts.registrantobject

The contact information data.

contacts.registrant.namestring

The name of the contact.

contacts.registrant.orgstring

The name of the organization

contacts.registrant.emailstring

The email address

contacts.registrant.streetarray

The address parts

contacts.registrant.postalstring

The postal code of the contact

contacts.registrant.citystring

The city of the contact

contacts.registrant.statestring

The state of the contact

contacts.registrant.countrystring

The country of the contact

contacts.registrant.phonestring

The phone number of the contact

contacts.registrant.faxstring

The fax number of the contact

contacts.adminobject

The contact information data.

contacts.admin.namestring

The name of the contact.

contacts.admin.orgstring

The name of the organization

contacts.admin.emailstring

The email address

contacts.admin.streetarray

The address parts

contacts.admin.postalstring

The postal code of the contact

contacts.admin.citystring

The city of the contact

contacts.admin.statestring

The state of the contact

contacts.admin.countrystring

The country of the contact

contacts.admin.phonestring

The phone number of the contact

contacts.admin.faxstring

The fax number of the contact

contacts.techobject

The contact information data.

contacts.tech.namestring

The name of the contact.

contacts.tech.orgstring

The name of the organization

contacts.tech.emailstring

The email address

contacts.tech.streetarray

The address parts

contacts.tech.postalstring

The postal code of the contact

contacts.tech.citystring

The city of the contact

contacts.tech.statestring

The state of the contact

contacts.tech.countrystring

The country of the contact

contacts.tech.phonestring

The phone number of the contact

contacts.tech.faxstring

The fax number of the contact

contacts.zoneobject

The contact information data.

contacts.zone.namestring

The name of the contact.

contacts.zone.orgstring

The name of the organization

contacts.zone.emailstring

The email address

contacts.zone.streetarray

The address parts

contacts.zone.postalstring

The postal code of the contact

contacts.zone.citystring

The city of the contact

contacts.zone.statestring

The state of the contact

contacts.zone.countrystring

The country of the contact

contacts.zone.phonestring

The phone number of the contact

contacts.zone.faxstring

The fax number of the contact

contacts.billingobject

The contact information data.

contacts.billing.namestring

The name of the contact.

contacts.billing.orgstring

The name of the organization

contacts.billing.emailstring

The email address

contacts.billing.streetarray

The address parts

contacts.billing.postalstring

The postal code of the contact

contacts.billing.citystring

The city of the contact

contacts.billing.statestring

The state of the contact

contacts.billing.countrystring

The country of the contact

contacts.billing.phonestring

The phone number of the contact

contacts.billing.faxstring

The fax number of the contact

rawTextstring

The raw text of the whois request.

emailsarray

The list of emails found on the whois information of the domain

registeredboolean

Either if the domain is registered or not.

registrarobject

The registrar infomation related to the domain.

registrar.namestring

The registrar name.

registrar.emailstring

The registrar email.

registrar.urlstring

The registrar url.

registrar.phonestring

The registrar phone number.

serverobject

The server information of the domain.

server.ipstring

The IP of the domain.

server.reverseDNSstring

The Reverse DNS hostname of the IP address found.

server.latitudenumber

The latitude of the domain's server.

server.longitudenumber

The longitude of the domain's server.

server.countrystring

The country of the domain's server.

server.citystring

The city of the domain's server.

server.continentstring

The continent of the domain's server.

server.hostingASNstring

The autonomous system number.

server.hostingPoviderstring

The provider of the domain's host.

backlinksinteger

The total number of backlinks that points to any domain or subdomain.

socialLinksobject

The domain social media links. This data is only avaiable if the social links are present on the homepage of the website.

socialLinks.facebookstring

The facebook address found for the domain.

socialLinks.twitterstring

The twitter address found for the domain.

socialLinks.linkedinstring

The linkedin address found for the domain.

Bad input parameter. The error message should indicate which one and why.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Bad API Key. Your key may have been mistyped or you do not have access to our API.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Internal server error. The error message should indicate which one and why.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Your app is making too many requests and is being rated limited. 503s can trigger on a per-IP or per-user basis.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

The user has no credits left.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Suggest Edits

technologies

 
Suggest Edits

Get a list of technologies used on a domain.

Return the technologies data from a domain name. The response includes a list of technologies and its categories

 

Query Auth

 Authentication is required for this endpoint.
gethttp://api.highvolume.georanker.com/technologies/domain
curl --request GET \
  --url 'http://api.highvolume.georanker.com/technologies/domain?apikey=apikey'
var request = require("request");

var options = { method: 'GET',
  url: 'http://api.highvolume.georanker.com/technologies/domain',
  qs: { apikey: 'apikey' } };

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

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.highvolume.georanker.com/technologies/domain?apikey=apikey")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.highvolume.georanker.com/technologies/domain?apikey=apikey");

xhr.send(data);
import requests

url = "http://api.highvolume.georanker.com/technologies/domain"

querystring = {"apikey":"apikey"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

domain
string
required

Domain name of technologies data that needs to be fetched

Query Params

apikey
string
required

The user account apikey

Response

The Website technologies object with the technologies list.

domainstring

The domain used to gather informations.

updatedAtstring

When this domain was last updated.

technologiesarray

Bad input parameter. The error message should indicate which one and why.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Bad API Key. Your key may have been mistyped or you do not have access to our API.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Internal server error. The error message should indicate which one and why.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

Your app is making too many requests and is being rated limited. 503s can trigger on a per-IP or per-user basis.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.

The user has no credits left.

codeinteger

The error code. Usually, we use the same standards as the HTTP status codes.

messagestring

The error message generated by our API.

solutionstring

A possible solution to solve this error.