Subscriptions

List price watches

Persistent price "watches" for the authenticated user. Poll /v1/subscriptions/events for triggered events.

get/v1/subscriptions

Request

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

Response

List of subscriptions

statusstring

Example response

{
  "status": "success",
  "data": {
    "subscriptions": [
      {
        "id": "018f47a2-4d4d-7a44-9fa4-123456789abc",
        "name": "My WTI watch",
        "codes": [
          "WTI_USD",
          "BRENT_CRUDE_USD"
        ],
        "interval_seconds": 3600,
        "status": "active",
        "source": "api",
        "tool_name": "watch_commodity"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 17 revisions of this API.