GetHostedDomains

Status

Command status: Active
Supported by OpenApps API: Yes
Supported by Internal/Reseller API: Yes
Possibly queued processing: No

Purpose

This command is designed to return domains co-hosted on the specified IP address or domain.

An example of data returned by this command can be found in the Neighbourhood checker tool available on our website.

Resources consumed

Resource Description

AnalysisResUnits

AnalysisResUnits will be reduced by GetHostedDomainsAnalysisResUnitsCost, as returned by GetSubscriptionInfo.

RetrievalResUnits

RetrievalResUnits will be reduced by the number of rows of data returned.

Parameters

Parameter Description

cmd

Required: must be set to: GetHostedDomains

datasource

Optional - defaults to historic
Either: "fresh" - to query against the Fresh Index, or "historic" - to query against the Historic Index.

Domain

Required: Domain (root domain will be extracted in case of subdomains) or IP (v4) address to check.

MaxDomains

Maximum number of domains to be returned.

Default: 10 Maximum: 100

Note: actual number of returned domains can be lower than requested if there are not enough of them found in index.

Sample queries and response

Default Domain

This query in the Fresh Index produces the following XML:

<?xml version="1.0" encoding="UTF-8"?>
<Result Code="OK" ErrorMessage="" FullError="">
   <GlobalVars ChargedAnalysisResUnits="5000" ChargedRetrievalResUnits="10" GeoCountryCode="US" IndexBuildDate="2017-10-15 16:23:38" IndexType="1" IPs="1" RecommendedIP="213.52.129.106" RemainingAnalysisResUnits="97113851" RemainingRetrievalResUnits="19462979" ServerBuild="2017-10-13 13:57:22" ServerName="QUACKYO" ServerVersion="1.0.6495.23321" UniqueIndexID="20171015162338-FRESH" />
   <DataTables Count="2">
      <DataTable Name="DomainsOnIP" RowsCount="0" Headers="Domain|IPAddress|RefDomains|ExtBackLinks|CitationFlow|TrustFlow|TopicalTrustFlow_Topic_0|TopicalTrustFlow_Value_0" IP="216.58.204.4" MaxRefDomainTopics="10" RefDomainTopicsCount="1" TotalDomains="0" TotalExtBackLinks="0" TotalRefDomains="0" />
      <DataTable Name="DomainsOnSubnet" RowsCount="10" Headers="Domain|IPAddress|RefDomains|ExtBackLinks|CitationFlow|TrustFlow|TopicalTrustFlow_Topic_0|TopicalTrustFlow_Value_0" IP="216.58.204.*" MaxRefDomainTopics="10" RefDomainTopicsCount="1" TotalDomains="13878" TotalExtBackLinks="27640597" TotalRefDomains="231373">
         <Row>leadpages.net|216.58.204.*|28248|8003454|52|46|Arts/Photography|35</Row>
         <Row>google.bg|216.58.204.*|26232|5217536|40|43|Computers/Internet/Searching|41</Row>
         <Row>premiumbloggertemplates.com|216.58.204.*|9724|1939819|33|24|Computers/Internet/Searching|23</Row>
         <Row>randar.com|216.58.204.*|8545|158689|32|24|Arts/Television|23</Row>
         <Row>google.je|216.58.204.*|3430|62574|40|17|Computers/Internet/Searching|15</Row>
         <Row>yesbaekhyun.co.vu|216.58.204.*|3417|21073|0|0| |</Row>
         <Row>quickoffice.com|216.58.204.*|2415|14550|26|21|Computers/Software/Operating Systems|21</Row>
         <Row>google.so|216.58.204.*|1885|310079|25|11|Computers/Internet|11</Row>
         <Row>youtube.nl|216.58.204.*|1581|1754124|35|33|Arts/Design|28</Row>
         <Row>yunlin.ws|216.58.204.*|1552|21515|23|4|Recreation/Outdoors|4</Row>
      </DataTable>
   </DataTables>
