프로젝트의 시작 동기

대한민국에서 최초로 한국투자증권이 REST API 형태로 API를 제공 합니다.

(다른 증권사는 OCX, COM, DLL 등의 방식으로 제공 합니다.)

한국투자증권에서 제공하는 Sample 라이브러리는 Python으로 되어 있는데 이도 완전하지 않습니다.

한국투자증권의 KIS Developers API를 사용할 수 있는 Node.js 라이브러리가 없습니다.

Web에서 한국투자증권의 API를 사용하여

자동매매 서비스를 구현하기 위해서 Node.js 라이브러리가 필요 합니다.

한국투자증권의 KIS Developers API를 사용하는 Node.js 라이브러리를 제작 합니다.

한국투자증권의 KIS Developers API를 사용하여 자동매매를 구현하고자 하는 사용자 대상 입니다.

회의 진행/모임 방식

• 1주일에 1회 정기적으로 회의 합니다.

• Zoom을 사용하여 온라인 회의를 진행 합니다.

그외 자유기재

Node.js를 사용하여 개발할 수 있는 기획자와 개발자를 모집 합니다.

분석/설계 이후 한국투자증권의 KIS Developers API를 사용한 Node.js 라이브러리 제작 작업은 단순한 반복 작업이 될 수 있습니다.

Node.js 경험이 있거나 라이브러리 설계 경험이 있으신 분은 지원해 주세요.

프로젝트 범위와 단계

1차 완료 목표는 1단계와 2단계 입니다. 현재 2단계 완료 입니다.

• 1단계 - EFriendExpert.xlsx 문서 제작

  • 한국투자증권 KIS Developers API 사이트를 참조하여 Excel 문서 작성

  • 한국투자증권 KIS Developers GitHub 사이트를 참조하여 증권 code 작성

• 2단계 - EFriendExpert 기본 라이브러리 제작

  • 한국투자증권의 각 API에 대응하는 기본 라이브러리 제작

  • Excel 문서로부터 자동 생성되어야 한다.

• 3단계 - EFriendExpert 라이브러리 제작 : Reserved

  • API에 사용에 필요한 편의 기능 제작

  • Sample 프로그램 제작

  • Swagger로 Open API 명세서 제작 (필요시)

• 4단계 - EFriendExpert 라이브러리로 투자 자동화 : Reserved

  • 투자 자동화 지원 기능 제작

  • 증권 데이터 수집

  • 시각화 : Trading View 등 참조

  • 투자 정책 발굴과 적용

개발 환경

https://github.com/pnuskgh/EFriendExpert

• • 개발 방법론 : 후보 - Scrum

  • 개발 언어

    • TypeScript

    • JavaScript

  • 테스트

    • Mocha with Chai, Sinon

    • Mocha : Test Framework

    • Chai : Assertion library

    • Sinon : Test double

    • istanbul : Code Coverage

    • Vitest : Unit Test Framework

  • Software (필요시)

    • Nginx

    • Node.js

    • 데이터베이스 : SQLite, MariaDB 또는 MongoDB

    • 캐쉬 : Redis

    • MQTT : Mosquitto

    • OS : CentOS in KT Cloud

    • 알림

      • Email : Google 메일

        • 후보 - Naver 메일, Daum 메일, Nate 메일, Cafe24 메일 등

      • SMS : 알리고

      • Telegram

​

커뮤니케이션

• 카카오톡

  • EFriendExpert 오픈 채팅방

  • EFriendExpert 1:1 채팅방

• Discord

  • 한국투자증권 서버

    • Discord 사용자명을 알려주시면 친구 추가 하겠습니다.

• Zoom: 온라인 미팅

• Notion: EFriendExpert

• GitHub : 소스 관리

• 배포: efriend

• 렛플

  • 한국투자증권 Node.js 라이브러리

• 한국투자증권 Node.js 라이브러리 홈페이지

  • Vercel

Code Convention

• ESLint 사용

• Prettier 사용

​

Git Convention

• 형상 관리를 위한 branch 전략

  • master : 제품으로 출시될 수 있는 브랜치

  • develop : 다음 출시 버전을 개발하는 브랜치

  • feature : 기능을 개발하는 브랜치

  • release : 이번 출시 버전을 준비하는 브랜치

  • hotfix : 출시 버전에서 발생한 버그를 수정 하는 브랜치

• Merge Request > 동료 Review > Merge

• Commit message 규칙

  • [Type] commit message

  • type

    • feature : 새로운 기능 추가

    • fix : 버그 수정

    • docs : 문서 업데이트

    • style : frontend의 style 수정

    • refactor : 코드의 리팩토링

    • test : 테스트코드 업데이트

    • env : 환경 구축

작업 단계와 계획

​

• 1단계 - EFriendExpert.xlsx 문서 제작 : 1차 완료

  • EFriendExpert.xlsx 문서 작성

    • 한국투자증권의 KIS Developers API 내용을 Excel로 재작성한 파일

• 2단계 - EFriendExpert 기본 라이브러리 제작 : 1차 완료

  • EFriendExpert.xlsx 파일로 JSON 객체 제작

    • exceljs Package 추천 : Excel 읽기

    • decompress Package 추천 : zip 파일 압축 해제

    • iconv-lite Package 추천 : 문자셋 변경 (UTF-8, EUC-KR)

  • JSON 객체로 한국투자증권용 API를 생성

    • node-fetch Package 추천 : REST API

    • ws Package 추천 : WebSocket

    • crypto Package 추천 : 암복호화

    • uuid Package 추천 : GUID 생성

    • ejs Package 추천 : 템플릿 엔진

      • pug

      • nunjucks

  • 테스트 프로그램

    • vitest

  • Logger

    • winston

    • winston-daily-rotate-file

  • 사용자와 인증 정보 관리

    • Users : 사용자

      • approval_key : 실시간 접속키

    • Secrets : 한국투자증권 계정

    • Tokens : 접근 토큰

    • API Limit 관리

    • Limits : 한국투자증권 사용 제한

  • 홈페이지 : http://efriendexpert.com/

  • Node.js 라이브러리로 배포

• 3단계 - EFriendExpert 라이브러리 제작 : Reserved (협의후 확정 필요)

  • Sample Application 제작

    • Desktop Application : TypeScript를 사용하여 제작

    • Web Application : https://service.efriendexpert.com/

      • tensorflow.js : 인공지능(AI) 적용

  • Cluster 관리

  • 정산 관리

  • Statistics : API 사용 통계 (필요시)

  • History : API 사용 history

  • HTTPS로 제공되는 서비스

    • Cloud 서버

    • 도메인, 공인 IP, 서버 인증서

  • 문서화 (협의후 확정 필요)

    • Markdown

    • Swagger

      • swagger-ui-express Package 추천

    • JSDoc

• 4단계 - EFriendExpert 라이브러리로 투자 자동화 : Reserved (협의후 확정 필요)

  • 증권 데이터 수집 기능 제작

  • 시각화

    • Trading View

    • AnyChart

  • 투자 자동화 지원 기능 제작

  • 투자 정책 발굴과 적용

  • tensorflow.js

    • Download

      • GitHub

    • Guide

    • tensorflow.js 데모

    • tensorflow의 사전 훈련된 모델

    • Backends

      • CPU, WebGL, WebGPU, Node, React Native

      • WASM: WebAssembly backend