Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $inlinecount InlineCountValue Query-String Indication of whether the total count of elements must be returned.
    $skip Int Query-String Optional number of elements to skip.
    $top Int Query-String Optional number of elements to retrieve.
    State PriceAlertDefinitionState Query-String Optional state the price alert definitions should match. The values must be one of PriceAlertDefinitionState . The match is case insensitive.
  • Response Parameters

    View Response Codes
    Name Type Description
    AccountId String The account that owns this price alert definition.
    AlertDefinitionId String The ID of this Price Alert Definition Response .
    AssetType AssetType The type of instrument that this alert is monitoring.
    ClientId String The client that owns this price alert definition.
    Comment String An optional comment associated with the price alert definition. The maximum supported length of the string is 128 characters.
    ExpiryDate UtcDateTime The UTC date and time that the price alert definition will expire and then be removed from the system. The date and time is specified in Coordinated Universal Time (UTC) and should be formatted as "yyyy-mm-ddThh:mm:ssZ".
    IsExtendedHours Bool An optional flag to indicate if price alert definition is valid in extended hours trading. Default will be set to false.
    IsRecurring Bool Is the alert only triggered once or will the alerts keep recurring until the alert expires.
    Operator PriceAlertComparisonOperator The boolean operator used to compare the current price with the defined value .
    PriceVariable PriceVariable The aspect of the price that is being monitored.
    State PriceAlertDefinitionState A price alert definition can be enabled, disabled or suspended. RecentlyTriggered is used for recurring alerts, so that they don't trigger constantly once the condition has been met.
    TargetValue Decimal The value that the current price is compared to.
    Uic Int Universal Instrument Code (UIC).
    UserId String The ID of the user that owns this price alert definition.
  • Request Example

    Request URL
    GET vas/v1/pricealerts/definitions/?$top=99&$skip=99&$inlinecount=None&State=Disabled
  • Response Example

    Response body
      "Data": [
          "AccountId": "13457INET",
          "AlertDefinitionId": "30834",
          "AssetType": "FxSpot",
          "Comment": "I believe EURUSD will go up within the next few years!",
          "ExpiryDate": "2016-09-30T12:00:00Z",
          "IsRecurring": true,
          "Operator": "GreaterOrEqual",
          "PriceVariable": "AskTick",
          "State": "Enabled",
          "TargetValue": 1.34595,
          "Uic": 21,
          "UserId": "2361528"
      "MaxRows": 99