Skip to main content
GET
Economic data series

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.

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:

  • gdpEconomicDataPoint
  • cpiMacroCpiData
  • pceMacroPceData
  • import-exportMacroImportExportData

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.