Welcome to vAPI’s documentation!

Authors

If you would like to contribute to this open project, feel free to email us at contact@vnappmob.com

Province API

This module allows users to get a list of province, district & ward in Vietnam

Quick reference

Resource Operation Description
  1. Province
 GET /api/province/ Get list of provinces
  1. District
 GET /api/province/district/(string:province_id) Get list of districts with {province_id}
  1. Ward
 GET /api/province/ward/(string:district_id) Get list of wards with {district_id}

Details

GET /api/province/

This function allows users to get a list of provinces in Vietnam

Request:

GET /api/province HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "province_id": 92,
            "province_name": "Thành phố Hà Nội",
            "province_type": "Thành phố Trung ương"
        }
    ]
}
Response Headers:
 
Status Codes:
GET /api/province/district/(string: province_id)

This function allows users to get a list of districts in Vietnam followed by {province_id}

Request:

GET /api/province/district/{province_id} HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "district_id": 271,
            "district_name": "Huyện Ba Vì"
        }
    ]
}
Response Headers:
 
Status Codes:
GET /api/province/ward/(string: district_id)

This function allows users to get a list of wards in Vietnam followed by {district_id}

Request:

GET /api/province/ward/{district_id} HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "ward_id": 271,
            "ward_name": "Thị trấn Tây Đằng"
        }
    ]
}
Response Headers:
 
Status Codes:

Gold Price API (version 2)

This module allows users to get gold data

Quick reference

Resource Operation Description
  1. SJC Price
 GET /api/v2/gold/sjc Get SJC Gold Price
  POST /api/v2/gold/sjc Post SJC Gold Price
  1. DOJI Price
 GET /api/v2/gold/doji Get DOJI Gold Price
  POST /api/v2/gold/doji Post DOJI Gold Price
  1. PNJ Price
 GET /api/v2/gold/pnj Get PNJ Gold Price
  POST /api/v2/gold/pnj Post PNJ Gold Price

Usage permission

To use this API, please self-request api_key at https://vapi.vnappmob.com/api/request_api_key?scope=gold

The api_key will be expired by default after 15 days

Details

GET /api/v2/gold/doji

This function allows users to get the latest DOJI Gold price

Request:

GET /api/v2/gold/doji HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "buy_hcm": 42550000.00,
            "sell_hcm": 42550000.00
        }...
    ]
}
Query Parameters:
 
  • date_from – Set date from query
  • date_to – Set date to query
Request Headers:
 
Response Headers:
 
Status Codes:
POST /api/v2/gold/doji

This function allows data manager to push newest data

Request:

POST /api/v2/gold/doji HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 201 Created
Vary: Accept
Request Headers:
 
Request JSON Object:
 
  • buy_hcm (float) – buy_hcm
  • sell_hcm (float) – sell_hcm
  • buy_hn (float) – buy_hn
  • sell_hn (float) – sell_hn
Status Codes:
GET /api/v2/gold/sjc

This function allows users to get the latest SJC Gold price

Request:

GET /api/v2/gold/sjc HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "buy_1l": 42550000.00,
            "sell_1l": 42550000.00
        }...
    ]
}
Query Parameters:
 
  • date_from – Set date from query
  • date_to – Set date to query
Request Headers:
 
Response Headers:
 
Status Codes:
POST /api/v2/gold/sjc

This function allows data manager to push newest data

Request:

POST /api/v2/gold/sjc HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 201 Created
Vary: Accept
Request Headers:
 
Request JSON Object:
 
  • buy_1l (float) – buy_1l
  • sell_1l (float) – sell_1l
  • buy_1c (float) – buy_1c
  • sell_1c (float) – sell_1c
  • buy_nhan1c (float) – buy_nhan1c
  • sell_nhan1c (float) – sell_nhan1c
  • buy_trangsuc49 (float) – buy_trangsuc49
  • sell_trangsuc49 (float) – sell_trangsuc49
Status Codes:
GET /api/v2/gold/pnj

This function allows users to get the latest PNJ Gold price

Request:

GET /api/v2/gold/pnj HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "buy_hcm": 42550000.00,
            "sell_hcm": 42550000.00
        }...
    ]
}
Query Parameters:
 
  • date_from – Set date from query
  • date_to – Set date to query
Request Headers:
 
Response Headers:
 
Status Codes:
POST /api/v2/gold/pnj

This function allows data manager to push newest data

Request:

POST /api/v2/gold/pnj HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 201 Created
Vary: Accept
Request Headers:
 
Request JSON Object:
 
  • buy_hcm (float) – buy_hcm
  • sell_hcm (float) – sell_hcm
  • buy_hn (float) – buy_hn
  • sell_hn (float) – sell_hn
Status Codes:

Exchange rate API (version 2)

