Skip to main content
GET
Get price alerts

Authorizations

x-api-key
string
header
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"329956a0-ccb2-455e-b309-80ca58cbce4e"

Query Parameters

alertIds
string

Comma-separated list of alert IDs to filter by. AND-combined with the instrument filter when both are present.

instrumentIds
string

Comma-separated list of instrument IDs to filter by. Treated as the same dimension as symbols — results matching either instrumentIds or symbols are returned.

symbols
string

Comma-separated list of trading symbols to filter by. Treated as the same dimension as instrumentIds — results matching either symbols or instrumentIds are returned.

Response

Successfully retrieved price alerts

Collection of price alerts for the authenticated user

results
object[]

List of price alerts matching the query criteria