Alert configurations

GET https://api.unusualwhales.com/api/alerts/configuration

Request

Security: Bearer Auth Authorization: Bearer <token>

Responses

200 422 500

Response Body 200 OK

config The configuration of an alert.

An alert configuration, there is no fixed schema for this as each alert will have a different configuration.

Example: {"config":{"option_symbols":["TGT241122C00177500"],"symbols":"all"}}

created_at The creation timestamp

Example: 2024-11-19T18:19:14Z

id The alert id

Example: ebe24953-a0bf-4b4d-98be-14f721a1199a

name The name of the alert

Example: Chain OI Chg: TGT241122C00177500

noti_type The type of the alert

Example: chain_oi_change

status The status of the alert

Example: active

Try It GET

API Token

Request Sample

curl -X GET "https://api.unusualwhales.com/api/alerts/configuration" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

import http.client

conn = http.client.HTTPSConnection("api.unusualwhales.com")
headers = {"Authorization": "Bearer YOUR_API_KEY", "Accept": "application/json"}
conn.request("GET", "/api/alerts/configuration", headers=headers)
response = conn.getresponse()
print(response.read().decode("utf-8"))

Response Example 200

{
  "data": [
    {
      "config": {
        "option_symbols": [
          "TGT241122C00177500"
        ],
        "symbols": "all"
      },
      "created_at": "2024-11-19T18:19:14Z",
      "id": "ebe24953-a0bf-4b4d-98be-14f721a1199a",
      "name": "Chain OI Chg: TGT241122C00177500",
      "noti_type": "chain_oi_change",
      "status": "active"
    },
    {
      "config": {
        "name_contains": [
          "berkshire"
        ],
        "symbols": "all"
      },
      "created_at": "2024-08-09T23:23:13Z",
      "id": "4457d60e-e7e5-4950-82e6-0ea010586f25",
      "name": "Berkshire",
      "noti_type": "sec_filings",
      "status": "active"
    }
  ]
}