</Result>

JSON response

{
  "Code": "OK",
  "ErrorMessage": "",
  "FullError": "",
  "ChargedAnalysisResUnits": 5000,
  "ChargedRetrievalResUnits": 10,
  "GeoCountryCode": "US",
  "IndexBuildDate": "2017-10-15 16:23:38",
  "IndexType": 1,
  "IPs": 1,
  "RecommendedIP": "213.52.129.106",
  "RemainingAnalysisResUnits": 97108851,
  "RemainingRetrievalResUnits": 19462969,
  "ServerBuild": "2017-10-13 13:57:22",
  "ServerName": "QUACKYO",
  "ServerVersion": "1.0.6495.23321",
  "UniqueIndexID": "20171015162338-FRESH",
  "DataTables": {
    "DomainsOnIP": {
      "Headers": {
        "IP": "216.58.204.4",
        "MaxRefDomainTopics": 10,
        "RefDomainTopicsCount": 1,
        "TotalDomains": 0,
        "TotalExtBackLinks": 0,
        "TotalRefDomains": 0
      },
      "Data": []
    },
    "DomainsOnSubnet": {
      "Headers": {
        "IP": "216.58.204.*",
        "MaxRefDomainTopics": 10,
        "RefDomainTopicsCount": 1,
        "TotalDomains": 13878,
        "TotalExtBackLinks": 27640597,
        "TotalRefDomains": 231373
      },
      "Data": [
        {
          "Domain": "leadpages.net",
          "IPAddress": "216.58.204.*",
          "RefDomains": 28248,
          "ExtBackLinks": 8003454,
          "CitationFlow": 52,
          "TrustFlow": 46,
          "TopicalTrustFlow_Topic_0": "Arts/Photography",
          "TopicalTrustFlow_Value_0": 35
        },
        {
          "Domain": "google.bg",
          "IPAddress": "216.58.204.*",
          "RefDomains": 26232,
          "ExtBackLinks": 5217536,
          "CitationFlow": 40,
          "TrustFlow": 43,
          "TopicalTrustFlow_Topic_0": "Computers/Internet/Searching",
          "TopicalTrustFlow_Value_0": 41
        },
        {
          "Domain": "premiumbloggertemplates.com",
          "IPAddress": "216.58.204.*",
          "RefDomains": 9724,
          "ExtBackLinks": 1939819,
          "CitationFlow": 33,
          "TrustFlow": 24,
          "TopicalTrustFlow_Topic_0": "Computers/Internet/Searching",
          "TopicalTrustFlow_Value_0": 23
        },
        {
          "Domain": "randar.com",
          "IPAddress": "216.58.204.*",
          "RefDomains": 8545,
          "ExtBackLinks": 158689,
          "CitationFlow": 32,
          "TrustFlow": 24,
          "TopicalTrustFlow_Topic_0": "Arts/Television",
          "TopicalTrustFlow_Value_0": 23
        },
        {
          "Domain": "google.je",
          "IPAddress": "216.58.204.*",
          "RefDomains": 3430,
          "ExtBackLinks": 62574,
          "CitationFlow": 40,
          "TrustFlow": 17,
          "TopicalTrustFlow_Topic_0": "Computers/Internet/Searching",
          "TopicalTrustFlow_Value_0": 15
        },
        {
          "Domain": "yesbaekhyun.co.vu",
          "IPAddress": "216.58.204.*",
          "RefDomains": 3417,
          "ExtBackLinks": 21073,
          "CitationFlow": 0,
          "TrustFlow": 0,
          "TopicalTrustFlow_Topic_0": "",
          "TopicalTrustFlow_Value_0": ""
        },
        {
          "Domain": "quickoffice.com",
          "IPAddress": "216.58.204.*",
          "RefDomains": 2415,
          "ExtBackLinks": 14550,
          "CitationFlow": 26,
          "TrustFlow": 21,
          "TopicalTrustFlow_Topic_0": "Computers/Software/Operating Systems",
          "TopicalTrustFlow_Value_0": 21
        },
        {
          "Domain": "google.so",
          "IPAddress": "216.58.204.*",
          "RefDomains": 1885,
          "ExtBackLinks": 310079,
          "CitationFlow": 25,
          "TrustFlow": 11,
          "TopicalTrustFlow_Topic_0": "Computers/Internet",
          "TopicalTrustFlow_Value_0": 11
        },
        {
          "Domain": "youtube.nl",
          "IPAddress": "216.58.204.*",
          "RefDomains": 1581,
          "ExtBackLinks": 1754124,
          "CitationFlow": 35,
          "TrustFlow": 33,
          "TopicalTrustFlow_Topic_0": "Arts/Design",
          "TopicalTrustFlow_Value_0": 28
        },
        {
          "Domain": "yunlin.ws",
          "IPAddress": "216.58.204.*",
          "RefDomains": 1552,
          "ExtBackLinks": 21515,
          "CitationFlow": 23,
          "TrustFlow": 4,
          "TopicalTrustFlow_Topic_0": "Recreation/Outdoors",
          "TopicalTrustFlow_Value_0": 4
        }
      ]
    }
  }
}

