Q4API Docs
Q4 APISign inGet API key
DocumentationAPI Reference
Overview
API reference
Companies
GETList companiesGETRetrieve a companyGETList sectors
Market data
GETRetrieve a quoteGETList quotesGETRetrieve price historyGETRetrieve index historyGETRetrieve market summaryGETList market moversGETList sector performanceGETList tradesGETRetrieve order book depth
WebSocket
WSQuotes streamWSTrades streamWSDepth stream
Fundamentals
GETRetrieve standardised statementsGETRetrieve as-reported statementsGETList figuresGETRetrieve ratiosGETCompare companiesGETList dividendsGETList corporate actionsGETList stock eventsGETSearch notes
Documents
GETList documentsGETRetrieve a documentGETList document pagesGETRetrieve document textGETRetrieve document summaryGETList notesGETRetrieve a noteGETList sectionsGETRetrieve a sectionGETSearch board report sections
Earnings calls
GETList earnings callsGETRetrieve an earnings callGETRetrieve a transcriptGETRetrieve call audio
Announcements
GETList announcementsGETRetrieve an announcement
Economic data
GETList seriesGETList observations
Webhooks & alerts
POSTCreate a webhookGETList webhooksDELDelete a webhookPOSTCreate an alert ruleGETList alert rulesDELDelete an alert rule
Account
GETRetrieve usage
Account

Retrieve usage

GEThttps://api.q4.sa/v1/usage
Returns your plan, today’s request count and when the quota resets. Does not count towards it.
Free

Authorization

x-api-keyheaderrequired
Your API key. See Authentication.

Response

dataobject
The result.
planstring
requests_todayinteger
requests_per_dayinteger
requests_per_minuteinteger
resets_atdatetime
keysinteger

Errors

400, 401, 403, 404, 429. Every error has the same shape: see Errors.
← Previous
Delete an alert rule
Request
curl "https://api.q4.sa/v1/usage" \
  -H "x-api-key: $Q4_API_KEY"
Response
{
  "data": {
    "plan": "starter",
    "requests_today": 1284,
    "requests_per_day": 5000,
    "requests_per_minute": 100,
    "resets_at": "2026-11-04T21:00:00Z",
    "keys": 2
  }
}