> ## 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.

# Vietnam GDP by sector (NSO)

> Vietnam GDP by economic sector for one period, from the National Statistics Office of
Viet Nam (NSO). `sectors` has the 28 rows in the order NSO prints them (VSIC 2018):
total GDP, the three economic sectors (agriculture, forestry and fishing; industry and
construction; services), taxes less subsidies on products, and the industries under
them (`level` 0–3, `parentCode`).

Per row: `currentPrice` and `constantPrice` in billion VND, `shareOfGdp` in % of GDP
at current prices, `yoyGrowth` in % against the same period of the previous year at
constant prices. Values keep the 6 decimals of the source; a cell NSO does not publish
is `null`, never 0. The latest release of every cell is returned: NSO publishes each
quarter as an estimate, then revises it as preliminary in the next quarterly report.

Constant prices are at 2010 base up to Q4 2025 and at 2020 base from Q1 2026
(`priceBasis`): levels of the two bases are not comparable, growth rates are. Q1 2026
is derived (`derived: true`) — its latest revision is published only as the
preliminary 6-month figure minus the preliminary Q2 figure.

For charts, use the [time series](/api-reference/macro/vietnam-gdp-by-sector-series)
endpoint instead of one call per period.

Source: National Statistics Office of Viet Nam (www.nso.gov.vn).




## OpenAPI

````yaml /openapi.yaml get /openapi/v1/macro/vietnam/gdp-by-sector
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, fund composition and Bank of Japan ETF holdings.
  - 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, policy rates / bond yields, interbank rates, FDI,
      trade by region and the manufacturing PMI.
  - 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.
  - name: Equities
    description: >-
      Japanese stock detail (Tokyo Stock Exchange) — end-of-day snapshot,
      corporate events, daily prices, financial statements and sector peers —
      plus Vietnamese stock (HOSE / HNX / UPCoM) daily prices and financial
      statements.
