Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $inlinecount String Query-String Specifies that the response to the request should include a count of the number of entries in the collection
    $skip Integer Query-String The number of entries to skip from the beginning of the collection
    $top Integer Query-String The number of entries to return from the beginning of the collection
    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
    __count Number The total count of items in the feed.
    __next String The link for the next page of items in the feed.
    Data PriceAlertDefinitionResponse [] The collection of entities for this feed.
    MaxRows Number The maximum number of rows that can be returned (if applicable).
  • Request Example

    Request URL
    GET /vas/v1/pricealerts/definitions?$inlinecount=AllPages&$skip=1&$top=1&State=RecentlyTriggered
  • 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
    }