This module allows users to get exchange rate data

Quick reference

Resource Operation Description
  1. Vietcombank (VCB)
 GET /api/v2/exchange_rate/vcb Get all Vietcombank (VCB) exchange rate
  POST /api/v2/exchange_rate/vcb Post new exchange rate
  1. Vietinbank (CTG)
 GET /api/v2/exchange_rate/ctg Get all Vietinbank (CTG) exchange rate
  POST /api/v2/exchange_rate/ctg Post new exchange rate
  1. Techcombank (TCB)
 GET /api/v2/exchange_rate/tcb Get all Techcombank (TCB) exchange rate
  POST /api/v2/exchange_rate/tcb Post new exchange rate
  1. BIDV
 GET /api/v2/exchange_rate/bid Get all BIDV exchange rate
  POST /api/v2/exchange_rate/bid Post new exchange rate
  1. Sacombank (STB)
 GET /api/v2/exchange_rate/stb Get all Sacombank (STB) exchange rate
  POST /api/v2/exchange_rate/stb Post new exchange rate
SBV GET /api/v2/exchange_rate/sbv Get all SBV exchange rate
  POST /api/v2/exchange_rate/sbv Post new exchange rate

Usage permission

To use this API, please self-request api_key at https://vapi.vnappmob.com/api/request_api_key?scope=exchange_rate

The api_key will be expired by default after 15 days

Details

GET /api/v2/exchange_rate/sbv

This function allows users to get the latest Ngân Hàng Nhà Nước (SBV) exchange rate

Request:

GET /api/v2/exchange_rate/sbv HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "currency": "EUR",
            "buy": 25416.27,
            "sell": 26258.39
        },
        {
            "currency": "USD",
            "buy": 23130.00,
            "sell": 23250.00
        }...
    ]
}
Request Headers:
 
  • Authorization – Bearer <api_key|scope=exchange_rate|permission=0>
Response Headers:
 
Status Codes:
POST /api/v2/exchange_rate/sbv

This function allows data manager to push newest data

Request:

POST /api/v2/exchange_rate/sbv HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 201 Created
Vary: Accept
Request Headers:
 
Request JSON Object:
 
  • post_datas (List[json]) – List of json data with below params
  • currency (string) – currency code (3 chars: VND, USD…)
  • buy (float) – buy
  • sell (float) – sell
Status Codes:
GET /api/v2/exchange_rate/vcb

This function allows users to get the latest Vietcombank (VCB) exchange rate

Request:

GET /api/v2/exchange_rate/vcb HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "currency": "EUR",
            "buy_cash": 25416.27,
            "buy_transfer": 25492.75,
            "sell": 26258.39
        },
        {
            "currency": "USD",
            "buy_cash": 23130.00,
            "buy_transfer": 23130.00,
            "sell": 23250.00
        }...
    ]
}
Request Headers:
 
  • Authorization – Bearer <api_key|scope=exchange_rate|permission=0>
Response Headers:
 
Status Codes:
POST /api/v2/exchange_rate/vcb

This function allows data manager to push newest data

Request:

POST /api/v2/exchange_rate/vcb HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 201 Created
Vary: Accept
Request Headers:
 
Request JSON Object:
 
  • post_datas (List[json]) – List of json data with below params
  • currency (string) – currency code (3 chars: VND, USD…)
  • buy_cash (float) – buy_cash
  • buy_transfer (float) – buy_transfer
  • sell (float) – sell
Status Codes:
GET /api/v2/exchange_rate/ctg

This function allows users to get the latest Vietinbank (CTG) exchange rate

Request:

GET /api/v2/exchange_rate/ctg HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "currency": "EUR",
            "buy_cash": 25416.27,
            "buy_transfer": 25492.75,
            "sell": 26258.39
        },
        {
            "currency": "USD",
            "buy_cash": 23130.00,
            "buy_transfer": 23130.00,
            "sell": 23250.00
        }...
    ]
}
Request Headers:
 
  • Authorization – Bearer <api_key|scope=exchange_rate|permission=0>
Response Headers:
 
Status Codes:
POST /api/v2/exchange_rate/ctg

This function allows data manager to push newest data

Request:

POST /api/v2/exchange_rate/ctg HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 201 Created
Vary: Accept
Request Headers:
 
Request JSON Object:
 
  • post_datas (List[json]) – List of json data with below params
  • currency (string) – currency code (3 chars: VND, USD…)
  • buy_cash (float) – buy_cash
  • buy_transfer (float) – buy_transfer
  • sell (float) – sell
Status Codes:
GET /api/v2/exchange_rate/tcb

This function allows users to get the latest Techcombank (TCB) exchange rate

Request:

