Key and plan

The plan behind this key, what it may do, and when the key was last seen. Call it first: it is the cheapest way to learn your rate limit, your remaining reveals and whether the `since` feed is available to you, and it costs one request and no reveals.

GET/api/v1/me

Authorizations

Authorizationstringheaderrequired

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

Responses

Who this key belongs to.

creditsany

Pay-as-you-go credits for paid checks (1 credit = $0.01 at the base rate). Separate from `reveals`. null if the balance could not be read.

keyobjectrequired

plan"free" | "starter" | "business"required

The OWNER's plan right now, resolved on every request. A lapsed subscription reads as `free` here without anything having revoked the key.

Available options: free, starter, business

rate_limitobjectrequired

This key's bucket, after the call you just made. `limit` is the plan's per-minute ceiling; `remaining` is what is left in the current one-minute window.

revealsobjectrequired

Counted in credits. `limit` is null on a plan with no reveal ceiling. On a plan WITH one, `remaining` is the budget for `POST /domains/{id}/reveal`, and it is also what decides whether a listing you have not revealed arrives with its `domain` or with a mask. `limit` includes `rollover`, unused credits carried in from the previous period.

sync_feedbooleanrequired

Whether `GET /domains?since=` is included on this plan. False means that one parameter answers 402; everything else on this API still works.

curl --request GET \
  --url "https://getrevised.com/api/v1/me" \
  --header "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://getrevised.com/api/v1/me", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  },
});
const data = await res.json();

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

r = requests.get("https://getrevised.com/api/v1/me", headers=headers)
r.raise_for_status()
data = r.json()

{
  "credits": {
    "available": 123,
    "balance": 123,
    "check_cost": 123,
    "monthly": 123,
    "monthly_resets_at": {},
    "pack": 123,
    "pending": 123
  },
  "key": {
    "created_at": "2023-11-07T05:31:56Z",
    "last_used_at": {},
    "name": "<string>",
    "prefix": "<string>"
  },
  "plan": "free",
  "rate_limit": {
    "limit": 123,
    "remaining": 123
  },
  "reveals": {
    "featured_credits": {},
    "limit": {},
    "remaining": {},
    "resets_at": "2023-11-07T05:31:56Z",
    "rollover": 123,
    "used": 123
  },
  "sync_feed": true
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "conflict",
    "credits_needed": 123,
    "credits_remaining": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}