Skip to main content
GET
/
v2
/
account
/
usage
Get Account Usage
curl --request GET \
  --url https://api.calmyx.com/v2/account/usage \
  --header 'Authorization: <authorization>'
{
  "status": "OK",
  "request": {
    "api_key": "your-api-key"
  },
  "response": {
    "API Key Current Usage": 4250,
    "API Key Max Plan Usage": 50000,
    "Subscription Plan": "insight",
    "Active Listings Count": 1250,
    "Active Listings Max": 10000
  }
}

​
Overview

The Get Account Usage API returns information about your current API usage, plan limits, and subscription details. Use this endpoint to monitor your Quiet Score™ API consumption and active listings.
To obtain an API key, register for an account and subscribe to a plan.

​
Authorization

​
Authorization
string
required
Your API key for authentication
{
  "status": "OK",
  "request": {
    "api_key": "your-api-key"
  },
  "response": {
    "API Key Current Usage": 4250,
    "API Key Max Plan Usage": 50000,
    "Subscription Plan": "insight",
    "Active Listings Count": 1250,
    "Active Listings Max": 10000
  }
}

​
Response Fields

FieldTypeDescription
statusstringStatus of the request (“OK” for success)
request.api_keystringThe API key used for the request
response.API Key Current UsagenumberNumber of API calls made in the current billing period
response.API Key Max Plan UsagenumberMaximum number of API calls allowed (-1 for unlimited)
response.Subscription PlanstringName of your current subscription plan (trial, insight, intelligence, enterprise)
response.Active Listings CountnumberNumber of active listings tracked
response.Active Listings MaxnumberMaximum number of listings allowed (-1 for unlimited)

​
Plan Limits

PlanAPI Requests/MonthActive Listings
Trial100100
Insight50,00010,000
Intelligence500,000100,000
EnterpriseUnlimitedUnlimited

​
Use Cases

  • Usage monitoring: Track your API consumption to avoid exceeding plan limits
  • Listings monitoring: Monitor how many locations you’ve tracked
  • Plan management: Determine if you need to upgrade your subscription plan

​
Notes

  • API usage counts are reset at the beginning of each billing period
  • Active listings persist until manually deleted
  • Contact soheil@calmyx.com if you need to upgrade your plan