GET /api/v2/exchange_rate/tcb HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "currency": "EUR",
            "buy_cash": 25416.27,
            "buy_transfer": 25492.75,
            "sell": 26258.39
        },
        {
            "currency": "USD",
            "buy_cash": 23130.00,
            "buy_transfer": 23130.00,
            "sell": 23250.00
        }...
    ]
}
Request Headers:
 
  • Authorization – Bearer <api_key|scope=exchange_rate|permission=0>
Response Headers:
 
Status Codes:
POST /api/v2/exchange_rate/tcb

This function allows data manager to push newest data

Request:

POST /api/v2/exchange_rate/tcb HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 201 Created
Vary: Accept
Request Headers:
 
Request JSON Object:
 
  • post_datas (List[json]) – List of json data with below params
  • currency (string) – currency code (3 chars: VND, USD…)
  • buy_cash (float) – buy_cash
  • buy_transfer (float) – buy_transfer
  • sell (float) – sell
Status Codes:
GET /api/v2/exchange_rate/bid

This function allows users to get the latest BIDV exchange rate

Request:

GET /api/v2/exchange_rate/bid HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "currency": "EUR",
            "buy_cash": 25416.27,
            "buy_transfer": 25492.75,
            "sell": 26258.39
        },
        {
            "currency": "USD",
            "buy_cash": 23130.00,
            "buy_transfer": 23130.00,
            "sell": 23250.00
        }...
    ]
}
Request Headers:
 
  • Authorization – Bearer <api_key|scope=exchange_rate|permission=0>
Response Headers:
 
Status Codes:
POST /api/v2/exchange_rate/bid

This function allows data manager to push newest data

Request:

POST /api/v2/exchange_rate/bid HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 201 Created
Vary: Accept
Request Headers:
 
Request JSON Object:
 
  • post_datas (List[json]) – List of json data with below params
  • currency (string) – currency code (3 chars: VND, USD…)
  • buy_cash (float) – buy_cash
  • buy_transfer (float) – buy_transfer
  • sell (float) – sell
Status Codes:
GET /api/v2/exchange_rate/stb

This function allows users to get the latest Sacombank (STB) exchange rate

Request:

GET /api/v2/exchange_rate/stb HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "currency": "EUR",
            "buy_cash": 25416.27,
            "buy_transfer": 25492.75,
            "sell": 26258.39
        },
        {
            "currency": "USD",
            "buy_cash": 23130.00,
            "buy_transfer": 23130.00,
            "sell": 23250.00
        }...
    ]
}
Request Headers:
 
  • Authorization – Bearer <api_key|scope=exchange_rate|permission=0>
Response Headers:
 
Status Codes:
POST /api/v2/exchange_rate/stb

This function allows data manager to push newest data

Request:

POST /api/v2/exchange_rate/stb HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 201 Created
Vary: Accept
Request Headers:
 
Request JSON Object:
 
  • post_datas (List[json]) – List of json data with below params
  • currency (string) – currency code (3 chars: VND, USD…)
  • buy_cash (float) – buy_cash
  • buy_transfer (float) – buy_transfer
  • sell (float) – sell
Status Codes:

vBiz API

Quick reference

Resource Operation Description
  1. vBiz
 GET /api/vbiz/search/(string:keyword) Find business by {vbiz_code} or {vbiz_name}
  1. vBiz
 GET /api/vbiz/(string:vbiz_code) Get business details with {vbiz_code}
  1. vBiz
 GET /api/vbiz/cat/(string:vbiz_category_id) Get list business with {vbiz_category_id}

Details

GET /api/vbiz/search/(string: keyword)

This function allows users to search Vietnamese businesses by business tax’s ID or by business name

Request:

GET /api/vbiz/search/{keyword} HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "vbiz_name": "",
            "vbiz_code": ""
        }
    ]
}
Response Headers:
 
Status Codes:
GET /api/vbiz/cat/(string: vbiz_category_id)

This function allows users to get list of Vietnamese business information followed by business category

Request:

GET /api/vbiz/cat/{vbiz_category_id} HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "vbiz_code": "",
            "vbiz_address": "",
            "vbiz_phone": "",
            "vbiz_email": "",
            "vbiz_website": "",
            "vbiz_register_date": ""
        }
    ]
}
Response Headers:
 
Status Codes:
GET /api/vbiz/(string: vbiz_code)

This function allows users to get Vietnamese business information followed by business tax’s ID

Request:

GET /api/vbiz/{vbiz_code} HTTP/1.1
Host: https://vapi.vnappmob.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "results": [
        {
            "vbiz_code": "",
            "vbiz_address": "",
            "vbiz_phone": "",
            "vbiz_email": "",
            "vbiz_website": "",
            "vbiz_register_date": ""
        }
    ]
}
Response Headers:
 
Status Codes:

Indices and tables