Files
KissMe/README.md
2023-05-27 08:20:56 +09:00

64 lines
2.3 KiB
Markdown

# About KissMe
KissMe 는 KIS API 를 연동한 swift 라이브러리입니다.
# KissMeConsole
KissMeConsole 은 command line 에서 인터렉티브 명령어로 API 호출을 테스트해볼 수 있는 도구입니다.
KissMeConsole 에서 유효한 command line 명령어는 다음과 같습니다.
## command list
command | 설명
------- | ---
`quit` | 종료
`login mock` | Mock 서버로 로그인. mock-server.json 을 credential 로 사용.
`login real` | Real 서버로 로그인. real-server.json 을 credential 로 사용.
`logout` | 접속한 서버에서 로그아웃
`top` | 상위 거래량 30종목 (평균거래량)
WIP `buy (ISCD) (수량)` | 구매
WIP `sell (ISCD) (수량)` | 판매
WIP `cancel (ISCD)` | 주문 취소
`open bag` | 보유 종목 열람
`load shop` | data/shop-products.csv 로부터 전체 상품을 로딩
`update shop` | **금융위원회_KRX상장종목정보** 로부터 전체 상품을 얻어서 data/shop-products.csv 로 저장
`look (상품명)` | (상품명) 에 해당되는 ISCD 를 표시함
WIP `showcase` | 추천 상품을 제안함
`loves` | 관심 종목 전체를 열람. profile.json 에 저장된 관심 종목을 표시함.
`love (탭).(번호) (ISCD)` | 관심 종목에 추가함. (번호) 를 지정하지 않으면 (탭) 마지막에 추가함.
`hate (탭) (ISCD)` | 관심 종목에서 삭제함.
# KissCredential
KissCredential 에서 사용하는 json 의 양식은 다음과 같습니다.
### mock-server.json, real-server.json
```json
{
"isMock": false,
"accountNo": "12345678-90",
"appKey": "xxxxxxxxxxx",
"appSecret": "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
}
```
* `isMock` 값이 `true` 이면 모의서버, `false` 이면 실전서버를 의미합니다.
* `accountNo` 에는 계좌번호를 의미합니다. 8-2 형태의 숫자로 입력합니다.
* `appKey` 는 한국투자증권 홈페이지에서 발급받은 appkey 입니다.
* `appSecret` 는 한국투자증권 홈페이지에서 발급받은 appsecret 입니다.
### shop-server.json
```json
{
"openApiKey": "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
}
```
* `openApiKey` 는 [data.go.kr](https://www.data.go.kr/) 에서 발급받은 API 인증키입니다.
* 다음의 Open API 활용신청을 합니다.
* [금융위원회_KRX상장종목정보](https://www.data.go.kr/tcs/dss/selectApiDataDetailView.do?publicDataPk=15094775)