Plans and features
Your account's plan, extra permissions on your account, and your team decide what you can see and how much you can use the API. This page explains each of those, and how to find your own limits.
What a plan changes
| Feature | Who has it |
|---|---|
| Public reports, search, reputation lookup, Host Profile, submitting URLs | Every account, including the free plan. Submissions can be public, restricted, or private on every plan. |
| Other accounts' restricted reports | Premium, Enterprise, and Research plans. |
| Reputation export | Accounts granted the reputation_export capability. Contact urlquery to request it. |
| API rate limits | Higher on larger plans. See rate limits. |
Your own reports and your team's reports are always visible to you, whatever their visibility and your plan. See report visibility.
Teams
A team groups accounts that work together.
- Shared reports. Team members see each other's restricted and private reports, and
scope=teamlists them. They can also follow each other's submissions withGET /public/v2/submissions/{queue_id}. - Shared plan. A member's account uses the team's plan, so every member gets the same features.
- Shared quota. Members share one set of API rate limits. One member's automation can use up the quota for everyone, so give heavy automation its own team or plan for it.
- Shared keys. API keys created by a team member belong to the team; every member can see and delete them. Requests with a key act as the member who created it.
Rate limits
Every v2 request counts against the quota class of its route and against your account's overall v2 quota. Each quota has a minute, an hour, and a day window. The API overview lists the classes and explains which requests count.
You do not need to look your limits up. Every response tells you the quota that limits you most:
RateLimit-Policy: 100;w=60, 500;w=3600, 1000;w=86400
RateLimit-Limit: 100
RateLimit-Remaining: 87
RateLimit-Reset: 41
RateLimit-Policy lists the limit for each window (w is the window length in seconds), RateLimit-Remaining is what is left in the governing window, and RateLimit-Reset is the seconds until that window resets. The reputation export has much lower limits than other routes and also limits how many exports run at the same time.
To make the most of your quota:
- Start with overviews. An overview is one cheap request; fetch the full report, screenshot, or resources only for reports that matter.
- Use the largest useful page. One request with
limit=100costs the same as one withlimit=10. - Narrow searches. Specific fields and a date range return the reports you need in fewer pages.
- Store what you need. The evidence in a report does not change after its analysis finishes; keep the reports you rely on instead of fetching them again. Only statistics such as how often a resource has been seen keep growing.
- Watch
RateLimit-Remaining. Slow down before it reaches zero rather than waiting out a429.
Upgrading
Plan changes and extra permissions are handled by urlquery. Use the contacts on the support page.