Search
K
Macroeconomic Layer API (Sandbox)

Macroeconomic Layer API

v1.1OAS 3.0

Macroeconomic and commodity data: energy and commodity quotes, consumer-goods prices, petrochemical indices and products, shipping and refining margins, and national economic indicators.

API Base URL
  • Server 1:https://api-sandbox.argaam.com

    Argaam API Gateway (Sandbox)

Security
ApiKeyAuth (apiKey)

An API key is a token that you provide when making API calls. Include the token in a header parameter called apikey.

Example: apikey: 123

ApiKeyAuthQuery (apiKey)

An API key is a token that you provide when making API calls. Include the token in a query parameter called apikey.

Example: ?apikey=123

Additional Information
Contact Argaam IT (developer@argaam.com)

List all tracked commodities.

Returns the full catalogue Argaam tracks: codes, names, units,
reference exchanges, and category (energy, metals, agri, etc.).

Example

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

Response

200 application/json

Success

* Additional properties are NOT allowed.
commodityIDinteger(int32)
nameEnstring | null
nameArstring | null
typestring | null
get/api/v1.1/commodities
 
200 application/json

Latest quotes for "regular" actively-traded commodities.

Refreshed continuously during market hours. Use this endpoint
for trading screens and price tickers.

Example

GET /api/v1.1/commodities/quotes/regular
get
https://api-sandbox.argaam.com/api/v1.1/commodities/quotes/regular

Response

200 application/json

Success

* Additional properties are NOT allowed.
commodityIDinteger(int32)
tickerChartCommodityNamestring | null
commodityNameEnstring | null
commodityNameArstring | null
forDatestring(date-time)
openValuenumber | null(double)
closeValuenumber | null(double)
previousCloseValuenumber | null(double)
highnumber | null(double)
lownumber | null(double)
indexValuenumber | null(double)
changenumber | null(double)
percentageChangenumber | null(double)
ybgnChangenumber | null(double)
monthinteger | null(int32)
timestring | null(date-time)
lastUpdatedstring | null(date-time)
get/api/v1.1/commodities/quotes/regular
 
200 application/json

Historical quotes for a "regular" commodity.

Returns end-of-day archive prices for the supplied commodity
across the requested date window.

Example

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

Query Parameters

fromstring

Start date (yyyy-MM-dd). Default: yesterday.

Example:2024-01-01

tostring

End date (yyyy-MM-dd). Default: today.

Example:2024-03-31

Path Parameters

commodityIdinteger(int32)required

Commodity identifier (e.g., 1 for Brent).

Response

200 application/json

Success

* Additional properties are NOT allowed.
commodityIDinteger(int32)
commodityNameEnstring | null
commodityNameArstring | null
forDatestring(date-time)
openValuenumber | null(double)
closeValuenumber | null(double)
highnumber | null(double)
lownumber | null(double)
get/api/v1.1/commodities/{commodityId}/quotes/regular/history
 
200 application/json

Get historical series for a commodity

Returns the historical series for the commodity identified by commodityId.

Bound the result with the from and to date parameters.

get
https://api-sandbox.argaam.com/api/v1.1/commodities/{commodityId}/quotes/other/history

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
regionNameArstring | null
regionNameEnstring | null
forDatestring(date-time)
averageValuenumber | null(double)
highnumber | null(double)
lownumber | null(double)
get/api/v1.1/commodities/{commodityId}/quotes/other/history
 
200 application/json