Skip to main content
Alerts let you define conditions on prediction market prices and receive a notification when those conditions are met. For example, you can set an alert to fire when the probability on “Will BTC reach $100k by 2026?” drops below 0.50, or when the index price divergence spikes above a threshold. Alerts are scoped to your authenticated account.

Authentication

A session JWT or SIWE session cookie is required:
Authorization: Bearer <your_jwt>

Endpoints

MethodPathDescription
GET/api/v1/alertsList all your active alerts
POST/api/v1/alertsCreate a new alert
GET/api/v1/alerts/{id}Get a single alert
PATCH/api/v1/alerts/{id}Update alert condition or active state
DELETE/api/v1/alerts/{id}Delete an alert

List alerts

GET https://api.predexy.com/api/v1/alerts
Returns all alerts associated with your account.

Example request

cURL
curl https://api.predexy.com/api/v1/alerts \
  -H "Authorization: Bearer <your_jwt>"

Sample response

{
  "data": [
    {
      "id": "alrt-3fa85f64-0000-0000-0000-000000000001",
      "type": "price_threshold",
      "canonical_question_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "condition": {
        "field": "index_price",
        "operator": "below",
        "value": 0.50
      },
      "is_active": true,
      "created_at": "2026-04-20T08:00:00Z"
    }
  ]
}

Create an alert

POST https://api.predexy.com/api/v1/alerts
Creates a new price movement alert. Attach the alert to a canonical question or a specific platform market.

Request body

type
string
required
Alert type. Use "price_threshold" to trigger when a price crosses a value.
condition
object
required
Alert condition object. The structure depends on type, but typically includes a field to watch, an operator (above, below, equals), and a value.
canonical_question_id
string
UUID of the canonical question to watch. Monitors the cross-platform index price.
market_id
string
UUID of a specific platform market to watch. Monitors that platform’s price directly.

Example request

cURL
curl -X POST https://api.predexy.com/api/v1/alerts \
  -H "Authorization: Bearer <your_jwt>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "price_threshold",
    "canonical_question_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "condition": {
      "field": "index_price",
      "operator": "below",
      "value": 0.50
    }
  }'

Sample response

{
  "data": {
    "id": "alrt-3fa85f64-0000-0000-0000-000000000001",
    "type": "price_threshold",
    "canonical_question_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "condition": {
      "field": "index_price",
      "operator": "below",
      "value": 0.50
    },
    "is_active": true,
    "created_at": "2026-04-25T15:30:00Z"
  }
}

Update an alert

PATCH https://api.predexy.com/api/v1/alerts/{id}
Update the condition or toggle the active state of an existing alert without deleting and recreating it.

Request body

type
string
New alert type.
condition
object
Updated condition object.
is_active
boolean
Set to false to pause the alert without deleting it.
Use is_active: false to temporarily silence an alert — for example, during a period when you know prices will be volatile and you want to reduce notification noise. Toggle it back to true when you want to resume monitoring.