TypeScript-based NEIS OPEN API wrapper
π§ Full TypeScript support
π Simple method calls
π Performance stats
π― 12 NEIS endpoints
npm install neis-api.ts
yarn add neis-api.ts
pnpm add neis-api.ts
const neis = new NeisApi({
key: NEIS_API_KEY,
stats: true, // Activate using true
});
// [API Http Stats - Endpoint: schoolInfo | Response Time: 251ms] <-- API call and response time output function- AcaInsTiInfo (νμκ΅μ΅μμ 보)
- ClassInfo (νκΈμ 보)
- ElsTimetable (μ΄λ±νκ΅μκ°ν)
- HisTimetable (κ³ λ±νκ΅μκ°ν)
- MealServiceDietInfo (κΈμμλ¨μ 보)
- MisTimetable (μ€νκ΅μκ°ν)
- SchoolInfo (νκ΅κΈ°λ³Έμ 보)
- SchoolMajorinfo (νκ΅νκ³Όμ 보)
- SchoolSchedule (νμ¬μΌμ )
- SchulAflcoinfo (νκ΅κ³μ΄μ 보)
- SpsTimetable (νΉμνκ΅μκ°ν)
- TiClrminfo (μκ°νκ°μμ€μ 보)
| λ³μλͺ | νμ | λ³μ μ€λͺ | μ€λͺ |
|---|---|---|---|
| key | STRING(νμ) | μΈμ¦ν€ | κΈ°λ³Έκ° : β |
| type | STRING(μ ν) | νΈμΆ λ¬Έμ(xml, json) | κΈ°λ³Έκ° : json |
| pIndex | INTEGER(μ ν) | νμ΄μ§ μμΉ | κΈ°λ³Έκ° : 1 |
| pSize | INTEGER(μ ν) | νμ΄μ§ λΉ μ μ² μ«μ | κΈ°λ³Έκ° : 100 |
| stats | BOOLEAN(μ ν) | API νΈμΆ/μλ΅ μκ° | κΈ°λ³Έκ° : false |
import NeisApi from "neis-api.ts";
const neis = new NeisApi({
key: NEIS_API_KEY,
});
const fetch = async () => {
try {
const response = await neis.getSchoolInfo({
ATPT_OFCDC_SC_CODE: "μλκ΅μ‘μ²μ½λ",
SD_SCHUL_CODE: "νμ νμ€μ½λ",
});
console.log("API response:", response);
} catch (error) {
console.error("Error:", error);
}
};
fetch();