v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB

Price Alerts

Get price alerts

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.

Returns all active price alerts for the authenticated user.

get/api/v1/price-alerts

Headers

x-request-idstring uuid required

Example:6048174f-b443-4388-bb54-1ebec1ce4219

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.

Response

Successfully retrieved price alerts

Example response

{
  "results": [
    {
      "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"
    }
  ]
}