vnapis

Vietnam Node APIs Client/Wrapper

Usage no npm install needed!

<script type="module">
  import vnapis from 'https://cdn.skypack.dev/vnapis';
</script>

README

VIETNAM APIS

A Node.js API Wrapper Library for Vietnam APIs.

If you've found an bug/issue, please send me an email.

Installation

npm install vnapis
## OR 
yarn add vnapis

APIs

Administrative Divisions

import { administrativeDivisions } from 'vnapis';
 
// Get Marco Regions
const marcoRegions: Array<any> = await administrativeDivisions.getMarcoRegions();
 
// Get Regions
const regions: Array<any> = await administrativeDivisions.getRegions();
 
// Get Postal Codes
const postalCodes: Array<any> = await administrativeDivisions.getPostalCodes();
 
// Get Provinces
const provinces: Array<any> = await administrativeDivisions.getProvinces();
 
// Get Districts
const province_id: string = 'ha-noi';
const districts: Array<any> = await administrativeDivisions.getDistricts(province_id);
 
// Get Wards
const skip: number = 0;
const limit: number = 100;
const wards: Array<any> = await administrativeDivisions.getWards(skip, limit);

Banks

import { banks } from 'vnapis';

// Get Banks
const _banks: Array<any> = await banks.getBanks();

// Get Forex Rates
const rates: Array<any> = await banks.getForexRates();

// Get Forex Rates By Bank
const id: string = 'vietcombank';
const rates: Array<any> = await banks.getForexRatesByBank(id); // Required - Default is 'vietcombank'

Culture

  • Calendar
import { calendar } from 'vnapis';

// Convert Solar to Lunar Date
const { date, month, year } = await calendar.convertSolarToLunar(8, 8, 2020); // { date: 19, month: 6, year: 2020 }

// Convert Lunar to Solar Date
const { date, month, year } = await calendar.convertLunarToSolar(19, 6, 2020); // { date: 8, month: 8, year: 2020 }

// List of Can
const listOfCan: Array<string> = await calendar.getListOfCan();

// List of Chi
const listOfChi: Array<string> = await calendar.getListOfChi();

// Get Can Chi of Lunar Date - Lunar Month - Lunar Year
const canChi: string = await calendar.getCanChi(19, 6, 2020); // Quý Mùi

// Get Tiet Khi of Lunar Date - Lunar Month - Lunar Year
const tietKhi: string = await calendar.getTietKhi(19, 6, 2020); // Quý Mùi

// Check Solar Leap Year
const isSolarLeapYear = calendar.isSolarLeapYear(2020); // true

// Check Lunar Leap Year
const isLunarLeapYear = calendar.isLunarLeapYear(2020); // true
  • Sports
import { culture } from 'vnapis';
 
// Get Basketball Clubs
const basketballClubs = await sports.getBasketballClubs();
 
// Get Football Clubs
const footballClubs = await sports.getFootballClubs();
 
// Get Futsal Clubs
const futsalClubs = await sports.getFutsalClubs();

Ethnic Minorities

import { ethnicMinorities } from 'vnapis';
 
// Get Ethnic Minorities
const minorities = await ethnicMinorities.getEthnicMinorities();

Finance

import { finance } from 'vnapis';

// Get Listed Companies
const listedCompanies = await finance.getListedCompanies();

Government

import { government } from 'vnapis';

// Get National Assembly Members
const nationalAssemblyMembers = await government.getNationalAssemblyMembers(14); // options: from 1 to 14 - default 14

// Get Ministries
const ministries = await government.getMinistries();

// Get Incumbents
const incumbents = await government.getIncumbents();

// Get General Secretaries
const generalSecretaries = await government.getGeneralSecretaries();

// Get Presidents
const presidents = await government.getPresidents();

// Get Prime Ministers
const primeMinisters = await government.getPrimeMinisters();

// Get National Assembly Chairs
const nationalAssemblyChairs = await government.getNationalAssemblyChairs();

// Get Ethnic Minority Affairs Leaders
const ethnicMinorityAffairsLeaders = await government.getEthnicMinorityAffairsLeaders();

// Get Government Inspectorate Leaders
const governmentInspectorateLeaders = await government.getGovernmentInspectorateLeaders();

// Get Government Office Leaders
const governmentOfficeLeaders = await government.getGovernmentOfficeLeaders();

