Revised

Price or start a deep check

Price or start a paid deep check of ONE domain: overview, referring domains, backlinks and anchors, priced in credits (see `GET /credits`). It reads only the name you send and never the directory, so the report is the same whether or not the name is listed. WITHOUT `confirm: true` it spends nothing and answers `confirmation_required` with the price, whether your balance covers it and a `topup_url`. WITH `confirm: true` and an `Idempotency-Key` header it answers 202 at once with the running check; the sections run in the background in priority order and each is charged only when it completes (a failed section is refunded in full). Poll `GET /checks/{id}`. A balance that covers only some sections runs those and reports `clamp`; one that covers none is a 402 `insufficient_credits` carrying `required`, `balance` and `topup_url`. A saved check of the name from the last 7 days is returned for 0 credits, and sections you already paid for are not charged again. Retrying with the same `Idempotency-Key` returns the same check.

POST/api/v1/checks

Price or start a paid deep check of ONE domain: overview, referring domains, backlinks and anchors, priced in credits (see `GET /credits`). It reads only the name you send and never the directory, so the report is the same whether or not the name is listed. WITHOUT `confirm: true` it spends nothing and answers `confirmation_required` with the price, whether your balance covers it and a `topup_url`. WITH `confirm: true` and an `Idempotency-Key` header it answers 202 at once with the running check; the sections run in the background in priority order and each is charged only when it completes (a failed section is refunded in full). Poll `GET /checks/{id}`. A balance that covers only some sections runs those and reports `clamp`; one that covers none is a 402 `insufficient_credits` carrying `required`, `balance` and `topup_url`. A saved check of the name from the last 7 days is returned for 0 credits, and sections you already paid for are not charged again. Retrying with the same `Idempotency-Key` returns the same check.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

Idempotency-Keystring

Required with `confirm: true`. 8 to 120 characters (letters, digits and . _ : -). A retry with the same key never charges twice; the same key for a different domain or a different set of sections is a 409 `conflict`.

Request bodyrequired

confirmboolean

true to run it and spend credits. Omit to get the price only.

domainstringrequired
sections"overview" | "referring_domains" | "backlinks" | "anchors"[]

Available options: overview, referring_domains, backlinks, anchors

Responses

A price, or a saved check.

curl --request POST \
  --url "https://getrevised.com/api/v1/checks" \
  --header "Authorization: Bearer YOUR_API_KEY"
{}

Type to search…

↑↓ navigate↵ openesc close