Check the cost of a reveal

What revealing this company would cost right now, and your remaining quota. Nothing is spent.

GEThttps://findbytown.com/api/v1/businesses/{id}/revealNo quota

Path parameters

Name	Type	Description
id(required)	integer	Company id, an integer.

Examples

curl "https://findbytown.com/api/v1/businesses/1001/reveal" \
  -H "Authorization: Bearer fbt_EXAMPLE_not_a_real_key_0000"

const res = await fetch("https://findbytown.com/api/v1/businesses/1001/reveal", {
  headers: { Authorization: "Bearer fbt_EXAMPLE_not_a_real_key_0000" },
});
const body = await res.json();
if (!res.ok) throw new Error(body.error);
console.log(body);

import requests

res = requests.get(
    "https://findbytown.com/api/v1/businesses/1001/reveal",
    headers={"Authorization": "Bearer fbt_EXAMPLE_not_a_real_key_0000"},
)
body = res.json()
if not res.ok:
    raise RuntimeError(body["error"])
print(body)

Response

Example with fake values:

{
  "data": {
    "id": 1001,
    "cost": 1,
    "alreadyRevealed": false,
    "quota": {
      "used": 12,
      "allowance": 10000,
      "remaining": 9988,
      "resetAt": "2030-01-01T00:00:00.000Z"
    }
  }
}

Errors

Code	HTTP status	Meaning
bad_id	400	The company id is not a positive integer.
missing_api_key	401	No Authorization header, or an empty one.
invalid_api_key	401	The key does not exist or has been revoked.
plan_without_api	403	The account's current plan does not include the API. Applies from the moment a plan ends.
suspended	403	The account is suspended. Its keys start working again if the suspension is lifted.
not_found	404	No such company, or it was removed at its owner's request.
email_invalid	409	This company's email is marked invalid, so it cannot be revealed. Nothing was spent.
rate_limited	429	Too many requests this minute. Wait for the number of seconds in Retry-After.
blocked	429	Access to company data is temporarily paused because of automated use, such as walking through ids. Retry-After gives the time left. Write to support if this is a mistake.
internal_error	500	Something went wrong on our side. Quote requestId when writing to support.

Back to findbytown