// Get State Bank Governors
const stateBankGovernors = await government.getStateBankGovernors();

// Get Agriculture and Rural Development Ministers
const ministers = await government.getAgricultureRuralDevelopmentMinisters();

// Get Construction Ministers
const ministers = await government.getConstructionMinisters();

// Get Culture, Sports and Tourism Ministers
const ministers = await government.getCultureSportsTourismMinisters();

// Get Education and Training Ministers
const ministers = await government.getEducationTrainingMinisters();

// Get Finance Leaders
const ministers = await government.getFinanceMinisters();

// Get Foreign Affairs Ministers
const ministers = await government.getForeignAffairsMinisters();

// Get Health Ministers
const ministers = await government.getHealthMinisters();

// Get Home Affairs Ministers
const ministers = await government.getHomeAffairsMinisters();

// Get Industry and Trade Ministers
const ministers = await government.getIndustryTradeMinisters();

// Get Information and Communications Ministers
const ministers = await government.getInformationCommunicationsMinisters();

// Get Justice Ministers
const ministers = await government.getJusticeMinisters();

// Get Labour - Invalids and Social Affairs Leaders
const ministers = await government.getLabourInvalidsSocialAffairsMinisters();

// Get National Defence Ministers
const ministers = await government.getNationalDefenceMinisters();

// Get Natural Resources and Environment Ministers
const ministers = await government.getNaturalResourcesEnvironmentMinisters();

// Get Planning and Investment Ministers
const ministers = await government.getPlanningInvestmentMinisters();

// Get Public Security Ministers
const ministers = await government.getPublicSecurityMinisters();

// Get Science and Technology Leaders
const ministers = await government.getScienceTechnologyMinisters();

// Get Transport Ministers
const ministers = await government.getTransportMinisters();

License Plates

import { licensePlates } from 'vnapis';

// Get License Plates
const plates = await licensePlates.getLicensePlates();

Music

import { music } from 'vnapis';

// Get Artists
const artists = await music.getArtists();

News

import { news } from 'vnapis';

// Get Google Trends
const trends = await news.getGoogleTrends();

// Get Sources
const sources = news.getSources();

// Get Categories
const source = 'vnexpress';
const categories = await news.getCategories(source);

// Get News - Ariticles
const articles = await news.getArticles();
// OR
const source = 'vnexpress';
const category = 'general';
const articles = await news.getArticles(source, category);

Open APIs

import { openAPIs } from 'vnapis';

const apis = await openAPIs.getOpenAPIs();

Phones

import { phones } from 'vnapis';
 
// Get Providers
const providers: Array<any> = await phones.getProviders();
 
// Get Prefixes
const prefixes: Array<any> = await phones.getPrefixes();
 
// Get Provider from Phone Number
const provider: string = await phones.getProviderFromPhoneNumber('0904050607');
// => Mobifone - empty string if cannot find provider

Visas

import { visas } from 'vnapis';
 
// Get Visa Requirements
const visaRequirements = await visas.getVisaRequirements();

VNLTK

import { vnltk } from 'vnapis';

// Convert Number to Text
const text = vnltk.convertNumberToText(1995); // một nghìn chín trăm chín mươi lăm

// Convert Vietnamese into Latin Characters
const result = await vnltk.latinize('Việt Nam'); // Viet Nam

// Get proverbs
const proverbs = vnltk.getProverbs();

// Get names
const names = vnltk.getNames();

// Get first names
const firstNames = vnltk.getFirstNames();

// Get family names
const familyNames = vnltk.getFamilyNames();

// Get stop words
const stopWords = vnltk.getStopWords();

// Get words
const words = vnltk.getWords();

Weather

// Get (Current) Weather
const city: string= 'hanoi';
const currentWeather: Record<string, any> = await weather.getWeather();

// Get Air Visual
const city: string= 'hanoi';
const airVisual = await weather.getAirVisual(city);

// Get Air Visual Cities
const airVisualCities = await weather.getAirVisualCities();

YouTube

import { youTube } from 'vnapis';

// Get Trending
const videos: Array<Record<string, any>> = await youTube.getTrending();

// Get Music Trending
const videos: Array<Record<string, any>> = await youTube.getMusicTrending();

// Get Video Categories
const videoCategories: Array<Record<string, any>> = await youTube.getVideoCategories();

Other Libraries