Search
K
Macroeconomic Layer API (Production)

List products

Returns the products available on this layer.

get
https://api.argaam.com/api/v1.1/petrochemicals/products

Response

200 application/json

Success

* Additional properties are NOT allowed.
productIDinteger(int32)
productNameArstring | null
productNameEnstring | null
descriptionArstring | null
descriptionEnstring | null
utilizationEnstring | null
utilizationArstring | null
categoryIDinteger(int32)
attributeIDinteger | null(int32)
isPublicboolean
isChartEnabledForReportboolean | null
regionIDinteger(int32)
regionNameArstring | null
regionNameEnstring | null
productPricenumber(double)
changeInPricenumber | null(double)
entryDatestring(date-time)
get/api/v1.1/petrochemicals/products
 
200 application/json

Latest prices for a petrochemical product (rolling window).

Returns prices observed during the requested rolling period
(1D, 1W, 1M, 3M, 1Y, MAX).

Example

GET /api/v1.1/petrochemicals/products/12/prices?regionId=1&period=1M
get
https://api.argaam.com/api/v1.1/petrochemicals/products/{productId}/prices

Query Parameters

regionIdinteger(int32)

Region ID. Defaults to Asia (1).

Example:1

periodstring

Rolling window. Default: 1M. Defaults to 1M.

Default:1M

Example:year

Path Parameters

productIdinteger(int32)required

Product ID from /products.

Response

200 application/json

Success

* Additional properties are NOT allowed.
productPriceIDinteger(int32)
regionIDinteger(int32)
categoryIDinteger(int32)
productIDinteger(int32)
productPricenumber(double)
measuringUnitIDinteger(int32)
currencyIDinteger(int32)
entryDatestring(date-time)
changeInPricenumber | null(double)
regionNameArstring | null
regionNameEnstring | null
categoryNameArstring | null
categoryNameEnstring | null
productNameArstring | null
productNameEnstring | null
changenumber | null(double)
get/api/v1.1/petrochemicals/products/{productId}/prices
 
200 application/json

Historical prices for a petrochemical product (custom date range).

Like /products/{id}/prices but takes an explicit
from/to window for arbitrary historical analysis.

Example

GET /api/v1.1/petrochemicals/products/12/prices/history?regionId=1&from=2023-01-01&to=2023-12-31
get
https://api.argaam.com/api/v1.1/petrochemicals/products/{productId}/prices/history

Query Parameters

regionIdinteger(int32)

Numeric region identifier.

Example:1

fromstring

Start of the date range, inclusive. Format YYYY-MM-DD.

Example:2024-01-01

tostring

End of the date range, inclusive. Format YYYY-MM-DD.

Example:2024-03-31

Path Parameters

productIdinteger(int32)required

Numeric petrochemical product identifier.

Response

200 application/json

Success

* Additional properties are NOT allowed.
productPriceIDinteger(int32)
regionIDinteger(int32)
categoryIDinteger(int32)
productIDinteger(int32)
productPricenumber(double)
measuringUnitIDinteger(int32)
currencyIDinteger(int32)
entryDatestring(date-time)
changeInPricenumber | null(double)
regionNameArstring | null
regionNameEnstring | null
categoryNameArstring | null
categoryNameEnstring | null
productNameArstring | null
productNameEnstring | null
changenumber | null(double)
get/api/v1.1/petrochemicals/products/{productId}/prices/history
 
200 application/json

Active rig counts for a region as of a date.

Rig counts are a classic leading indicator for upstream
oil & gas activity, and a useful sentiment proxy for
mid-stream and downstream sectors.

Example

GET /api/v1.1/petrochemicals/rig-counts?regionId=4&asOf=2024-01-15
get
https://api.argaam.com/api/v1.1/petrochemicals/rig-counts

Query Parameters

regionIdinteger(int32)

Region ID.

Example:1

asOfstring

As-of date (yyyy-MM-dd).

Example:2024-01-15

Response

200 application/json

Success

* Additional properties are NOT allowed.
rigCountIDinteger(int32)
forDatestring(date-time)
oilRigCountnumber | null(double)
regionIDinteger | null(int32)
gasRigCountnumber | null(double)
miscnumber | null(double)
totalnumber | null(double)
dataForstring | null
regionNameArstring | null
regionNameEnstring | null
announceDatestring(date-time)
closenumber | null(double)
get/api/v1.1/petrochemicals/rig-counts
 
200 application/json

Commodity

object
* Additional properties are NOT allowed.
commodityIDinteger(int32)
nameEnstring
nameArstring
typestring
Example