AGagentkey
finance

Macroeconomic series (CPI, inflation, GDP, unemployment, policy rate, treasury yield, retail sales, payrolls, PMI, money supply) by country. Returns a normalized SeriesPoint page, most recent first.

Pick a series and a country (ISO alpha-2, default US). interval=auto takes the series' native frequency; an explicit interval routes to a provider that reports it. maturity applies to treasury_yield only. Verified for China (cpi, inflation, gdp, pmi, money_supply) and the US (every series but pmi / money_supply); World Bank and Eurostat series wait on network / engine fixes.

Fixed price: 0.1 credits per successful call, whichever provider serves it.

post/v2/ops/finance.macro.series

Request

  • Base URL
    https://api.agentkey.app
  • URL
    https://api.agentkey.app/v2/ops/finance.macro.series
  • Auth
    HTTP bearer

Request body

countrystring

ISO 3166-1 alpha-2 of the economy (US, CN, DE, JP).

fieldsstring[]

Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].

include_rawboolean

Attach the raw upstream payload as raw (not a stable contract; truncated above 256 KB).

interval'auto' | 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'semiannual' | 'annual'

Reporting frequency; auto = the series' native frequency at the provider.

limitinteger

Maximum number of observations to return.

maturity'3month' | '2year' | '5year' | '7year' | '10year' | '30year'

Bond maturity for treasury_yield.

providerstring

Shorthand for routing.only = [provider].

series'cpi' | 'inflation' | 'gdp' | 'unemployment' | 'policy_rate' | 'treasury_yield' | 'retail_sales' | 'payrolls' | 'pmi' | 'money_supply' required

cpi = price index level; inflation = CPI change in percent year on year; gdp = output in the vendor's unit; unemployment = rate in percent; policy_rate = central bank rate; treasury_yield = government bond yield; retail_sales, payrolls, pmi, money_supply as the national statistics office publishes them.

Response

Success envelope

credits_chargednumber required

Credits charged for this call (the method's fixed price).

opstring required

Method name.

op_versioninteger required

Method version that served the call.

providerstring required

Provider that actually served the call.

rawunknown
raw_truncatedboolean
request_idstring required

Correlation id; quote it in support requests.

took_msinteger required
unsupported_fieldsstring[] required

Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

Changes

No recorded changes to this operation across all 1 revision of this API.