neis-api.ts

TypeScript-based NEIS OPEN API wrapper

Features

🔧 Full TypeScript support

🚀 Simple method calls

📊 Performance stats

🎯 12 NEIS endpoints

Install

npm install neis-api.ts
yarn add neis-api.ts
pnpm add neis-api.ts

Version 1.7.0 >=

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

Endpoints

• AcaInsTiInfo (학원교습소정보)
• ClassInfo (학급정보)
• ElsTimetable (초등학교시간표)
• HisTimetable (고등학교시간표)
• MealServiceDietInfo (급식식단정보)
• MisTimetable (중학교시간표)
• SchoolInfo (학교기본정보)
• SchoolMajorinfo (학교학과정보)
• SchoolSchedule (학사일정)
• SchulAflcoinfo (학교계열정보)
• SpsTimetable (특수학교시간표)
• TiClrminfo (시간표강의실정보)

Basic Argument

|변수명|타입|변수 설명|설명| |-----|-----|-----|-----| |key|STRING(필수)|인증키|기본값 : ❌| |type|STRING(선택)|호출 문서(xml, json)|기본값 : json| |pIndex|INTEGER(선택)|페이지 위치|기본값 : 1| |pSize|INTEGER(선택)|페이지 당 신청 숫자|기본값 : 100| |stats|BOOLEAN(선택)|API 호출/응답 시간|기본값 : false|

Usage

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();

NEIS API Docs

• https://open.neis.go.kr/portal/mainPage.do