Skip to main content
GET
Vietnam FDI breakdown

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

level
enum<string>
required

Breakdown level.

Available options:
province,
country,
industry
Example:

"province"

period
string

Month (YYYY-MM). Defaults to the latest month with data.

Pattern: ^\d{4}-(0[1-9]|1[0-2])$
Example:

"2026-09"

mode
enum<string>
default:cumulative

cumulative (year to date, as published) or monthly (that month only, derived).

Available options:
cumulative,
monthly
limit
integer

Number of items, sorted by registered capital.

Required range: x >= 1
Example:

10

asOf
string<date>

Backtest: return exactly what the system knew at the end of that day (UTC), not later revisions by the source. Omit for the latest data.

Example:

"2026-09-01"

Response

FDI into Vietnam by province, partner or industry.

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
required
meta
object

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