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
Webhooks & alerts

List alert rules

GEThttps://api.q4.sa/v1/alerts
Lists your alert rules and when they last fired.
Pro+

Authorization

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

Response

dataobject[]
The result.
idstring
Unique ID.
symbolstring
Tadawul symbol.
typestring
Type.
valueinteger
Value.
onceboolean
statusstring
Current status.
last_triggered_atnull

Errors

400, 401, 403, 404, 429. Every error has the same shape: see Errors.
← Previous
Create an alert rule
Next →
Delete an alert rule
Request
curl "https://api.q4.sa/v1/alerts" \
  -H "x-api-key: $Q4_API_KEY"
Response
{
  "data": [
    {
      "id": "alr_8Wd3Qe",
      "symbol": "2222",
      "type": "price_above",
      "value": 27,
      "once": true,
      "status": "active",
      "last_triggered_at": null
    }
  ]
}