# HayInsights Open API

> The official API for the HayInsights financial-data hub — commodities, crypto, ETF, FX, macro and real-estate datasets.

## Docs

- [Commodity price history](https://developer.hayinsights.com/api-reference/commodities/commodity-price-history.md): Historical closing prices for a single commodity. Use the `id` slug returned by the list endpoint (e.g. `gold`, `wti-crude`).
- [Featured commodities](https://developer.hayinsights.com/api-reference/commodities/featured-commodities.md): A curated set of headline commodities (gold, crude oil, copper, …) with the latest close, 1-day change and a short price sparkline.
- [Gold vs DXY correlation](https://developer.hayinsights.com/api-reference/commodities/gold-vs-dxy-correlation.md): Rebased gold price and US Dollar Index (DXY) series over the requested window, for visualising their (typically inverse) correlation.
- [List commodity prices](https://developer.hayinsights.com/api-reference/commodities/list-commodity-prices.md): Latest price snapshot for every tracked commodity across energy, metals, agriculture and macro categories — including 1-day / MTD / YTD changes, the 50-period moving average, a trend classification and a sparkline.
- [Top movers](https://developer.hayinsights.com/api-reference/commodities/top-movers.md): The biggest gaining and losing commodities over the requested period.
- [Crypto bubble map](https://developer.hayinsights.com/api-reference/crypto/crypto-bubble-map.md): Top coins by market capitalisation with their price change over a selected timeframe and a normalised bubble size, for a bubble-map visualisation.
- [Crypto derivatives metrics](https://developer.hayinsights.com/api-reference/crypto/crypto-derivatives-metrics.md): Derivatives-market metrics — open interest, funding rates, 24h liquidations and the options put/call ratio for the major coins.
- [Crypto market dominance](https://developer.hayinsights.com/api-reference/crypto/crypto-market-dominance.md): Market-cap dominance breakdown — total market cap and each major coin's share of it, with the freshness of the underlying source data.
- [Crypto market overview](https://developer.hayinsights.com/api-reference/crypto/crypto-market-overview.md): Snapshot of the crypto market — total market capitalisation, 24h volume, major-coin dominance split, the Fear & Greed index and trending coins.
- [Crypto on-chain metrics](https://developer.hayinsights.com/api-reference/crypto/crypto-on-chain-metrics.md): On-chain network metrics — Ethereum gas prices, Bitcoin hashrate and active addresses, whale transaction count and the MVRV / NUPL valuation indicators.
- [Compare fund composition](https://developer.hayinsights.com/api-reference/etf/compare-fund-composition.md): Side-by-side composition for two to five Vietnamese funds — asset allocation, the equity portfolio and the sector breakdown — for direct comparison. Pass the VN fund codes (e.g. `VESAF`) as a comma-separated `codes` list.
- [Compare NAV growth](https://developer.hayinsights.com/api-reference/etf/compare-nav-growth.md): NAV-growth series for two Vietnamese funds, benchmarked against the VN-Index, across the available period windows. Pass the two VN fund codes (e.g. `VESAF`) as `code1` and `code2`.
- [ETF detail](https://developer.hayinsights.com/api-reference/etf/etf-detail.md): Full detail view for a single ETF — descriptive metadata, latest price, top holdings, valuation ratios, sector weights, net-flow history and cumulative-return performance by period. Use the exchange ticker (e.g. a TSE code like `1306`) as the `{code}` path param.
- [ETF / fund composition](https://developer.hayinsights.com/api-reference/etf/etf-fund-composition.md): Full composition of a single Vietnamese fund certificate — asset allocation, the equity portfolio and the sector breakdown. Use the VN fund code (e.g. `VESAF`) as the `{code}` path param.
- [ETF holdings](https://developer.hayinsights.com/api-reference/etf/etf-holdings.md): The underlying constituent holdings of an ETF's basket — ticker, name, shares held and position value, as of the latest fund snapshot. Use the exchange ticker (e.g. a TSE code like `1306`) as the `{code}` path param.
- [ETF info](https://developer.hayinsights.com/api-reference/etf/etf-info.md): Core descriptive metadata for a single ETF — manager, benchmark index, listing date, trust fee and distribution yield. Use the exchange ticker (e.g. a TSE code like `1306`) as the `{code}` path param.
- [ETF market heatmap](https://developer.hayinsights.com/api-reference/etf/etf-market-heatmap.md): Snapshot of every tracked ETF for rendering a treemap heatmap — closing price, volume, market cap, price fluctuation and each fund's contribution to the aggregate index movement. `contributionArea` is the relative tile size.
- [ETF NAV growth](https://developer.hayinsights.com/api-reference/etf/etf-nav-growth.md): NAV-growth series for a single Vietnamese fund, benchmarked against the VN-Index, across the available period windows. Use the VN fund certificate code (e.g. `VESAF`) as the `{code}` path param. The response shares the comparison shape; the unused `etf2` slot has an empty `etfCode`.
- [ETF price history](https://developer.hayinsights.com/api-reference/etf/etf-price-history.md): Daily OHLCV price history for a single ETF, ordered oldest to newest. Use the exchange ticker (e.g. a TSE code like `1306`) as the `{code}` path param.
- [List ETFs](https://developer.hayinsights.com/api-reference/etf/list-etfs.md): The full catalogue of tracked exchange-traded funds, with descriptive metadata (manager, benchmark index, trust fee), the latest price and assets under management. Use an entry's `etfCode` as the `{code}` path param for the info, holdings, prices-history and detail endpoints.
- [Top ETFs by net flow](https://developer.hayinsights.com/api-reference/etf/top-etfs-by-net-flow.md): ETFs ranked by net capital flow. Set `type` to `positive` for the largest inflows or `negative` for the largest outflows.
- [Top-performing ETFs](https://developer.hayinsights.com/api-reference/etf/top-performing-etfs.md): ETFs ranked by NAV change over the requested period, best to worst. Use the `period` query parameter to choose the look-back window.
- [Emerging-market FX stress](https://developer.hayinsights.com/api-reference/fx/emerging-market-fx-stress.md): Emerging-market FX stress monitor — for each tracked pair, compares recent realised volatility against its 90-day distribution and classifies the pair as STABLE, WARNING or PANIC.
- [FX correlation matrix](https://developer.hayinsights.com/api-reference/fx/fx-correlation-matrix.md): Rolling 90-day correlation matrix across major FX, crypto and gold benchmarks. `matrix[i][j]` is the Pearson correlation between `symbols[i]` and `symbols[j]`.
- [FX summary](https://developer.hayinsights.com/api-reference/fx/fx-summary.md): FX dashboard summary — the US Dollar Index (DXY), the USD/JPY rate (each with a 1-day change) and a headline emerging-market FX stress reading.
- [FX table](https://developer.hayinsights.com/api-reference/fx/fx-table.md): Live table of tracked currency pairs — latest price, 1-day change, a 10-day sparkline and the 52-week high / low for each.
- [Central government debt (% of GDP)](https://developer.hayinsights.com/api-reference/macro/central-government-debt-%-of-gdp.md): Quarterly central-government debt expressed as a percentage of GDP for a country, with the year-over-year change in the ratio.
- [Economic data series](https://developer.hayinsights.com/api-reference/macro/economic-data-series.md): Time series for a selected macroeconomic indicator — GDP, CPI, PCE or import-export — for a country, over a chosen look-back window.
- [Exchange rate series](https://developer.hayinsights.com/api-reference/macro/exchange-rate-series.md): Daily closing exchange-rate history for a currency pair. Optionally limit the look-back window or return only data before a given date.
- [GDP growth rate](https://developer.hayinsights.com/api-reference/macro/gdp-growth-rate.md): Quarterly nominal GDP and its period-over-period growth rate for a country. Each point also carries the value's unit and the start/end of the quarter.
- [Latest macroeconomic market recap](https://developer.hayinsights.com/api-reference/macro/latest-macroeconomic-market-recap.md): A point-in-time market recap bundling the latest Japanese equity / commodity indices, REITs, TOPIX, 3-month interbank reference rates and key currency rates into a single payload.
- [Policy rates & bond yields](https://developer.hayinsights.com/api-reference/macro/policy-rates-&-bond-yields.md): Monthly policy / overnight call rate alongside the 10-year government bond yield for a country, over a chosen look-back window.
- [Population & unemployment](https://developer.hayinsights.com/api-reference/macro/population-&-unemployment.md): Monthly total-population figures alongside the unemployment rate for a country, over a chosen look-back window.
- [Country land-price statistics](https://developer.hayinsights.com/api-reference/real-estate/country-land-price-statistics.md): Aggregate land-price statistics for a country — overall ward / segment totals, the observed price range, per-area breakdowns and the highest-priced roads. Data is available for `vn`; `jp` is empty.
- [Country real-estate summary](https://developer.hayinsights.com/api-reference/real-estate/country-real-estate-summary.md): Top-level real-estate summary for a country. Currently returns an empty array on staging — use the `stats`, `wards`, `land-prices`, `provinces` and `geojson` sub-routes for detailed data. Data is available for `vn`; `jp` is empty.
- [List priced road segments](https://developer.hayinsights.com/api-reference/real-estate/list-priced-road-segments.md): Priced road segments for a country, with residential, commercial and production prices across value-position tiers. Filter by land-use `type`, `area`, `ward_id` or a free-text search, and cap the result count with `limit`. Data is available for `vn`.
- [List provinces](https://developer.hayinsights.com/api-reference/real-estate/list-provinces.md): Provinces / cities available for real-estate queries in a country. Data is available for `vn`; `jp` is empty.
- [List ward land-price summaries](https://developer.hayinsights.com/api-reference/real-estate/list-ward-land-price-summaries.md): Ward-level land-price summaries for a country — average residential prices across value-position tiers, min/max prices and road counts. Data is available for `vn`; `jp` is empty.
- [Ward choropleth GeoJSON](https://developer.hayinsights.com/api-reference/real-estate/ward-choropleth-geojson.md): Ward boundary geometry paired with average-price attributes, for rendering a choropleth map. The response can be large (boundary coordinates for every ward); the geometry is modelled permissively. Data is available for `vn`; `jp` is empty.
- [Ward land-price detail](https://developer.hayinsights.com/api-reference/real-estate/ward-land-price-detail.md): Full land-price detail for a single ward — an aggregate summary plus every priced road segment with residential, commercial and production prices across value-position tiers. Use the `wardId` returned by the wards list. Data is available for `vn`.
- [Authentication](https://developer.hayinsights.com/authentication.md): A single API key in the X-API-Key header — no request signing.
- [Changelog](https://developer.hayinsights.com/changelog.md): Notable changes to the HayInsights Open API.
- [Error codes](https://developer.hayinsights.com/errors.md): HTTP status mapping, the error envelope, and how to handle errors.
- [Introduction](https://developer.hayinsights.com/introduction.md): Programmatic access to the HayInsights financial-data hub.
- [Plans & features](https://developer.hayinsights.com/plans-and-features.md): How your subscription plan unlocks data domains.
- [Quickstart](https://developer.hayinsights.com/quickstart.md): Make your first request in under 5 minutes — just one header.
- [Rate limits](https://developer.hayinsights.com/rate-limits.md): A weighted, per-minute quota tied to your plan.

## OpenAPI Specs

- [openapi](https://developer.hayinsights.com/openapi.yaml)