Oracle Prices

---

Current Oracle Price

GET https://api.helium.io/v1/oracle/prices/current

The current Oracle Price and at which block it took effect.

Request

No Parameters

Response

200: OK

The current Oracle Price and at which block it took effect.

{
  "data": {
    "price": 167000000,
    "block": 471570
  }
}

---

Current and Historical Oracle Prices

GET https://api.helium.io/v1/oracle/prices

The current and historical Oracle Prices and at which block they took effect. This route is paged using a cursor.

Request

Path Parameters

param	Type	Note
max_block (optional)	integer	Last block number to include in the results
cursor (optional)	string	Returned from an initial query, allowing client to fetch more results

Response

200: OK

Returns a list of recent Oracle Prices and at which block they took effect.

{
  "data": [
    {
      "price": 167000000,
      "block": 471570
    },
    {
      "price": 169630000,
      "block": 471540
    }
  ],
  "cursor": "eyJiZWZvcmUiOjQ2NjE5MH0"
}

---

Oracle Price Stats

GET https://api.helium.io/v1/oracle/prices/stats

Gets statistics on Oracle prices.

Request

Query Parameters

param	Type	Note
min_time (required)	string	First time to include in stats
max_time (required)	string	Last time to include in stats

Response

Returns Oracle price statistics over the last 30 days by specifying ?min_time=-30%20day

200: OK

{
  "data": {
    "avg": 12.433719079615384,
    "max": 20.0,
    "median": 12.53731614,
    "min": 6.0,
    "stddev": 3.50807814
  },
  "meta": {
    "max_time": "2021-04-20T15:52:28Z",
    "min_time": "2021-03-21T15:52:28Z"
  }
}

---

Oracle Price at a Specific Block

GET https://api.helium.io/v1/oracle/prices/:block

Provides the oracle price at a specific block and at which block it initially took effect.

Request

Path Parameters

param	Type	Note
block (required)	string	The block to get the HNT Oracle Price at

Response

200: OK

Returns a list of recent Oracle Prices and at which block they took effect..

{
  "data": {
    "price": 167000000,
    "block": 471570
  }
}

---

List Oracle Activity

GET https://api.helium.io/v1/oracle/activity

List oracle price report transactions for all oracle keys. This route is paged with a cursor.

Request

Path Parameters

param	Type	Note
cursor (optional)	string	Cursor for the next page to fetch
min_time (optional)	string	First time to include data for
max_time (optional)	string	Last time to include data for
limit (optional)	number	Maximum number of items to return

Response

200: OK

Transaction Units

Remember that transaction units are in bones. Read more here

{
  "cursor": "eyJ0eXBlcyI6InByaWNlX29yYWNsZV92MSIsImJsb2NrIjozNzc5MDAsImFuY2hvcl9ibG9jayI6Mzc3OTAwfQ",
  "data": [
    {
      "block_height": 377896,
      "fee": 0,
      "hash": "UcKE8X9UtuhOx5N3yxjyI7QcVihSoJTBq_DVQME7RWI",
      "height": 377900,
      "price": 35736000,
      "public_key": "13Btezbvbwr9LhKmDQLgBnJUgjhZighEjNPLeu79dqBbmXRwoWm",
      "time": 1592484227,
      "type": "price_oracle_v1"
    }
  ]
}

---

List Activity for a Specific Oracle

GET https://api.helium.io/v1/oracle/:address/activity

Lists price report transactions for the given oracle key. This route is paged using a cursor.

Request

Path Parameters

param	Type	Note
address (optional)	string	The public key of the oracle

Query Parameters

param	Type	Note
cursor (optional)	string	Cursor for the next page to fetch
min_time (optional)	string	First time to include data for
max_time (optional)	string	Last time to include data for
limit (optional)	number	Maximum number of items to return

Response

200: OK

Transaction Units

Remember that transaction units are in bones. Read more here

{
  "cursor": "eyJ0eXBlcyI6InByaWNlX29yYWNsZV92MSIsImJsb2NrIjozNzc5MDAsImFuY2hvcl9ibG9jayI6Mzc3OTAwfQ",
  "data": [
    {
      "block_height": 377896,
      "fee": 0,
      "hash": "UcKE8X9UtuhOx5N3yxjyI7QcVihSoJTBq_DVQME7RWI",
      "height": 377900,
      "price": 35736000,
      "public_key": "13Btezbvbwr9LhKmDQLgBnJUgjhZighEjNPLeu79dqBbmXRwoWm",
      "time": 1592484227,
      "type": "price_oracle_v1"
    }
  ]
}

---

Get Predicted HNT Oracle Prices

GET https://api.helium.io/v1/oracle/predictions

This returns a list of expected times when the Oracle Price is expected to change.The blockchain operates in "block-time", meaning that blocks can come out at some schedule close to 1 per minute. Oracles report in "wall-clock-time", meaning they report what they believe the price should be.If the route returns one or more prices and times, it indicates that the chain is expected to adjust the price (based on Oracle reports) no earlier than the indicated time to the returned price.NOTE: A prediction may not be seen in the blockchain if they are close together (within 10 blocks) since block times may cause the blockchain to skip to a next predicted price. If no predictions are returned the current HNT Oracle Price is valid for at least 1 hour.

Request

No Parameters

Response

200: OK

Returns a prediction that the price will change to 47000000 at the earliest at the indicated seconds since Unix epoch time.

{
  "data": [
    {
      "price": 47000000,
      "time": 1594410146
    }
  ]
}