Skip to main content
GET
/
openapi
/
v1
/
macro
/
economic-data
Economic data series
curl --request GET \
  --url https://api.hayinsights.com/openapi/v1/macro/economic-data \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "statusCode": 200,
  "data": [
    {
      "country": "JP",
      "quarter": "Q4 2025",
      "gdp": "672199.300",
      "gdpUnit": "Billion JPY",
      "growthRate": 0.6,
      "realGdp": null,
      "realGrowthRate": null,
      "dateFrom": "2025-10-01T00:00:00.000Z",
      "dateTo": "2025-12-31T23:59:59.999Z"
    },
    {
      "country": "JP",
      "quarter": "Q1 2026",
      "gdp": "677233.400",
      "gdpUnit": "Billion JPY",
      "growthRate": 0.8,
      "realGdp": null,
      "realGrowthRate": null,
      "dateFrom": "2026-01-01T00:00:00.000Z",
      "dateTo": "2026-03-31T23:59:59.999Z"
    }
  ],
  "meta": {
    "timestamp": "2026-06-19T08:50:42.471Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Your HayInsights API key (prefixed apk_). Create and manage keys in the HayInsights dashboard (Account → API keys).

Send it in the X-API-Key header on every request to /openapi/v1/*. Which data domains you may access and your request quota are both governed by the subscription plan attached to the key — see the Plans & features and Rate limits guides.

Query Parameters

​
type
enum<string>
required

Macroeconomic indicator to return.

ValueDescription
gdpGross Domestic Product
cpiConsumer Price Index
pcePersonal Consumption Expenditures
import-exportImport & export trade
Available options:
gdp,
cpi,
pce,
import-export
Example:

"gdp"

​
country
string
default:JP

ISO country code.

Example:

"JP"

​
period
enum<string>
default:10Y

Look-back window.

Available options:
1Y,
3Y,
10Y

Response

Selected economic data series.

Standard success envelope shared by every endpoint. Each operation's response wrapper extends this (via allOf) and adds a typed data property.

​
success
boolean
required

Always true for a successful response.

Example:

true

​
statusCode
integer
required

Mirrors the HTTP status code.

Example:

200

​
data
(object | MacroCpiData · object | MacroPceData · object | MacroImportExportData · object)[]
required

Array of observations whose item shape depends on the type query parameter:

  • gdp → EconomicDataPoint
  • cpi → MacroCpiData
  • pce → MacroPceData
  • import-export → MacroImportExportData

One observation in an economic data series (GDP / CPI / PCE / import-export). Shared by the GDP growth-rate and economic-data endpoints.

​
meta
object

Response metadata. Always present; timestamp is the server time the response was generated.