Alerts

List price alerts

Changed on

Every price alert on the account, ordered by commodity code and creation time. Returns an empty array when the account has none. Alert management calls are not metered against the request quota.

get/v1/alerts

Request

  • Base URL
    https://api.oilpriceapi.com
  • Auth
    API key in header Authorization

Response

The account's price alerts

idinteger
namestring nullable
commodity_codestring
alert_typestring nullable
delivery_modestring
condition_operatorstring nullable
condition_valuenumber nullable
conditionstring nullable
summarystring nullable
webhook_urlstring nullable
has_webhookboolean
enabledboolean
cooldown_minutesinteger
trigger_countinteger
last_triggered_atstring date-time nullable
metadataobject
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": 1234,
    "name": "Brent above 95",
    "commodity_code": "BRENT_CRUDE_USD",
    "alert_type": "threshold",
    "delivery_mode": "threshold",
    "condition_operator": "greater_than",
    "condition_value": 95,
    "condition": "BRENT_CRUDE_USD > 95.0",
    "enabled": true,
    "cooldown_minutes": 60
  }
]

Changes

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status