Account

Account, credits and limits

Everything an agent should know before it spends: the plan, the credits available now and where they come from, this month's campaign email allowance, the requests per minute and per 10 seconds this key may send, the searches and counts a minute the account may run (shared by all its keys) and, during the trial, a day, the other daily limits per key, and the key's scopes. Call it before a large reveal, export or campaign.

CostWhat it doesKey scopes
FreeReads onlynone
get/api/v1/account

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/account
  • Auth: HTTP bearer

Headers

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Response

OK

emailstring email

The account the key acts as.

workspaceobject

id, name and your role in it.

planobject

name, status and renewal date.

creditsobject

available now, from the plan, pay as you go and free credits.

campaign_emailsobject

This month's campaign email allowance: allowance, used, remaining, resets_on.

rate_limitobject

requests_per_minute and burst_per_10_seconds for this key, searches_and_counts_per_minute and the daily counts and search rows for the account, the other daily limits per key.

scopesstring[]

Scopes of this key.

Changes

No recorded changes to this operation across all 1 revision of this API.