User

Get economic calendar events

Economic calendar events (CPI, NFP, central-bank decisions, …) within a date range, served from Hyperprop’s own mirror — synced daily from a market-data provider, so availability does not depend on a third party at request time.

Filters

Param	Meaning
`startDate` / `endDate`	Inclusive event-date range (`YYYY-MM-DD`), max 92 days
`importance`	MINIMUM importance: 1 = all, 2 = medium+high, 3 = high only
`country`	ISO3 code, case-insensitive (`USA`, `GBR`, `JPN`, `EUR` for the euro area)
`category`	Partial category match (`employ` matches “Employment”)
`search`	Partial event-name match (`cpi`)

Events are ordered by event_timestamp ascending, capped at 1000 rows.

Values

actual, consensus, and prior are display strings (may include units); the *_value fields are the numeric equivalents, null until the figure is published. The mirror re-syncs the trailing week daily, so actuals and revisions appear within a day of release.

# High-impact US events this week
curl "https://api.hyperprop.com/platform/v1/economic-calendar?startDate=2026-07-27&endDate=2026-08-02&country=USA&importance=3" \
  -H "Authorization: Bearer <session token>"

GET

economic-calendar

Get economic calendar events

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/economic-calendar

const options = {method: 'GET'};

fetch('https://api.hyperprop.com/platform/v1/economic-calendar', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/economic-calendar",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/economic-calendar"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/economic-calendar")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "events": [
      {
        "id": "697daf7b14d3a800015ee9b8",
        "event_name": "Consumer Price Index (YoY)",
        "event_category": "Inflation",
        "country": "USA",
        "event_date": "2026-07-31",
        "event_time": "08:30:00",
        "event_timestamp": "2026-07-31T12:30:00+00:00",
        "event_period": "Jul",
        "importance": 3,
        "actual": "3.1",
        "consensus": "3.0",
        "prior": "2.9",
        "actual_value": 3.1,
        "consensus_value": 3,
        "prior_value": 2.9
      }
    ],
    "count": 42
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid request query input"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Query Parameters

startDate

string

required

Inclusive range start, YYYY-MM-DD

Pattern: ^\d{4}-\d{2}-\d{2}$

endDate

string

required

Inclusive range end, YYYY-MM-DD

Pattern: ^\d{4}-\d{2}-\d{2}$

importance

integer

Minimum importance: 1 low, 2 medium, 3 high

Required range: 1 <= x <= 3

country

string

ISO3 country code, case-insensitive

Maximum string length: 8

Response

Economic events retrieved successfully

success

boolean

Example:

true

data

object

Show child attributes

⌘I

Get economic calendar events

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/economic-calendar

const options = {method: 'GET'};

fetch('https://api.hyperprop.com/platform/v1/economic-calendar', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/economic-calendar",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/economic-calendar"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/economic-calendar")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "events": [
      {
        "id": "697daf7b14d3a800015ee9b8",
        "event_name": "Consumer Price Index (YoY)",
        "event_category": "Inflation",
        "country": "USA",
        "event_date": "2026-07-31",
        "event_time": "08:30:00",
        "event_timestamp": "2026-07-31T12:30:00+00:00",
        "event_period": "Jul",
        "importance": 3,
        "actual": "3.1",
        "consensus": "3.0",
        "prior": "2.9",
        "actual_value": 3.1,
        "consensus_value": 3,
        "prior_value": 2.9
      }
    ],
    "count": 42
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid request query input"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Market Data API

Get economic calendar events

Filters

Values

Query Parameters

Response