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

Create an alert rule

POSThttps://api.q4.sa/v1/alerts
Sends an alert.triggered webhook when a price or volume condition is met.
Pro+

Authorization

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

Body

symbolstringrequired
Tadawul symbol.
typestringrequired
Condition to watch.
One of:price_aboveprice_belowchange_percentabnormal_volumeunusual_value
valuenumberrequired
Threshold: a price in SAR, a percent, or a multiple of the 20-day average.
onceboolean
Disable the rule after it fires once.
Default: true

Response

dataobject
The result.
idstring
Unique ID.
symbolstring
Tadawul symbol.
typestring
Type.
valueinteger
Value.
onceboolean
statusstring
Current status.
created_atdatetime
When this record was created.

Errors

400, 401, 403, 404, 429. Every error has the same shape: see Errors.
← Previous
Delete a webhook
Next →
List alert rules
Request
curl -X POST "https://api.q4.sa/v1/alerts" \
  -H "x-api-key: $Q4_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"symbol":"2222","type":"price_above","value":27,"once":true}'
Response
{
  "data": {
    "id": "alr_8Wd3Qe",
    "symbol": "2222",
    "type": "price_above",
    "value": 27,
    "once": true,
    "status": "active",
    "created_at": "2026-11-04T09:01:00Z"
  }
}