Search
K
Macroeconomic Layer API (Sandbox)

Shipping rates / freight prices for a commodity.

Returns chartered / spot shipping prices. Useful for
landed-cost analysis when modeling regional trade flows.

Example

GET /api/v1.1/commodities/1/shipping?from=2024-01-01&to=2024-01-31
get
https://api-sandbox.argaam.com/api/v1.1/commodities/{commodityId}/shipping

Query Parameters

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

commodityIdinteger(int32)required

Numeric commodity identifier. Use GET /api/v1.1/commodities for valid values.

Response

200 application/json

Success

* Additional properties are NOT allowed.
commodityIDinteger(int32)
commodityNameEnstring | null
commodityNameArstring | null
forDatestring(date-time)
pricenumber | null(double)
get/api/v1.1/commodities/{commodityId}/shipping
 
200 application/json

List refining margins

Returns the refining margins available on this layer.

Bound the result with the from and to date parameters.

get
https://api-sandbox.argaam.com/api/v1.1/commodities/refining-margins

Query Parameters

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

Response

200 application/json

Success

* Additional properties are NOT allowed.
commodityIDinteger(int32)
commodityNameEnstring | null
commodityNameArstring | null
forDatestring(date-time)
pricenumber | null(double)
get/api/v1.1/commodities/refining-margins
 
200 application/json

Catalogue of all tracked consumer goods (materials).

Returns the full taxonomy: material id, name (Ar/En),
category (food, beverages, building, fuel, etc.), unit, and
reference region.

Example

GET /api/v1.1/consumer-goods
get
https://api-sandbox.argaam.com/api/v1.1/consumer-goods

Response

200 application/json

Success

array
get/api/v1.1/consumer-goods
 
200 application/json

List prices

Returns the prices available on this layer.

get
https://api-sandbox.argaam.com/api/v1.1/consumer-goods/prices

Response

200 application/json

Success

array
get/api/v1.1/consumer-goods/prices
 
200 application/json

Latest price for a specific material.

Single-material variant of /prices. Returns the most
recent quote plus daily change.

Example

GET /api/v1.1/consumer-goods/42/prices
get
https://api-sandbox.argaam.com/api/v1.1/consumer-goods/{materialId}/prices

Path Parameters

materialIdinteger(int32)required

Material ID from /.

Response

200 application/json

Success

array
get/api/v1.1/consumer-goods/{materialId}/prices
 
200 application/json