Commodities-API data contract | PatchOps Knowledge

Provenance

PublisherCommodities-API

API basehttps://commodities-api.com/api

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (API key)

Methods (8)

getLatestPrices

read

Latest commodity prices.

Input schema

{
  "type": "object",
  "properties": {
    "base": {
      "type": "string"
    },
    "symbols": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

getHistoricalPrices

read

Prices for a specific date.

Required paramsdate

Input schema

{
  "type": "object",
  "properties": {
    "date": {
      "type": "string"
    },
    "base": {
      "type": "string"
    },
    "symbols": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "date"
  ]
}

getTimeSeries

read

Time-series between two dates.

Required paramsstartDateendDate

Input schema

{
  "type": "object",
  "properties": {
    "startDate": {
      "type": "string"
    },
    "endDate": {
      "type": "string"
    },
    "base": {
      "type": "string"
    },
    "symbols": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "startDate",
    "endDate"
  ]
}

getFluctuation

read

Change between two dates.

Required paramsstartDateendDate

Input schema

{
  "type": "object",
  "properties": {
    "startDate": {
      "type": "string"
    },
    "endDate": {
      "type": "string"
    },
    "base": {
      "type": "string"
    },
    "symbols": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "startDate",
    "endDate"
  ]
}

convert

unknown

Convert between commodities/currencies.

Required paramsfromtoamount

Entitiescommodity

Input schema

{
  "type": "object",
  "properties": {
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    },
    "amount": {
      "type": "number"
    },
    "date": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "from",
    "to",
    "amount"
  ]
}

getOHLC

read

Open/High/Low/Close for a date.

Required paramsdate

Input schema

{
  "type": "object",
  "properties": {
    "date": {
      "type": "string"
    },
    "base": {
      "type": "string"
    },
    "symbols": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "date"
  ]
}

getOilPrices

read

Brent + WTI snapshot.

Input schema

{
  "type": "object",
  "properties": {
    "base": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

getEnergyPrices

read

Oil/gas/gasoline/diesel snapshot.

Input schema

{
  "type": "object",
  "properties": {
    "base": {
      "type": "string"
    }
  },
  "additionalProperties": false
}