Website Status

Get Website Status

This API endpoint allows you to test if a webserver is responsive similar to popular "is it up" type sites. It will also check to see if the website link corresponds to known social media or marketplace sites. Given that some pages load extremely slowly, the higher you set the timeout the more likely you are to get an accurate result. Our default of 7.5 seconds is accurate about 99% of the time in our testing. This API requires a valid API key (X-API-KEY) to be provided in the headers and is rate limited to 5 requests per second.

post/api/v1/website/status

Request body

websitestring required

The website URL to evaluate.

request_timeoutnumber nullable

The maximum amount of time to spend on checking if the webserver is responsive.Adjusting this parameter to be shorter may cause valid but slow responding websites to be marked as not alive. Adjusting this parameter to be longer may allow for more websites to be recognized as alive.

Example request

{
  "website": "https://example.net/test?param1=value1",
  "request_timeout": 7.5
}

Response

OK

aliveboolean required

Indicates whether the domain's webserver responded with a valid HTTP code before the request timed out.

is_top_domainboolean nullable

A domain that is known to be one of the most popular sites on the internet.

is_hosting_provider_domainboolean nullable

A domain that is known to be owned by a hosting provider.

is_link_shortener_domainboolean nullable

A domain that is known to be owned by a link shortening service.

Example response

{
  "alive": true
}

Changes

Changed in 1 of the 12 revisions of this API.51

  • fd8c32a19c7f51See the full diff
    • ▲

      response property is_hosting_provider_domain list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property is_link_shortener_domain list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property is_top_domain list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property marketplace/platform list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property social_media/platform list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened