> ## Documentation Index
> Fetch the complete documentation index at: https://hoalulab.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Giao dịch nhà đầu tư nước ngoài

> Cung cấp dữ liệu giao dịch của nhà đầu tư nước ngoài theo từng mã chứng khoán, 
bao gồm khối lượng và giá trị mua/bán,tổng lũy kế trong ngày và room còn lại. 
Dữ liệu được cập nhật trong phiên giao dịch khi có thay đổi.



## AsyncAPI

````yaml vi/openapi/dnse-v2-asyncapi.yaml foreignStream
id: foreignStream
title: Giao dịch nhà đầu tư nước ngoài
description: >-
  Cung cấp dữ liệu giao dịch của nhà đầu tư nước ngoài theo từng mã chứng
  khoán, 

  bao gồm khối lượng và giá trị mua/bán,tổng lũy kế trong ngày và room còn lại. 

  Dữ liệu được cập nhật trong phiên giao dịch khi có thay đổi.
servers:
  - id: production
    protocol: wss
    host: ws-openapi.dnse.com.vn
    bindings: []
    variables: []
address: /v1/stream
parameters: []
bindings:
  - protocol: ws
    version: 0.1.0
    value:
      method: GET
      query:
        type: object
        additionalProperties: false
        required:
          - encoding
        properties:
          encoding:
            type: string
            const: json
            default: json
            description: Định dạng mã hóa dữ liệu WebSocket.
    schemaProperties:
      - name: method
        type: string
        description: GET
        required: false
      - name: query
        type: object
        required: false
        properties:
          - name: encoding
            type: string
            description: Định dạng mã hóa dữ liệu WebSocket.
            required: true
operations:
  - &ref_1
    id: onForeignSubscription
    title: Đăng ký luồng giao dịch nước ngoài
    type: receive
    messages:
      - &ref_3
        id: subscribeRequest
        contentType: application/json
        payload:
          - name: Đăng ký luồng giao dịch nước ngoài
            description: Đăng ký topic `foreign.{market_group}.json`.
            type: object
            properties:
              - name: action
                type: string
                description: subscribe
                required: true
              - name: channels
                type: array
                required: true
                properties:
                  - name: name
                    type: string
                    description: Topic giao dịch nước ngoài theo nhóm thị trường.
                    required: true
                  - name: symbols
                    type: array
                    required: true
                    properties:
                      - name: item
                        type: string
                        required: false
        headers: []
        jsonPayloadSchema:
          type: object
          additionalProperties: false
          required:
            - action
            - channels
          properties:
            action:
              type: string
              const: subscribe
              x-parser-schema-id: <anonymous-schema-215>
            channels:
              type: array
              minItems: 1
              uniqueItems: true
              items:
                type: object
                additionalProperties: false
                required:
                  - name
                  - symbols
                properties:
                  name:
                    type: string
                    description: Topic giao dịch nước ngoài theo nhóm thị trường.
                    pattern: ^foreign\.[A-Z0-9]+\.json$
                    x-parser-schema-id: <anonymous-schema-218>
                  symbols:
                    type: array
                    minItems: 1
                    uniqueItems: true
                    items:
                      type: string
                      minLength: 1
                      x-parser-schema-id: <anonymous-schema-220>
                    x-parser-schema-id: <anonymous-schema-219>
                x-parser-schema-id: <anonymous-schema-217>
              x-parser-schema-id: <anonymous-schema-216>
          x-parser-schema-id: <anonymous-schema-214>
        title: Đăng ký luồng giao dịch nước ngoài
        description: Đăng ký topic `foreign.{market_group}.json`.
        example: |-
          {
            "action": "subscribe",
            "channels": [
              {
                "name": "foreign.G1.json",
                "symbols": [
                  "HPG"
                ]
              }
            ]
          }
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: subscribeRequest
    bindings: []
    extensions: &ref_0
      - id: x-parser-unique-object-id
        value: foreignStream
  - &ref_2
    id: onForeignUpdates
    title: Nhận cập nhật giao dịch nước ngoài
    type: send
    messages:
      - &ref_4
        id: update
        contentType: application/json
        payload:
          - name: Cập nhật giao dịch nước ngoài
            description: Bản cập nhật khối lượng mua bán của nhà đầu tư nước ngoài.
            type: object
            properties:
              - name: T
                type: string
                description: Mã loại message giao dịch nước ngoài.
                required: true
              - name: symbol
                type: string
                description: Mã chứng khoán.
                required: true
              - name: marketId
                type: string
                description: Mã thị trường.
                required: true
              - name: boardId
                type: string
                description: Mã bảng giao dịch.
                required: true
              - name: tradingSessionId
                type: string
                description: Mã phiên giao dịch hiện tại.
                required: true
              - name: transactTime
                type: string
                description: Thời điểm cập nhật.
                required: true
              - name: foreignInvestorTypeCode
                type: string
                description: Loại nhà đầu tư nước ngoài.
                required: true
              - name: buyVolume
                type: integer
                description: Khối lượng mua trong ngày theo bảng giao dịch.
                required: true
              - name: buyTradedAmount
                type: number
                description: Giá trị mua trong ngày theo bảng giao dịch.
                required: true
              - name: sellVolume
                type: integer
                description: Khối lượng bán trong ngày theo bảng giao dịch.
                required: true
              - name: sellTradedAmount
                type: number
                description: Giá trị bán trong ngày theo bảng giao dịch.
                required: true
              - name: totalBuyVolume
                type: integer
                description: Tổng khối lượng mua trong ngày.
                required: true
              - name: totalBuyTradedAmount
                type: number
                description: Tổng giá trị mua trong ngày.
                required: true
              - name: totalSellVolume
                type: integer
                description: Tổng khối lượng bán trong ngày.
                required: true
              - name: totalSellTradedAmount
                type: number
                description: Tổng giá trị bán trong ngày.
                required: true
              - name: foreignerOrderLimitQuantity
                type: integer
                description: Tổng room sở hữu tối đa của nhà đầu tư nước ngoài.
                required: true
              - name: foreignerBuyPossibleQuantity
                type: integer
                description: Room còn lại nhà đầu tư nước ngoài có thể mua.
                required: true
              - name: multicastReceiveTime
                type: object
                description: Thời gian nhận message qua multicast.
                required: true
                properties:
                  - name: Seconds
                    type: integer
                    description: Unix timestamp tính bằng giây.
                    required: true
                  - name: Nanos
                    type: integer
                    description: Phần nanosecond của timestamp.
                    required: true
        headers: []
        jsonPayloadSchema:
          type: object
          description: >-
            Dữ liệu giao dịch mua bán của nhà đầu tư nước ngoài theo mã chứng
            khoán.
          required:
            - T
            - symbol
            - buyVolume
            - sellVolume
            - totalBuyVolume
            - totalSellVolume
            - marketId
            - boardId
            - tradingSessionId
            - transactTime
            - foreignInvestorTypeCode
            - buyTradedAmount
            - sellTradedAmount
            - totalBuyTradedAmount
            - totalSellTradedAmount
            - foreignerOrderLimitQuantity
            - foreignerBuyPossibleQuantity
            - multicastReceiveTime
          properties:
            T:
              type: string
              description: Mã loại message giao dịch nước ngoài.
              const: f
              x-parser-schema-id: <anonymous-schema-222>
            symbol:
              type: string
              description: Mã chứng khoán.
              x-parser-schema-id: <anonymous-schema-223>
            marketId:
              type: string
              description: Mã thị trường.
              x-parser-schema-id: <anonymous-schema-224>
            boardId:
              type: string
              description: Mã bảng giao dịch.
              x-parser-schema-id: <anonymous-schema-225>
            tradingSessionId:
              type: string
              description: Mã phiên giao dịch hiện tại.
              x-parser-schema-id: <anonymous-schema-226>
            transactTime:
              type: string
              description: Thời điểm cập nhật.
              x-parser-schema-id: <anonymous-schema-227>
            foreignInvestorTypeCode:
              type: string
              description: Loại nhà đầu tư nước ngoài.
              x-parser-schema-id: <anonymous-schema-228>
            buyVolume:
              type: integer
              description: Khối lượng mua trong ngày theo bảng giao dịch.
              x-parser-schema-id: <anonymous-schema-229>
            buyTradedAmount:
              type: number
              description: Giá trị mua trong ngày theo bảng giao dịch.
              x-parser-schema-id: <anonymous-schema-230>
            sellVolume:
              type: integer
              description: Khối lượng bán trong ngày theo bảng giao dịch.
              x-parser-schema-id: <anonymous-schema-231>
            sellTradedAmount:
              type: number
              description: Giá trị bán trong ngày theo bảng giao dịch.
              x-parser-schema-id: <anonymous-schema-232>
            totalBuyVolume:
              type: integer
              description: Tổng khối lượng mua trong ngày.
              x-parser-schema-id: <anonymous-schema-233>
            totalBuyTradedAmount:
              type: number
              description: Tổng giá trị mua trong ngày.
              x-parser-schema-id: <anonymous-schema-234>
            totalSellVolume:
              type: integer
              description: Tổng khối lượng bán trong ngày.
              x-parser-schema-id: <anonymous-schema-235>
            totalSellTradedAmount:
              type: number
              description: Tổng giá trị bán trong ngày.
              x-parser-schema-id: <anonymous-schema-236>
            foreignerOrderLimitQuantity:
              type: integer
              description: Tổng room sở hữu tối đa của nhà đầu tư nước ngoài.
              x-parser-schema-id: <anonymous-schema-237>
            foreignerBuyPossibleQuantity:
              type: integer
              description: Room còn lại nhà đầu tư nước ngoài có thể mua.
              x-parser-schema-id: <anonymous-schema-238>
            multicastReceiveTime:
              type: object
              description: Thời gian nhận message qua multicast.
              required:
                - Seconds
                - Nanos
              properties:
                Seconds:
                  type: integer
                  format: int64
                  description: Unix timestamp tính bằng giây.
                  x-parser-schema-id: <anonymous-schema-240>
                Nanos:
                  type: integer
                  format: int32
                  description: Phần nanosecond của timestamp.
                  x-parser-schema-id: <anonymous-schema-241>
              x-parser-schema-id: <anonymous-schema-239>
          x-parser-schema-id: <anonymous-schema-221>
        title: Cập nhật giao dịch nước ngoài
        description: Bản cập nhật khối lượng mua bán của nhà đầu tư nước ngoài.
        example: |-
          {
            "T": "f",
            "boardId": "G1",
            "buyTradedAmount": 17703665000,
            "buyVolume": 842500,
            "foreignInvestorTypeCode": "10",
            "foreignerBuyPossibleQuantity": 2453576846,
            "foreignerOrderLimitQuantity": 2393988233,
            "marketId": "STO",
            "multicastReceiveTime": {
              "Nanos": 601985803,
              "Seconds": 1787122808
            },
            "sellTradedAmount": 47417210000,
            "sellVolume": 2257300,
            "symbol": "HPG",
            "totalBuyTradedAmount": 32616877100,
            "totalBuyVolume": 1605324,
            "totalSellTradedAmount": 62332478100,
            "totalSellVolume": 3020222,
            "tradingSessionId": "40",
            "transactTime": "070000049"
          }
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: update
    bindings: []
    extensions: *ref_0
sendOperations:
  - *ref_1
receiveOperations:
  - *ref_2
sendMessages:
  - *ref_3
receiveMessages:
  - *ref_4
extensions:
  - id: x-parser-unique-object-id
    value: foreignStream
securitySchemes: []

````

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