v1
latestOpenAPI 3.0.12026-07-26171200932.8 KBPrice Alerts
Create 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.
Creates a new price alert for the authenticated user. The alert will fire when the market bid price reaches the target price. Provide a symbol to identify the instrument.
post/api/v1/price-alerts
Headers
x-request-idstring uuid required
Example:f7074675-ea01-40a7-a853-ec592ba8ceea
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
Example request
{
"symbol": "AAPL",
"targetPrice": 185.5
}Response
Price alert created 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"
}
}