v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
Price Alerts

Update a price alert

Rate limit: 60 requests per 60 seconds. This is the default shared quota — it is shared with every other endpoint that has no dedicated limit, so requests across those endpoints all draw from the same budget.


Updates the target price of an existing price alert.

patch/api/v1/price-alerts/{alertId}

Path parameters

alertIdstring uuid required

Unique identifier of the price alert

Headers

x-request-idstring uuid required
Example:88623e83-4f78-4dac-8456-26e5828ee64d

A unique request identifier.

x-api-keystring password required
Example:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

API key for authentication.

x-user-keystring password required
Example:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

User-specific authentication key.

Request body

targetPricenumber required

New target price for the alert. Must be greater than 0.

Example request

{
  "targetPrice": 190
}

Response

Price alert updated successfully

successboolean

Indicates the operation completed successfully

Example response

{
  "success": true,
  "data": {
    "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "instrumentId": 1001,
    "symbol": "AAPL",
    "targetPrice": 185.5,
    "currentPrice": 182.3,
    "createdAt": "2026-04-20T10:00:00Z",
    "updatedAt": "2026-04-25T14:30:00Z"
  }
}