eToro Price Alerts API
The Price Alerts API from eToro — 2 operation(s) for price alerts.
OpenAPI Specification
openapi: 3.0.1
info:
title: Deprecated eToro Public API operations Agent Portfolios Price Alerts API
version: v1.158.0
description: Snapshot of API operations that existed in the previous docs OpenAPI file and are no longer present in the current upstream Swagger.
tags:
- name: Price Alerts
paths:
/api/v1/price-alerts:
get:
tags:
- Price Alerts
summary: Get price alerts
description: Returns all active price alerts for the authenticated user.
responses:
'200':
description: Successfully retrieved price alerts
content:
application/json:
schema:
$ref: '#/components/schemas/PriceAlertCollectionResponse'
example:
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'
- alertId: b2c3d4e5-f6a7-8901-bcde-f12345678901
instrumentId: 1002
symbol: TSLA
targetPrice: 250.0
currentPrice: 265.1
createdAt: '2026-04-22T08:15:00Z'
updatedAt: '2026-04-22T08:15:00Z'
'401':
description: Unauthorized - missing or invalid authentication credentials
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: Unauthorized
errorMessage: Unauthorized
'403':
description: Forbidden - insufficient permissions
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: InsufficientPermissions
errorMessage: Insufficient permissions to access this resource
'429':
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: TooManyRequests
errorMessage: Too many requests
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: UnhandledException
errorMessage: Global Error
parameters:
- name: x-request-id
in: header
required: true
schema:
type: string
format: uuid
example: 818633f4-c4de-46d0-a3e6-a2f083c17659
description: A unique request identifier.
- name: x-api-key
in: header
required: true
schema:
type: string
format: password
example: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
description: API key for authentication.
- name: x-user-key
in: header
required: true
schema:
type: string
format: password
example: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
description: User-specific authentication key.
operationId: getPriceAlerts
post:
tags:
- Price Alerts
summary: Create a price alert
description: 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.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePriceAlertRequest'
example:
symbol: AAPL
targetPrice: 185.5
responses:
'201':
description: Price alert created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/PriceAlertMutationResponse'
example:
success: true
data:
alertId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
instrumentId: 1001
symbol: AAPL
targetPrice: 185.5
currentPrice: 182.3
createdAt: '2026-04-30T10:00:00Z'
updatedAt: '2026-04-30T10:00:00Z'
'400':
description: Invalid request parameters (e.g. missing symbol, invalid targetPrice)
content:
application/json:
schema:
$ref: '#/components/schemas/PriceAlertErrorResponse'
example:
success: false
error:
code: INVALID_PARAMETER
message: Invalid request parameters
details: Field 'targetPrice' must be greater than 0
field: targetPrice
'401':
description: Unauthorized - missing or invalid authentication credentials
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: Unauthorized
errorMessage: Unauthorized
'403':
description: Forbidden - insufficient permissions
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: InsufficientPermissions
errorMessage: Insufficient permissions to access this resource
'404':
description: Instrument not found for the provided symbol
content:
application/json:
schema:
$ref: '#/components/schemas/PriceAlertErrorResponse'
example:
success: false
error:
code: INSTRUMENT_NOT_FOUND
message: Instrument not found
details: No instrument found for symbol 'INVALID'
'422':
description: Business rule violation (e.g. duplicate alert, max alerts exceeded)
content:
application/json:
schema:
$ref: '#/components/schemas/PriceAlertErrorResponse'
example:
success: false
error:
code: MAX_ALERTS_EXCEEDED
message: Maximum number of alerts reached
details: You have reached the maximum number of active price alerts
'429':
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: TooManyRequests
errorMessage: Too many requests
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: UnhandledException
errorMessage: Global Error
parameters:
- name: x-request-id
in: header
required: true
schema:
type: string
format: uuid
example: 92d52d35-6930-4674-8ae4-24dd4d61c308
description: A unique request identifier.
- name: x-api-key
in: header
required: true
schema:
type: string
format: password
example: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
description: API key for authentication.
- name: x-user-key
in: header
required: true
schema:
type: string
format: password
example: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
description: User-specific authentication key.
operationId: createAPriceAlert
/api/v1/price-alerts/{alertId}:
patch:
tags:
- Price Alerts
summary: Update a price alert
description: Updates the target price of an existing price alert.
parameters:
- name: x-request-id
in: header
required: true
schema:
type: string
format: uuid
example: 40dfcdec-7eb4-4320-ace0-ae992727e33a
description: A unique request identifier.
- name: x-api-key
in: header
required: true
schema:
type: string
format: password
example: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
description: API key for authentication.
- name: x-user-key
in: header
required: true
schema:
type: string
format: password
example: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
description: User-specific authentication key.
- name: alertId
in: path
required: true
description: Unique identifier of the price alert
schema:
type: string
format: uuid
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePriceAlertRequest'
example:
targetPrice: 190.0
responses:
'200':
description: Price alert updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/PriceAlertMutationResponse'
example:
success: true
data:
alertId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
instrumentId: 1001
symbol: AAPL
targetPrice: 190.0
currentPrice: 182.3
createdAt: '2026-04-20T10:00:00Z'
updatedAt: '2026-04-30T11:00:00Z'
'400':
description: Invalid request parameters (e.g. invalid alertId format, missing targetPrice)
content:
application/json:
schema:
$ref: '#/components/schemas/PriceAlertErrorResponse'
example:
success: false
error:
code: INVALID_PARAMETER
message: Invalid request parameters
details: Field 'targetPrice' must be greater than 0
field: targetPrice
'401':
description: Unauthorized - missing or invalid authentication credentials
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: Unauthorized
errorMessage: Unauthorized
'403':
description: Forbidden - insufficient permissions
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: InsufficientPermissions
errorMessage: Insufficient permissions to access this resource
'404':
description: Price alert not found
content:
application/json:
schema:
$ref: '#/components/schemas/PriceAlertErrorResponse'
example:
success: false
error:
code: ALERT_NOT_FOUND
message: Price alert not found
details: No price alert found with the specified ID
'429':
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: TooManyRequests
errorMessage: Too many requests
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: UnhandledException
errorMessage: Global Error
operationId: updateAPriceAlert
delete:
tags:
- Price Alerts
summary: Delete a price alert
description: Permanently deletes a price alert owned by the authenticated user.
parameters:
- name: x-request-id
in: header
required: true
schema:
type: string
format: uuid
example: 0b55b20a-a7d5-49f1-bd03-cdf552602a93
description: A unique request identifier.
- name: x-api-key
in: header
required: true
schema:
type: string
format: password
example: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
description: API key for authentication.
- name: x-user-key
in: header
required: true
schema:
type: string
format: password
example: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
description: User-specific authentication key.
- name: alertId
in: path
required: true
description: Unique identifier of the price alert to delete
schema:
type: string
format: uuid
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
responses:
'200':
description: Price alert deleted successfully
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePriceAlertResponse'
example:
success: true
data:
alertId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
'401':
description: Unauthorized - missing or invalid authentication credentials
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: Unauthorized
errorMessage: Unauthorized
'403':
description: Forbidden - insufficient permissions
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: InsufficientPermissions
errorMessage: Insufficient permissions to access this resource
'404':
description: Price alert not found
content:
application/json:
schema:
$ref: '#/components/schemas/PriceAlertErrorResponse'
example:
success: false
error:
code: ALERT_NOT_FOUND
message: Price alert not found
details: No price alert found with the specified ID
'429':
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: TooManyRequests
errorMessage: Too many requests
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/PublicErrorResponse'
example:
errorCode: UnhandledException
errorMessage: Global Error
operationId: deleteAPriceAlert
components:
schemas:
PriceAlertMutationResponse:
type: object
description: Response for price alert create and update operations
properties:
success:
type: boolean
description: Indicates the operation completed successfully
example: true
data:
$ref: '#/components/schemas/PriceAlert'
CreatePriceAlertRequest:
type: object
description: Request body for creating a new price alert
required:
- symbol
- targetPrice
properties:
symbol:
type: string
description: Trading symbol to identify the instrument (e.g. AAPL, TSLA)
example: AAPL
targetPrice:
type: number
format: decimal
description: Target price at which the alert should trigger. Must be greater than 0.
exclusiveMinimum: true
example: 185.5
minimum: 0
PublicErrorResponse:
type: object
description: Error response with code and message.
required:
- errorCode
- errorMessage
properties:
errorCode:
type: string
description: Machine-readable error code.
example: GeneralError
errorMessage:
type: string
description: Human-readable error message.
example: Internal server error. Please retry or contact support
UpdatePriceAlertRequest:
type: object
description: Request body for updating an existing price alert
required:
- targetPrice
properties:
targetPrice:
type: number
format: decimal
description: New target price for the alert. Must be greater than 0.
exclusiveMinimum: true
example: 190.0
minimum: 0
PriceAlertErrorResponse:
type: object
description: Error response from the price alerts service
required:
- success
- error
properties:
success:
type: boolean
description: Indicates the request failed
example: false
error:
type: object
required:
- code
- message
properties:
code:
type: string
description: Machine-readable error code for programmatic handling
example: VALIDATION_ERROR
message:
type: string
description: Human-readable error message
example: Invalid request parameters
details:
type: string
description: Additional context about the error
example: Field 'targetPrice' must be greater than 0
field:
type: string
description: The specific field that caused the error (if applicable)
example: targetPrice
DeletePriceAlertResponse:
type: object
description: Response for price alert delete operation
properties:
success:
type: boolean
description: Indicates the operation completed successfully
example: true
data:
type: object
properties:
alertId:
type: string
format: uuid
description: Unique identifier of the deleted price alert
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
PriceAlert:
type: object
description: A price alert set by the user on a financial instrument
required:
- alertId
- instrumentId
- symbol
- targetPrice
- currentPrice
- createdAt
- updatedAt
properties:
alertId:
type: string
format: uuid
description: Unique identifier of the price alert
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
instrumentId:
type: integer
description: Unique instrument identifier used across all trading operations
example: 1001
symbol:
type: string
description: Trading symbol displayed to users (e.g. AAPL, TSLA)
example: AAPL
targetPrice:
type: number
format: decimal
description: Target price at which the alert will trigger
example: 185.5
currentPrice:
type: number
format: decimal
description: Market bid price at the time the alert was created or last updated
example: 182.3
createdAt:
type: string
format: date-time
description: Timestamp when the alert was created (ISO 8601 UTC)
example: '2026-04-20T10:00:00Z'
updatedAt:
type: string
format: date-time
description: Timestamp when the alert was last updated (ISO 8601 UTC)
example: '2026-04-25T14:30:00Z'
PriceAlertCollectionResponse:
type: object
description: Collection of price alerts for the authenticated user
properties:
results:
type: array
description: List of price alerts matching the query criteria
items:
$ref: '#/components/schemas/PriceAlert'