---
title: "Get Website Status"
method: POST
path: "/api/v1/website/status"
tags: ["Website Status"]
---

# Get Website Status

`POST /api/v1/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.

## Request body

- WebsiteInput
  - `website` string, required — The website URL to evaluate.
  - `request_timeout` number — 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.

## Response `200`

OK

- StatusResponse
  - `alive` boolean, required — Indicates whether the domain's webserver responded with a valid HTTP code before the request timed out.
  - `social_media` SocialMediaLink, required
    - `is_social_media_link` boolean — Is this a known social media site?
    - `platform` string, nullable — The social media platform this link is from.
  - `marketplace` MarketplaceLink, required
    - `is_marketplace_link` boolean — Is this a known marketplace site for selling goods or services?
    - `platform` string, nullable — The marketplace platform this link is from.
  - `is_top_domain` boolean — A domain that is known to be one of the most popular sites on the internet.
  - `is_hosting_provider_domain` boolean — A domain that is known to be owned by a hosting provider.
  - `is_link_shortener_domain` boolean — A domain that is known to be owned by a link shortening service.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `422` — Unprocessable Entity
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/truebiz/apis/truebiz-web-presence-review-api.md) · [All operations](https://skmtc.net/truebiz/apis/truebiz-web-presence-review-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/truebiz/truebiz-web-presence-review-api/revisions/22a9a6d3740a/schema)