StalkrDevelopers
OpenAPIDashboard
OverviewQuickstartAuthenticationREST APIMCPWebhooksErrors & limits

GET · usage:read

Get usage and limits

Get plan, mention, keyword, source, and project usage with the same billing windows as the dashboard. Trial workspaces include 100 free mentions. Paid discovery pauses at the mention limit and automatically becomes eligible again when an upgrade or monthly usage reset adds allowance.

Read only

REST

GET/api/v1/usage
curl "https://www.stalkr.ai/api/v1/usage" \
  --request GET \
  --header "Authorization: Bearer $STALKR_API_KEY"

MCP

Tool name: get_usage

The MCP tool accepts the same input schema and returns the same structured { data, meta } result as REST.

Input

This operation has no input fields.

Authorization

Required scope: usage:read.

Scope authorization is followed by resource authorization. Project operations check current membership and the minimum role required by the underlying workflow.

Related resources

REST conventions · MCP setup · Errors and limits