Non-default Domain

Note that the return value Data was empty. This is caused by Google's round robin DNS. Our system stores the first IP address for a given domain, which is returned as RecommendedIP. This therefore means that another query will be needed, passing the value of RecommendedIP as the parameter Domain.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<Result Code="OK" ErrorMessage="" FullError="">
   <GlobalVars ChargedAnalysisResUnits="5000" ChargedRetrievalResUnits="20" GeoCountryCode="US" IndexBuildDate="2017-11-12 17:35:38" IndexType="1" IPs="1" RemainingAnalysisResUnits="94601180" RemainingRetrievalResUnits="18919319" ServerBuild="2017-10-25 14:33:44" ServerName="JAYPOUND" ServerVersion="1.0.6507.24412" UniqueIndexID="20171112173538-FRESH" />
   <DataTables Count="2">
      <DataTable Name="DomainsOnIP" RowsCount="10" Headers="Domain|IPAddress|RefDomains|ExtBackLinks|CitationFlow|TrustFlow|TopicalTrustFlow_Topic_0|TopicalTrustFlow_Value_0" IP="216.58.205.238" MaxRefDomainTopics="10" RefDomainTopicsCount="1" TotalDomains="18" TotalExtBackLinks="40026301874" TotalRefDomains="18930979">
         <Row>google.com|216.58.205.238|18926873|40026133354|100|100|Computers/Internet/Searching|88</Row>
         <Row>snapseed.com|216.58.205.238|1909|13434|23|16|Arts/Photography|16</Row>
         <Row>youtubego.com|216.58.205.238|967|3696|30|19|Arts/Music|15</Row>
         <Row>bissingers.com|216.58.205.238|572|11936|0|0| |</Row>
         <Row>youtube.ng|216.58.205.238|530|117777|19|21|Reference/Museums|20</Row>
         <Row>xn--p8j9a0d9c9a.xn--q9jyb4c|216.58.205.238|108|349|19|15|Computers/Software/Internet|13</Row>
         <Row>globaledu.org|216.58.205.238|6|25|10|10|Society/Religion and Spirituality|10</Row>
         <Row>chromecast.co.nz|216.58.205.238|3|9|4|0| |</Row>
         <Row>invitemediainc.com|216.58.205.238|3|7|6|2|Business/Telecommunications|2</Row>
         <Row>suoly.com|216.58.205.238|2|21276|0|0| |</Row>
      </DataTable>
      <DataTable Name="DomainsOnSubnet" RowsCount="10" Headers="Domain|IPAddress|RefDomains|ExtBackLinks|CitationFlow|TrustFlow|TopicalTrustFlow_Topic_0|TopicalTrustFlow_Value_0" IP="216.58.205.*" MaxRefDomainTopics="10" RefDomainTopicsCount="1" TotalDomains="21461" TotalExtBackLinks="40060864379" TotalRefDomains="19289968">
         <Row>google.com|216.58.205.*|18926873|40026133354|100|100|Computers/Internet/Searching|88</Row>
         <Row>google.lk|216.58.205.*|13779|733731|44|31|Society|25</Row>
         <Row>mystictreehouse.com|216.58.205.*|10240|2418981|41|10|Sports/Team Handball|10</Row>
         <Row>koreaboo.com|216.58.205.*|5767|143290|39|15|News/Weblogs|14</Row>
         <Row>google.com.sv|216.58.205.*|5156|478722|43|35|Recreation/Travel|35</Row>
         <Row>google.am|216.58.205.*|5042|301184|41|18|Recreation|18</Row>
         <Row>google.iq|216.58.205.*|4984|361787|42|25|Regional/Europe|25</Row>
         <Row>devilducky.com|216.58.205.*|3440|62428|0|0| |</Row>
         <Row>worldtoilet.org|216.58.205.*|3350|89296|