paths:
  /openapi/v1/macro/vietnam/gdp-by-sector:
    get:
      tags:
        - Macro
      summary: Vietnam GDP by sector (NSO)
      description: >
        Vietnam GDP by economic sector for one period, from the National
        Statistics Office of

        Viet Nam (NSO). `sectors` has the 28 rows in the order NSO prints them
        (VSIC 2018):

        total GDP, the three economic sectors (agriculture, forestry and
        fishing; industry and

        construction; services), taxes less subsidies on products, and the
        industries under

        them (`level` 0–3, `parentCode`).


        Per row: `currentPrice` and `constantPrice` in billion VND, `shareOfGdp`
        in % of GDP

        at current prices, `yoyGrowth` in % against the same period of the
        previous year at

        constant prices. Values keep the 6 decimals of the source; a cell NSO
        does not publish

        is `null`, never 0. The latest release of every cell is returned: NSO
        publishes each

        quarter as an estimate, then revises it as preliminary in the next
        quarterly report.


        Constant prices are at 2010 base up to Q4 2025 and at 2020 base from Q1
        2026

        (`priceBasis`): levels of the two bases are not comparable, growth rates
        are. Q1 2026

        is derived (`derived: true`) — its latest revision is published only as
        the

        preliminary 6-month figure minus the preliminary Q2 figure.


        For charts, use the [time
        series](/api-reference/macro/vietnam-gdp-by-sector-series)

        endpoint instead of one call per period.


        Source: National Statistics Office of Viet Nam (www.nso.gov.vn).
      operationId: macroVietnamGdpBySector
      parameters:
        - name: type
          in: query
          required: false
          description: >
            Period type. Case-insensitive.


            | Value | Periods | Source |

            | --- | --- | --- |

            | `quarter` | single quarters, Q1 2021 onward | NSO quarterly
            socio-economic report |

            | `ytd` | year-to-date: 6, 9 and 12 months, 2021 onward | NSO
            quarterly socio-economic report |

            | `annual` | full years, 2010 onward | NSO statistical database
            (national accounts) |


            Quarterly and year-to-date data start in 2021, the first year NSO
            reported on its

            revised GDP scale; earlier quarterly reports used the old scale
            (about 27% lower)

            and are not comparable. `annual` covers 2010 onward on the revised
            scale.
          schema:
            type: string
            enum:
              - quarter
              - ytd
              - annual
            default: quarter
            example: quarter
        - name: period
          in: query
          required: false
          description: >
            Period to return, in the format of `type`. Omit for the latest
            period. A valid

            period with no data returns 200 with `sectors: []`.
            Case-insensitive.


            | `type` | Format | Examples |

            | --- | --- | --- |

            | `quarter` | `YYYY-Qn` | `2026-Q3` |

            | `ytd` | last month of the period: `YYYY-06`, `YYYY-09`, `YYYY-12`
            | `2026-09` (9 months), `2025-12` (full year) |

            | `annual` | `YYYY` | `2025` |
          schema:
            type: string
            example: 2026-Q3
      responses:
        '200':
          description: The 28 rows of one period.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MacroGdpSectorTableResponse'
              example:
                success: true
                statusCode: 200
                data:
                  country: vn
                  type: quarter
                  period: 2026-Q3
                  label: Q3 2026
                  latestPeriod: 2026-Q3
                  estimateStatus: estimate
                  priceBasis: constant_2020
                  knowledgeAt: '2026-10-03T01:00:06.000Z'
                  wasRestated: false
                  derived: false
                  derivedFrom: []
                  report:
                    period: 2026-Q3
                    label: Q3 2026
                    url: >-
                      https://www.nso.gov.vn/tin-tuc-thong-ke/2026/10/bao-cao-tinh-hinh-kinh-te-xa-hoi-quy-iii-va-9-thang-nam-2026/
                    publishedAt: '2026-10-03T01:00:06.000Z'
                  sectors:
                    - sectorCode: total
                      sectorName: Gross domestic product
                      sectorShortName: Gross domestic product
                      sectorNameVi: Tổng số
                      level: 0
                      parentCode: null
                      currentPrice: 3698333.989507
                      constantPrice: 3004778.442597
                      shareOfGdp: 100
                      yoyGrowth: 9.947988
                    - sectorCode: agriculture_forestry_fishing
                      sectorName: Agriculture, forestry and fishing
                      sectorShortName: Agriculture, forestry and fishing
                      sectorNameVi: Nông, lâm nghiệp và thủy sản
                      level: 1
                      parentCode: total
                      currentPrice: 395842.015292
                      constantPrice: 324474.407689
                      shareOfGdp: 10.703252
                      yoyGrowth: 4.206762
                    - sectorCode: agriculture
                      sectorName: Agriculture
                      sectorShortName: Agriculture
                      sectorNameVi: Nông nghiệp
                      level: 2
                      parentCode: agriculture_forestry_fishing
                      currentPrice: 283422.433287
                      constantPrice: 230654
                      shareOfGdp: 7.663516
                      yoyGrowth: 3.891719
                meta:
                  source: National Statistics Office of Viet Nam (www.nso.gov.vn)
                  source_url: >-
                    https://www.nso.gov.vn/tin-tuc-thong-ke/2026/10/bao-cao-tinh-hinh-kinh-te-xa-hoi-quy-iii-va-9-thang-nam-2026/
                  as_of: 2026-Q3
                  knowledge_at: '2026-10-03T01:00:06.000Z'
                  unit:
                    currentPrice:
                      unit: VND
                      scale: 1000000000
                      display: Billion VND
                    constantPrice:
                      unit: VND
                      scale: 1000000000
                      display: Billion VND
                    shareOfGdp:
                      unit: PERCENT
                      scale: 1
                      display: '%'
                    yoyGrowth:
                      unit: PERCENT
                      scale: 1
                      display: '%'
                  display_unit: Billion VND
                  classification:
                    currentPrice: RAW
                    constantPrice: RAW
                    shareOfGdp: RAW
                    yoyGrowth: DERIVED
                  formula_version: gdp-vn-sector-v1
                  was_restated: false
                  served_from_cache: false
                  cache_expires_at: '2026-11-03T07:10:49.165Z'
                  timestamp: '2026-11-02T07:10:49.165Z'
        '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:
    MacroGdpSectorTableResponse:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          required:
            - data
          properties:
            data:
              $ref: '#/components/schemas/GdpSectorTable'
            meta:
              $ref: '#/components/schemas/GdpSectorMeta'
    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'
    GdpSectorTable:
      type: object
      description: >
        Vietnam GDP by sector for one period. When the period has no data,
        `sectors` is empty,

        the period fields are `null` and `latestPeriod` is still set.
      required:
        - country
        - type
        - period
        - label
        - latestPeriod
        - estimateStatus
        - priceBasis
        - knowledgeAt
        - wasRestated
        - derived
        - derivedFrom
        - report
        - sectors
      properties:
        country:
          type: string
          enum:
            - vn
          example: vn
        type:
          type: string
          enum:
            - quarter
            - ytd
            - annual
          example: quarter
        period:
          type:
            - string
            - 'null'
          description: >-
            Period returned — the one requested, or the latest when `period` is
            omitted.
          example: 2026-Q3
        label:
          type:
            - string
            - 'null'
          example: Q3 2026
        latestPeriod:
          type:
            - string
            - 'null'
          description: Latest period with data for `type` (the table's "As of").
          example: 2026-Q3
        estimateStatus:
          type:
            - string
            - 'null'
          enum:
            - estimate
            - preliminary
            - official
            - null
          description: See `GdpSectorPeriodSummary.estimateStatus`.
          example: estimate
        priceBasis:
          type:
            - string
            - 'null'
          enum:
            - constant_2010
            - constant_2020
            - null
          example: constant_2020
        knowledgeAt:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-10-03T01:00:06.000Z'
        wasRestated:
          type: boolean
          example: false
        derived:
          type: boolean
          example: false
        derivedFrom:
          type: array
          description: >-
            The two source periods when `derived` is `true` (6-month preliminary
            and Q2 preliminary); empty otherwise.
          items:
            type: object
            required:
              - type
              - period
              - label
              - estimateStatus
              - knowledgeAt
            properties:
              type:
                type: string
                enum:
                  - quarter
                  - ytd
                example: ytd
              period:
                type: string
                example: 2026-06
              label:
                type: string
                example: 6M 2026
              estimateStatus:
                type: string
                example: preliminary
              knowledgeAt:
                type: string
                format: date-time
                example: '2026-10-03T01:00:06.000Z'
        report:
          type:
            - object
            - 'null'
          description: >-
            The NSO quarterly report the numbers come from; `null` for `annual`
            (statistical database).
          required:
            - period
            - label
            - url
            - publishedAt
          properties:
            period:
              type: string
              example: 2026-Q3
            label:
              type: string
              example: Q3 2026
            url:
              type:
                - string
                - 'null'
              format: uri
              example: >-
                https://www.nso.gov.vn/tin-tuc-thong-ke/2026/10/bao-cao-tinh-hinh-kinh-te-xa-hoi-quy-iii-va-9-thang-nam-2026/
            publishedAt:
              type:
                - string
                - 'null'
              format: date-time
              example: '2026-10-03T01:00:06.000Z'
        sectors:
          type: array
          description: >
            The 28 rows in NSO's order. With `type=annual`, `agriculture`,
            `forestry`, `fishery`

            and `industry` are always `null` — NSO's annual tables do not
            publish them.
          items:
            $ref: '#/components/schemas/GdpSectorRow'
    GdpSectorMeta:
      description: >
        Response metadata for Vietnam GDP by sector: where the numbers come
        from, their units,

        which fields HayInsights computes, and how fresh the response is.
      allOf:
        - $ref: '#/components/schemas/Meta'
        - type: object
          properties:
            source:
              type: string
              description: >-
                Data provider. NSO's terms require citing www.nso.gov.vn when
                reusing the data.
              example: National Statistics Office of Viet Nam (www.nso.gov.vn)
            source_url:
              type: string
              format: uri
              description: >-
                The NSO report for the period, or NSO's national-accounts page
                for annual data.
              example: >-
                https://www.nso.gov.vn/tin-tuc-thong-ke/2026/10/bao-cao-tinh-hinh-kinh-te-xa-hoi-quy-iii-va-9-thang-nam-2026/
            as_of:
              type:
                - string
                - 'null'
              description: Latest period with data for `type`.
              example: 2026-Q3
            knowledge_at:
              type:
                - string
                - 'null'
              format: date-time
              description: Same as `data.knowledgeAt` (single-period endpoint only).
              example: '2026-10-03T01:00:06.000Z'
            unit:
              type: object
              description: >-
                Unit of each value field — `VND` with scale 1e9 (billion VND) or
                `PERCENT`.
              additionalProperties:
                type: object
                properties:
                  unit:
                    type: string
                    example: VND
                  scale:
                    type: number
                    example: 1000000000
                  display:
                    type: string
                    example: Billion VND
            display_unit:
              type: string
              description: Unit label for the two value columns.
              example: Billion VND
            classification:
              type: object
              description: >
                How each field was produced: values and shares as NSO published
                them (RAW);

                growth converted to percent when NSO prints an index (DERIVED);
                every field of a

                derived period is COMPUTED.
              additionalProperties:
                type: string
                enum:
                  - RAW
                  - DERIVED
                  - COMPUTED
              example:
                currentPrice: RAW
                constantPrice: RAW
                shareOfGdp: RAW
                yoyGrowth: DERIVED
            classification_derived_points:
              type: object
              description: >-
                Series endpoint only — classification that applies to points
                with `derived: true`.
              additionalProperties:
                type: string
              example:
                currentPrice: COMPUTED
                constantPrice: COMPUTED
                shareOfGdp: COMPUTED
                yoyGrowth: COMPUTED
            formula_version:
              type: string
              description: Version tag of the HayInsights transformations.
              example: gdp-vn-sector-v1
            was_restated:
              type: boolean
              description: Same as `data.wasRestated` (single-period endpoint only).
              example: false
            served_from_cache:
              type: boolean
              example: false
            cache_expires_at:
              type:
                - string
                - 'null'
              format: date-time
              description: >-
                When the cached copy expires (24 h; dropped as soon as new data
                is collected).
              example: '2026-11-03T07:10:49.165Z'
    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
    GdpSectorRow:
      description: >-
        One row of the table — its name and position plus its four values for
        the period.
      allOf:
        - $ref: '#/components/schemas/GdpSectorInfo'
        - $ref: '#/components/schemas/GdpSectorValues'
    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
    GdpSectorInfo:
      type: object
      description: >-
        Name and position of one of the 28 rows, in the order NSO prints them
        (VSIC 2018).
      required:
        - sectorCode
        - sectorName
        - sectorShortName
        - sectorNameVi
        - level
        - parentCode
      properties:
        sectorCode:
          type: string
          description: >
            Stable row code: `total`, the three economic sectors
            `agriculture_forestry_fishing`,

            `industry_construction`, `services`, `product_taxes_less_subsidies`,
            and the industries

            under them (e.g. `manufacturing`, `construction`, `real_estate`).
          example: manufacturing
        sectorName:
          type: string
          description: Full English name (ISIC wording).
          example: Manufacturing
        sectorShortName:
          type: string
          description: Short English name for table cells and chart legends.
          example: Manufacturing
        sectorNameVi:
          type: string
          description: Vietnamese name as NSO prints it.
          example: Công nghiệp chế biến, chế tạo
        level:
          type: integer
          minimum: 0
          maximum: 3
          description: >-
            0 = GDP, 1 = economic sectors and product taxes, 2 = industries, 3 =
            sub-industries of industry. Children add up to their parent (source
            rounding under 1 billion VND).
          example: 3
        parentCode:
          type:
            - string
            - 'null'
          description: Code of the direct parent row; `null` for `total`.
          example: industry
    GdpSectorValues:
      type: object
      description: >
        The four values of one row for one period. A cell NSO does not publish
        is `null` —

        never 0. Values keep the 6 decimals of the source; round for display.
      required:
        - sectorCode
        - currentPrice
        - constantPrice
        - shareOfGdp
        - yoyGrowth
      properties:
        sectorCode:
          type: string
          description: Stable row code (see `GdpSectorRow`).
          example: total
        currentPrice:
          type:
            - number
            - 'null'
          description: >-
            Value at current prices, in billion VND. GDP for `total`, value
            added for the other rows.
          example: 3698333.989507
        constantPrice:
          type:
            - number
            - 'null'
          description: >
            Value at constant prices of the base year in `priceBasis`, in
            billion VND. Levels at

            2010 and 2020 prices cannot be chained.
          example: 3004778.442597
        shareOfGdp:
          type:
            - number
            - 'null'
          description: Share of GDP at current prices, in percent (`total` = 100).
          example: 100
        yoyGrowth:
          type:
            - number
            - 'null'
          description: >
            Growth at constant prices against the same period of the previous
            year, in percent.

            Can be negative. Quarter vs same quarter, year-to-date vs same
            year-to-date period,

            year vs previous year.
          example: 9.947988
  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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.