Account

Get your usage and allowance

The same numbers the API uses to accept or refuse a search. Free: costs no request, but counts toward the per-minute rate limit.

get/usage

Request

  • Base URL: https://api.soldgraph.com/v1
  • URL: https://api.soldgraph.com/v1/usage
  • Auth: HTTP bearer

Response

Your usage.

planstring required

Your plan, like free or pro.

usedinteger required

Requests counted against the allowance: in the rolling 30 days, or of the one-time free credit when window is one_time. Free accounts include linked accounts.

limitinteger nullable required

The plan's allowance per rolling 30 days, or the size of the one-time free credit when window is one_time. Null when unlimited.

remaininginteger nullable required

limit minus used, never below 0. Null when unlimited.

extra_requestsinteger required

Extra requests bought on top of the plan. Spent only after the allowance.

window'rolling_30_days' | 'one_time' required

rolling_30_days: usage frees up as it ages out. one_time: a free account's one-time credit, which does not refill.

shared_allowanceboolean required

True when other linked free accounts draw on the same allowance.

rate_limit_per_minuteinteger required

API calls allowed per minute, job polls and this call included.

Changes

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