> ## Documentation Index > Fetch the complete documentation index at: https://developer.hayinsights.com/llms.txt > Use this file to discover all available pages before exploring further. # Indicator — Export/Import price index table (US/JP/VN) > Monthly table of export price index (EPI) and import price index (IPI), each cell holding both metrics as raw index points exactly as published — no conversion. `columns` holds the N most recent months (default 2, oldest to newest) and `metrics` declares the fields inside each cell. Currently only JP and US have data; the VN row returns available=false. ## OpenAPI ````yaml /openapi.yaml get /openapi/v1/macro/indicators/epi-ipi openapi: 3.1.0 info: title: HayInsights Open API version: 0.1.0 description: > Programmatic access to the **HayInsights** financial-data hub — commodities, crypto, ETF, FX, macroeconomic, real-estate, news, economic-calendar and market-index datasets, served from a single API surface under `/openapi/v1/*`. This specification is the **single source of truth** for the public API surface — shared by SDK codegen, the reference docs, and (later) the mock server / contract tests. ## Authentication Every request must carry your API key in the `X-API-Key` header. There is a single authentication tier — no request signing. Create and manage keys in the HayInsights dashboard (Account → API keys). See **Authentication**. ## Plans & quota Access to each data domain and your request quota are governed by the subscription plan attached to your key. Each endpoint consumes a **weighted** amount of your per-minute quota; every response carries `X-RateLimit-*` headers. See **Rate limits** and **Plans & features**. contact: {} servers: - url: https://api-v2.hayinsights.com description: Production security: - HayInsightsApiKey: [] tags: - name: Commodities description: >- Spot prices, top movers, gold–DXY correlation and historical series for energy, metals and agricultural commodities. - name: Crypto description: >- Crypto market overview, dominance, bubble map, on-chain and derivatives metrics. - name: ETF description: >- Exchange-traded fund listings, performance & net-flow rankings, heatmap, holdings, NAV growth and fund composition. - name: FX description: >- Foreign-exchange summary, live table, 90-day correlation matrix and the emerging-market stress monitor. - name: Macro description: >- Macroeconomic indicators — GDP, CPI/PCE, exchange rates, population, central-government debt and policy rates / bond yields. - name: Real Estate description: >- Land prices, transaction-level records, administrative geography (provinces / wards) and choropleth GeoJSON, by country. - name: News description: >- Market news headlines with per-article sentiment, plus an aggregate sentiment reading over a rolling window. - name: Calendar description: >- Economic calendar — rate decisions, CPI and GDP releases, market holidays and asset-level events. - name: Market description: >- Index snapshots and global index closes — levels and daily moves for S&P 500, Nasdaq, Nikkei, VN-Index and others. paths: /openapi/v1/macro/indicators/epi-ipi: get: tags: - Macro summary: Indicator — Export/Import price index table (US/JP/VN) description: > Monthly table of export price index (EPI) and import price index (IPI), each cell holding both metrics as raw index points exactly as published — no conversion. `columns` holds the N most recent months (default 2, oldest to newest) and `metrics` declares the fields inside each cell. Currently only JP and US have data; the VN row returns available=false. operationId: macroIndicatorEpiIpi parameters: - name: limit in: query required: false description: Number of most recent periods (columns) to return. schema: type: integer minimum: 1 maximum: 20 default: 4 example: 2 responses: '200': description: Export/import price index table. content: application/json: schema: $ref: '#/components/schemas/MacroIndicatorMultiTableResponse' example: success: true statusCode: 200 data: indicator: epi-ipi metrics: - key: epi label: Export unit: points - key: ipi label: Import unit: points columns: - period: Jun 2026 date: '2026-06-30' isPartial: false - period: Jul 2026 date: '2026-07-31' isPartial: false rows: - country: US countryName: United States available: true unit: null values: - epi: 167.6 ipi: 150.2 - epi: 165.4 ipi: 149.6 display: - epi: '167.60' ipi: '150.20' - epi: '165.40' ipi: '149.60' - country: VN countryName: Vietnam available: false unit: null values: - null - null display: - epi: — ipi: — - epi: — ipi: — meta: timestamp: '2026-09-16T07:25:17.048Z' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: schemas: MacroIndicatorMultiTableResponse: allOf: - $ref: '#/components/schemas/EnvelopeBase' - type: object required: - data properties: data: type: object description: > A country × period table where each cell holds several metrics. Cell objects are keyed by `metrics[].key`. required: - indicator - metrics - columns - rows properties: indicator: type: string example: export-import metrics: type: array items: $ref: '#/components/schemas/IndicatorMetric' columns: type: array items: $ref: '#/components/schemas/IndicatorMultiColumn' rows: type: array items: $ref: '#/components/schemas/IndicatorMultiRow' EnvelopeBase: type: object description: > Standard success envelope shared by every endpoint. Each operation's response wrapper extends this (via `allOf`) and adds a typed `data` property. required: - success - statusCode properties: success: type: boolean const: true description: Always `true` for a successful response. example: true statusCode: type: integer description: Mirrors the HTTP status code. example: 200 meta: $ref: '#/components/schemas/Meta' IndicatorMetric: type: object description: One metric tracked by a multi-metric indicator table. required: - key - label properties: key: type: string description: Key used inside each row's `values` / `display` objects. example: exportValue label: type: string example: Export unit: type: - string - 'null' example: Billion USD IndicatorMultiColumn: type: object description: One period (column) of a multi-metric indicator table. required: - period - date properties: period: type: string example: Q2 2026 date: type: string format: date example: '2026-06-30' isPartial: type: boolean description: >- `true` when the period is still in progress and figures may be revised. example: false IndicatorMultiRow: type: object description: > One country (row) of a multi-metric indicator table. Each entry of `values` is an object keyed by `metrics[].key`, positionally aligned with `columns`. required: - country - countryName - available - values - display properties: country: type: string example: US countryName: type: string example: United States available: type: boolean example: true unit: type: - string - 'null' example: Billion USD values: type: array description: > Per-period object of raw metric values, keyed by `metrics[].key`. The whole entry is `null` for a period with no data — which is every period when `available` is `false`. Within an entry, an individual metric may also be `null`. items: type: - object - 'null' additionalProperties: type: - number - 'null' example: - epi: 167.6 ipi: 150.2 - null display: type: array description: > Per-period object of pre-formatted metric strings. Unlike `values`, an entry is always present — an em dash marks a missing figure. items: type: object additionalProperties: type: string example: - epi: '167.60' ipi: '150.20' - epi: — ipi: — ErrorBody: type: object description: Standard error envelope returned for every 4xx / 5xx response. required: - success - statusCode - error properties: success: type: boolean const: false description: Always `false` for an error response. example: false statusCode: type: integer description: Mirrors the HTTP status code. example: 401 error: $ref: '#/components/schemas/ErrorDetail' meta: $ref: '#/components/schemas/Meta' Meta: type: object description: >- Response metadata. Always present; `timestamp` is the server time the response was generated. required: - timestamp properties: timestamp: type: string format: date-time description: Server time when the response was generated (ISO 8601). example: '2026-06-19T08:31:59.478Z' additionalProperties: true ErrorDetail: type: object description: Error detail object carried under `error` in the error envelope. required: - code - message properties: code: type: string description: > Machine-readable error code. Specific for authentication / quota errors (e.g. `API_KEY_REQUIRED`, `API_KEY_INVALID`, `FEATURE_NOT_IN_PLAN`, `RATE_LIMIT_EXCEEDED`). For validation (400) and not-found (404) the code is currently `INTERNAL_ERROR` and the HTTP status carries the semantics. example: API_KEY_INVALID message: description: Human-readable message, or a list of validation messages (400). oneOf: - type: string - type: array items: type: string example: Invalid API key responses: BadRequest: description: >- Invalid or missing parameter — bad enum, range, format, or a missing required query parameter. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false statusCode: 400 error: code: INTERNAL_ERROR message: - >- Invalid type parameter. Must be "gdp", "cpi", "pce", or "import-export" - Type parameter is required meta: error: Bad Request statusCode: 400 timestamp: '2026-06-19T08:34:08.081Z' Unauthorized: description: >- Missing, invalid, disabled or expired API key. Send a valid key in the `X-API-Key` header. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false statusCode: 401 error: code: API_KEY_INVALID message: Invalid API key meta: timestamp: '2026-06-19T08:34:08.023Z' Forbidden: description: >- Your subscription plan does not include this data feature, or your key's scope denies it. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false statusCode: 403 error: code: FEATURE_NOT_IN_PLAN message: Your plan does not include this feature meta: timestamp: '2026-06-19T08:34:08.100Z' RateLimited: description: > Rate limit exceeded — you have consumed your plan's per-minute weight budget. Wait until `X-RateLimit-Reset` (or `Retry-After` seconds) then retry. headers: X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' X-RateLimit-Weight-Used: $ref: '#/components/headers/XRateLimitWeightUsed' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false statusCode: 429 error: code: RATE_LIMIT_EXCEEDED message: Rate limit exceeded meta: timestamp: '2026-06-19T08:34:09.000Z' InternalError: description: Unexpected server error. Retry after a short exponential backoff. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: success: false statusCode: 500 error: code: INTERNAL_ERROR message: Internal server error meta: timestamp: '2026-06-19T08:34:10.000Z' headers: XRateLimitLimit: description: Your plan's request-weight budget per 1-minute window. schema: type: integer example: 1000 XRateLimitRemaining: description: Remaining request weight in the current 1-minute window. schema: type: integer example: 997 XRateLimitReset: description: Unix timestamp (seconds) when the current rate-limit window resets. schema: type: integer format: int64 example: 1781857979 XRateLimitWeightUsed: description: Request weight consumed by this call (see each endpoint's weight). schema: type: integer example: 3 RetryAfter: description: Seconds to wait before retrying. Present on 429 responses. schema: type: integer example: 30 securitySchemes: HayInsightsApiKey: type: apiKey in: header name: X-API-Key description: > 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. ````