23|20|Society/Issues|18</Row>
         <Row>footyheadlines.com|216.58.205.*|3121|387755|39|20|Sports/Soccer|20</Row>
      </DataTable>
   </DataTables>
</Result>

JSON response

{
  "Code": "OK",
  "ErrorMessage": "",
  "FullError": "",
  "ChargedAnalysisResUnits": 5000,
  "ChargedRetrievalResUnits": 20,
  "GeoCountryCode": "US",
  "IndexBuildDate": "2017-11-12 17:35:38",
  "IndexType": 1,
  "IPs": 1,
  "RemainingAnalysisResUnits": 94606180,
  "RemainingRetrievalResUnits": 18919339,
  "ServerBuild": "2017-10-25 14:33:44",
  "ServerName": "JAYPOUND",
  "ServerVersion": "1.0.6507.24412",
  "UniqueIndexID": "20171112173538-FRESH",
  "DataTables": {
    "DomainsOnIP": {
      "Headers": {
        "IP": "216.58.205.238",
        "MaxRefDomainTopics": 10,
        "RefDomainTopicsCount": 1,
        "TotalDomains": 18,
        "TotalExtBackLinks": 40026301874,
        "TotalRefDomains": 18930979
      },
      "Data": [
        {
          "Domain": "google.com",
          "IPAddress": "216.58.205.238",
          "RefDomains": 18926873,
          "ExtBackLinks": 40026133354,
          "CitationFlow": 100,
          "TrustFlow": 100,
          "TopicalTrustFlow_Topic_0": "Computers/Internet/Searching",
          "TopicalTrustFlow_Value_0": 88
        },
        {
          "Domain": "snapseed.com",
          "IPAddress": "216.58.205.238",
          "RefDomains": 1909,
          "ExtBackLinks": 13434,
          "CitationFlow": 23,
          "TrustFlow": 16,
          "TopicalTrustFlow_Topic_0": "Arts/Photography",
          "TopicalTrustFlow_Value_0": 16
        },
        {
          "Domain": "youtubego.com",
          "IPAddress": "216.58.205.238",
          "RefDomains": 967,
          "ExtBackLinks": 3696,
          "CitationFlow": 30,
          "TrustFlow": 19,
          "TopicalTrustFlow_Topic_0": "Arts/Music",
          "TopicalTrustFlow_Value_0": 15
        },
        {
          "Domain": "bissingers.com",
          "IPAddress": "216.58.205.238",
          "RefDomains": 572,
          "ExtBackLinks": 11936,
          "CitationFlow": 0,
          "TrustFlow": 0,
          "TopicalTrustFlow_Topic_0": "",
          "TopicalTrustFlow_Value_0": ""
        },
        {
          "Domain": "youtube.ng",
          "IPAddress": "216.58.205.238",
          "RefDomains": 530,
          "ExtBackLinks": 117777,
          "CitationFlow": 19,
          "TrustFlow": 21,
          "TopicalTrustFlow_Topic_0": "Reference/Museums",
          "TopicalTrustFlow_Value_0": 20
        },
        {
          "Domain": "xn--p8j9a0d9c9a.xn--q9jyb4c",
          "IPAddress": "216.58.205.238",
          "RefDomains": 108,
          "ExtBackLinks": 349,
          "CitationFlow": 19,
          "TrustFlow": 15,
          "TopicalTrustFlow_Topic_0": "Computers/Software/Internet",
          "TopicalTrustFlow_Value_0": 13
        },
        {
          "Domain": "globaledu.org",
          "IPAddress": "216.58.205.238",
          "RefDomains": 6,
          "ExtBackLinks": 25,
          "CitationFlow": 10,
          "TrustFlow": 10,
          "TopicalTrustFlow_Topic_0": "Society/Religion and Spirituality",
          "TopicalTrustFlow_Value_0": 10
        },
        {
          "Domain": "chromecast.co.nz",
          "IPAddress": "216.58.205.238",
          "RefDomains": 3,
          "ExtBackLinks": 9,
          "CitationFlow": 4,
          "TrustFlow": 0,
          "TopicalTrustFlow_Topic_0": "",
          "TopicalTrustFlow_Value_0": ""
        },
        {
          "Domain": "invitemediainc.com",
          "IPAddress": "216.58.205.238",
          "RefDomains": 3,
          "ExtBackLinks": 7,
          "CitationFlow": 6,
          "TrustFlow": 2,
          "TopicalTrustFlow_Topic_0": "Business/Telecommunications",
          "TopicalTrustFlow_Value_0": 2
        },
        {
          "Domain": "suoly.com",
          "IPAddress": "216.58.205.238",
          "RefDomains": 2,
          "ExtBackLinks": 21276,
          "CitationFlow": 0,
          "TrustFlow": 0,
          "TopicalTrustFlow_Topic_0": "",
          "TopicalTrustFlow_Value_0": ""
        }
      ]
    },
    "DomainsOnSubnet": {
      "Headers": {
        "IP": "216.58.205.*",
        "MaxRefDomainTopics": 10,
        "RefDomainTopicsCount": 1,
        "TotalDomains": 21461,
        "TotalExtBackLinks": 40060864379,
        "TotalRefDomains": 19289968
      },
      "Data": [
        {
          "Domain": "google.com",
          "IPAddress": "216.58.205.*",
          "RefDomains": 18926873,
          "ExtBackLinks": 40026133354,
          "CitationFlow": 100,
          "TrustFlow": 100,
          "TopicalTrustFlow_Topic_0": "Computers/Internet/Searching",
          "TopicalTrustFlow_Value_0": 88
        },
        {
          "Domain": "google.lk",
          "IPAddress": "216.58.205.*",
          "RefDomains": 13779,
          "ExtBackLinks": 733731,
          "CitationFlow": 44,
          "TrustFlow": 31,
          "TopicalTrustFlow_Topic_0": "Society",
          "TopicalTrustFlow_Value_0": 25
        },
        {
          "Domain": "mystictreehouse.com",
          "IPAddress": "216.58.205.*",
          "RefDomains": 10240,
          "ExtBackLinks": 2418981,
          "CitationFlow": 41,
          "TrustFlow": 10,
          "TopicalTrustFlow_Topic_0": "Sports/Team Handball",
          "TopicalTrustFlow_Value_0": 10
        },
        {
          "Domain": "koreaboo.com",
          "IPAddress": "216.58.205.*",
          "RefDomains": 5767,
          "ExtBackLinks": 143290,
          "CitationFlow": 39,
          "TrustFlow": 15,
          "TopicalTrustFlow_Topic_0": "News/Weblogs",
          "TopicalTrustFlow_Value_0": 14
        },
        {
          "Domain": "google.com.sv",
          "IPAddress": "216.58.205.*",
          "RefDomains": 5156,
          "ExtBackLinks": 478722,
          "CitationFlow": 43,
          "TrustFlow": 35,
          "TopicalTrustFlow_Topic_0": "Recreation/Travel",
          "TopicalTrustFlow_Value_0": 35
        },
        {
          "Domain": "google.am",
          "IPAddress": "216.58.205.*",
          "RefDomains": 5042,
          "ExtBackLinks": 301184,
          "CitationFlow": 41,
          "TrustFlow": 18,
          "TopicalTrustFlow_Topic_0": "Recreation",
          "TopicalTrustFlow_Value_0": 18
        },
        {
          "Domain": "google.iq",
          "IPAddress": "216.58.205.*",
          "RefDomains": 4984,
          "ExtBackLinks": 361787,
          "CitationFlow": 42,
          "TrustFlow": 25,
          "TopicalTrustFlow_Topic_0": "Regional/Europe",
          "TopicalTrustFlow_Value_0": 25
        },
        {
          "Domain": "devilducky.com",
          "IPAddress": "216.58.205.*",
          "RefDomains": 3440,
          "ExtBackLinks": 62428,
          "CitationFlow": 0,
          "TrustFlow": 0,
          "TopicalTrustFlow_Topic_0": "",
          "TopicalTrustFlow_Value_0": ""
        },
        {
          "Domain": "worldtoilet.org",
          "IPAddress": "216.58.205.*",
          "RefDomains": 3350,
          "ExtBackLinks": 89296,
          "CitationFlow": 23,
          "TrustFlow": 20,
          "TopicalTrustFlow_Topic_0": "Society/Issues",
          "TopicalTrustFlow_Value_0": 18
        },
        {
          "Domain": "footyheadlines.com",
          "IPAddress": "216.58.205.*",
          "RefDomains": 3121,
          "ExtBackLinks": 387755,
          "CitationFlow": 39,
          "TrustFlow": 20,
          "TopicalTrustFlow_Topic_0": "Sports/Soccer",
          "TopicalTrustFlow_Value_0": 20
        }
      ]
    }
  }
}

Returned values

Return value Description
Code Code indicating whether this command succeeded.
ErrorMessage A message explaining the error. This will be blank if the code is "OK".
FullError Verbose explanation of error.
ChargedAnalysisResUnits Number of analysis res units charged to execute this command.
ChargedRetrievalResUnits Number of retrieval res units charged to execute this command.
GeoCountryCode Geo-location of the country where the server hosting the given domain is.
IndexBuildDate Date/time on which the index queried by this command was built.
IndexType Boolean indicating whether the index queried is Historical (0) or Fresh (1).
IPs Number of IPs.
RecommendedIP Recommended IP to query.
RemainingAnalysisResUnits Number of remaining Analysis units for this user account.
RemainingRetrievalResUnits Number of remaining Retrieval units for this user account.
ServerBuild Date/time of the server build when this command was executed.
ServerName Name of the server queried when this command was executed.
ServerVersion Version of the server queried.
UniqueIndexID Unique identifier for the index queried when this command was executed.
DomainsOnIP Contains all domains found on the IP address.
DomainsOnSubnet Contains all domains found on subdomains.
IP IP address of the given domain.
MaxRefDomainTopics The maximum amount of topics for this given domain.
RefDomainTopicsCount Number of topics for this domain.
TotalDomains Total domains on IP/subnet.
TotalExtBackLinks Total number of links linking to this domain externally.
TotalRefDomains Number of domains referring to this domain.
Domain Name of the domain.
RefDomains Number of reference domains coming from this domain.
ExtBackLinks Number of external links to this domain.
CitationFlow CitationFlow value for this domain.
TrustFlow TrustFlow value for this domain.
TopicalTrustFlow_Topic_0 Primary TrustFlow_Topic for this domain.
TopicTrustFlow_Value_0 Trust_Flow_Value for this domain.