주식회사빅트리 오픈 API 사용설명서 코스콤오픈 API 플랫폼
내용 1. 종목분석 API... 2 개요... 2 Syntax... 2 2. 유형별포트폴리오추천 API... 6 개요... 6 Syntax... 6 3. 투자자성향조사 API... 9 개요... 9 3.1. 성향조사설문리스트... 9 Syntax... 9 3.2. 성향조사결과요청... 11 Syntax... 11 3.3. 자체성향설문조사... 13 Syntax... 13 4. 포트폴리오평가 API... 15 개요... 15 Syntax... 15 5. 자산배분 API... 18 개요... 18 Syntax... 18 [ 별첨 ]... 22 1. 포트폴리오유형... 22 2. WICS 분류... 22
1. 종목분석 API 개요 사용자가요청한주식종목을 BIGBOT 의로직으로분석해결과를제공합니다. 사용예시 - https://www.bigbot.kr/analysis 종목분석페이지 Syntax URI https://sandbox-apigw.koscom.co.kr/v1/bigbot/stock_analyzer/?code=[stock_code] [STOCK_CODE]: 주식단축코드숫자 6자리 금융업종은투자대상에서제외시킴으로분석되지않습니다. HTTP methods GET Format JSON <application/json: charset=utf-8> Content-Type application/json
Response Body Property Type Description query_stock_info 요청한종목정보 wics_name String WICS 기준업종명 ( 별첨 2 참조 ) stock_name String 종목이름 stock_code String 종목코드 result query_stock 종목분석결과 요청한종목정보 stock_name String 종목이름 stock_code String 종목코드 reference_date Date 기준일자 (YYYY-MM-DD) reference_quarter String 기준분기 finance Float 요청한종목의업종의재무효율성을정규화해서표현 ( 범위 -1~1) price_merit Float 요청한종목의업종의가격메리트를정규화해서표현 ( 범위 -1~1) finance_best 요청한종목의업종에서재무효율성이가장높은종목 stock_name String 종목이름 stock_code String 종목코드 reference_date Date 기준일자 (YYYY-MM-DD) reference_quarter String 기준분기 finance Float 요청한종목의업종의재무효율성을정규화해서표현 ( 범위 -1~1) price_merit Float 요청한종목의업종의가격메리트를정규화해서표현 ( 범위 -1~1) pm_best 요청한종목의업종에서가격메리트가가장높은종목 stock_name String 종목이름 stock_code String 종목코드 reference_date Date 기준일자 (YYYY-MM-DD) reference_quarter String 기준분기 finance Float 요청한종목의업종의재무효율성을정규화해서표현 ( 범위 -1~1) price_merit Float 요청한종목의업종의가격메리트를정규화해서표현 ( 범위 -1~1) similar_stocks List 요청한종목의업종에속하는종목들 stock_name String 종목이름 stock_code String 종목코드 reference_date Date 기준일자 (YYYY-MM-DD) reference_quarter String 기준분기 finance Float 요청한종목의업종의재무효율성을정규화해서표현 ( 범위 -1~1) price_merit Float 요청한종목의업종의가격메리트를정규화해서표현 ( 범위 -1~1)
Response Body Example "query_stock_info": "stock_name": "KR 모터스 ", "stock_code": "000040", "wics_name": " 자동차 " "result": "query_stock": "reference_date": "2017-06-28", "reference_quarter": "2017-1Q", "stock_name": "KR 모터스 ", "stock_code": "000040", "finance": -0.0529, "price_merit": -0.4775 "pm_best": "reference_date": "2017-06-28", "reference_quarter": "2017-1Q", "stock_name": " 기아차 ", "stock_code": "000270", "finance": 0.0819, "price_merit": 0.5952 "finance_best": "reference_date": "2017-06-28", "reference_quarter": "2017-1Q", "stock_name": " 기아차 ", "stock_code": "000270", "finance": 0.0819, "price_merit": 0.5952 "similar_stocks": [ "stock_name": " 기아차 ", "stock_code": "000270", "reference_date": "2017-06-28", "reference_quarter": "2017-1Q", "finance": 0.0819, "price_merit": 0.5952 "stock_name": " 코라오홀딩스 ", "stock_code": "900140", "reference_date": "2017-06-28", "reference_quarter": "2017-1Q", "finance": 0.0651, "price_merit": 0.3774 "stock_name": " 현대차 ", "stock_code": "005380", "reference_date": "2017-06-28", "reference_quarter": "2017-1Q", "finance": 0.0699, "price_merit": 0.3791 "stock_name": " 쌍용차 ", "stock_code": "003620", "reference_date": "2017-06-28",
] "reference_quarter": "2017-1Q", "finance": 0.0268, "price_merit": -0.0665 "stock_name": " 광림 ", "stock_code": "014200", "reference_date": "2017-06-28", "reference_quarter": "2017-1Q", "finance": -0.0311, "price_merit": -0.4664
2. 유형별포트폴리오추천 API 개요 조회일기준 BIGBOT의로직에의해선정된종목들을유형에따라포트폴리오를구성하여제공합니다. 사용예시 - BIGBOT 포트폴리오운용화면 Syntax URI https://sandbox-apigw.koscom.co.kr/v1/bigbot/ranked_stock_indicators/?type=[portfolio_type] [PORTFOLIO_TYPE]: 포트폴리오유형 ( 별첨 1 참조 ) 1: 안정형 2: 준안정형 3: 표준형 4: 준적극형 5: 적극형
HTTP methods GET Format JSON <application/json: charset=utf-8> Content-Type application/json Response Body Property Type Description reference_date Date 기준일자 (YYYY-MM-DD) reference_quarter String 기준분기 stock_code String 종목이름 stock_name String 종목코드 wics_name Date wics 기준업종분류코드 ( 별첨 2 참조 ) total_market_value String 시가총액 rank Int 종목의순위 price_grade String 가격매력도등급 finance_grade String 재무효율성등급 Response Body Example [ "reference_date": "2017-06-28", "reference_quarter": "2017-1Q", "stock_code": "045100", "stock_name": " 한양이엔지 ", "wics_name": " 건설 ", "total_market_value": 2214, "rank": 1, "price_grade": "A", "finance_grade": "A" "reference_date": "2017-06-28", "reference_quarter": "2017-1Q", "stock_code": "011370", "stock_name": " 서한 ", "wics_name": " 건설 ", "total_market_value": 2547.6, "rank": 2, "price_grade": "A", "finance_grade": "A"
~~ 중략 ~~ ] "reference_date": "2017-06-28", "reference_quarter": "2017-1Q", "stock_code": "017890", "stock_name": " 한국알콜 ", "wics_name": " 화학 ", "total_market_value": 1871.06, "rank": 19, "price_grade": "A", "finance_grade": "A" "reference_date": "2017-06-28", "reference_quarter": "2017-1Q", "stock_code": "008470", "stock_name": " 부스타 ", "wics_name": " 기계 ", "total_market_value": 564.8, "rank": 20, "price_grade": "A", "finance_grade": "A"
3. 투자자성향조사 API 개요 BIGBOT에서제공하는설문을통해투자자의성향을조사해적합한포트폴리오유형을제공합니다. 사용예시 - BIGBOT 포트폴리오운용화면 3.1. 성향조사설문리스트 - 성향조사에필요한설문리스트를제공합니다. Syntax URI https://sandbox-apigw.koscom.co.kr/v1/bigbot/investor_survey_list/ HTTP methods GET Format JSON <application/json: charset=utf-8>
Content-Type application/json Response Body Property Type Description survey_list 성향조사설문리스트 투자금 String 성향조사설문 투자목적 String 성향조사설문 소득현황 String 성향조사설문 나이 String 성향조사설문 투자경험 String 성향조사설문 ( 중복선택가능 ) 최대손실경험 String 성향조사설문 최대손실경험대응 String 성향조사설문 투자지식 String 성향조사설문 선호상품 String 성향조사설문 Response Body Example "survey_list": " 나이 ": "1": "20 세미만 ", "2": "20 대 ", "3": "30 대 ", "4": "40 대 ", "5": "50 대이상 " " 최대손실경험대응 ": "1": " 주가하락할것같아모두처분했다 ", "2": " 보유주식일부를처분했다 ", "3": " 그대로유지했다 ", "4": " 주가가곧회복될것으로기대하고주식을추가취득했다 " " 투자목적 ": "1": " 단기자금운용 ", "2": " 목적자금 ( 학자금, 결혼, 노후대비등 )", "3": " 적극적재산증식 " " 투자지식 ": "1": " 투자의사결정에전문가또는지인의도움을받음 ", "2": " 예금 / 적금과금융투자상품 ( 주식, 채권, 펀드 ) 간의차이점을알고있음 ", "3": " 금융투자상품의위험에대해잘알고있음 ", "4": " 파생상품을포함한금융투자상품의위험에대해잘알고있음 " " 투자금 ": "1": "1000 만원이하 ", "2": "5000 만원이하 ",
예상 " "3": "1 억원이하 ", "4": "3 억원이상 ", "5": "3 억원이상 " " 투자경험 ": "1": " 투자경험없음 ", "2": " 채권 ", "3": " 주식 ", "4": " 펀드 ", "5": "ETF/ETN", "6": "ELS/ELW", "7": " 선물 / 옵션 " " 소득현황 ": "1": " 현재일정한수입이있으나, 향후매우불안정할것으로예상 ", "2": " 현재일정한수입이발생하고있으나, 향후감소할것으로예상 ", "3": " 현재일정한수입이발생하고있으며, 향후에도현재수준을유지하거나증가할것으로 " 최대손실경험해당사항 ": "1": " 없음 ", "2": "-10% 대 ", "3": "-20% 대 ", "4": "-30% 대 ", "5": "-40% 대 ", "6": "-50% 이상 " " 선호상품 ": "1": " 연간기대수익률 +10.0% 수준 ( 월간최대수익률 +5.7% 최대손실률 -3.0%)", "2": " 연간기대수익률 +12.5% 수준 ( 월간최대수익률 +7.5% 최대손실률 -4.1%)", "3": " 연간기대수익률 +15.0% 수준 ( 월간최대수익률 +10.0% 최대손실률 -7.7%)", "4": " 연간기대수익률 +20.0% 이상 ( 월간최대수익률 +12.6% 최대손실률 -9.6%)" 3.2. 성향조사결과요청 - 설문결과를받아적합한포트폴리오유형을제공합니다. Syntax URI https://sandbox-apigw.koscom.co.kr/v1/bigbot/investor_survey_result/ HTTP methods POST Format JSON <application/json: charset=utf-8>
Content-Type application/json Request Body Property Type Description survey_result 성향조사답변리스트 투자금 String 성향조사답변 투자목적 String 성향조사답변 소득현황 String 성향조사답변 나이 String 성향조사답변 투자경험 List 성향조사답변 ( 중복선택가능 ) 최대손실경험 String 성향조사답변 최대손실경험대응 String 성향조사답변 투자지식 String 성향조사답변 선호상품 String 성향조사답변 Response Body Property Type Description result_score Integer 응답결과점수 portfolio_type String 포트폴리오타입 portfolio_name String 포트폴리오이름 Request Body Example "survey_result": " 투자금 ":"3", " 투자목적 ": "2", " 소득현황 ": "2", " 나이 ": "1", " 투자경험 ": ["3","4","5"], " 최대손실경험해당사항 ": "2", " 최대손실경험대응 ": "2", " 투자지식 ": "2", " 선호상품 ": "3" Response Body Example
"result_score": 48, "portfolio_type": "3", "portfolio_name": " 표준형 " 3.3. 자체성향설문조사 - 증권사등오픈 API 플랫폼사용주체가자체투자자성향설문조사양식을사용하고있을경우투자자의응답결과점수와자체성향조사총점수를받아 BIGBOT의적합한포트폴리오를제공합니다. Syntax URI https://sandbox-apigw.koscom.co.kr/v1/bigbot/investor_info/ HTTP methods POST Format JSON <application/json: charset=utf-8> Content-Type application/json Request Body Property Type Description score Integer 투자자응답결과점수 total_score Integer 성향설문조사총점수 Response Body Property Type Description portfolio_name String 포트폴리오명 portfolio_type String 포트폴리오타입 convert_score Integer 환산점수 Request Body Example
"score": 24, "total_score": 32 Response Body Example "portfolio_name": " 준적극형 ", "portfolio_type": "4", "convert_score": 75
4. 포트폴리오평가 API 개요 사용자가요청한종목들을 BIGBOT의로직에의해평가해포트폴리오에서종목의편출여부를제공합니다. 사용예시 - BIGBOT 포트폴리오평가화면 Syntax URI https://sandbox-apigw.koscom.co.kr/v1/bigbot/evaluate/ HTTP methods POST Format JSON <application/json: charset=utf-8> Content-Type application/json Request Body Property Type Description portfolio_type String 포트폴리오유형 ( 별첨 1 참조 ) stocks 포트폴리오평가요청종목리스트 stock_code String 종목코드 stock_name String 종목이름
profit_ratio Float 종목수익률 Response Body Property Type Description portfolio_type String 포트폴리오유형 stocks 포트폴리오평가결과종목리스트 stock_code String 종목코드 stock_name String 종목이름 profit_ratio Float 종목수익률 remove_suggested Boolean 포트폴리오편출여부 remove_suggested_description Float 편출사유 Request Body Example "portfolio_type": "1", "stocks": [ "stock_code": "000020", "stock_name": " 동화약품 ", "profit_ratio": -0.12 "stock_code": "005850", "stock_name": " 에스엘 ", "profit_ratio": 0.07 "stock_code": "000040", "stock_name": "KR 모터스 ", "profit_ratio": -0.05 "stock_code": "008470", "stock_name": " 부스타 ", "profit_ratio": 0.10 "stock_code": "120030", "stock_name": " 조선선재 ", "profit_ratio": 0.31 ] Response Body Example "portfolio_type": "1", "stocks": [ "remove_suggested": false, "remove_suggested_description": "",
] "stock_code": "000020", "stock_name": " 동화약품 ", "profit_ratio": -0.12 "remove_suggested": false, "remove_suggested_description": "", "stock_code": "005850", "stock_name": " 에스엘 ", "profit_ratio": 0.07 "remove_suggested": true, "remove_suggested_description": " 단기재무효율성하락 ", "stock_code": "000040", "stock_name": "KR 모터스 ", "profit_ratio": -0.05 "remove_suggested": false, "remove_suggested_description": "", "stock_code": "008470", "stock_name": " 부스타 ", "profit_ratio": 0.1 "remove_suggested": true, "remove_suggested_description": " 가격매력도하락 ", "stock_code": "120030", "stock_name": " 조선선재 ", "profit_ratio": 0.31
5. 자산배분 API 개요 사용자가요청한종목들을 BIGBOT 의로직에의해자산을배분합니다. 사용예시 - BIGBOT 포트폴리오자산배분화면 Syntax URI https://sandbox-apigw.koscom.co.kr/v1/bigbot/distribution_property/ HTTP methods POST Format JSON <application/json: charset=utf-8> Content-Type application/json Request Body Property Type Description
total_asset Integer 총자산 stock_postion Float 주식편입비중 (0~1), 0.8 의경우총자산의 80% 주식매입 distribute_type String 자산배분방식 (0: 가치가중, 1: 동일가중 ) stocks List 자산배분요청종목리스트 holding_amount Integer 보유주식수량 stock_code String 종목코드 stock_name String 종목이름 Response Body Property Type Description stock_postion String 주식편입비중 (0~1) invest_amount String 투자금 stocks 자산배분결과 stock_code String 종목코드 stock_name String 종목이름 holding_amount Integer 보유주식수량 holding_valuation String 보유주식평가금 holding_ratio String 보유주식포트폴리오비중 new_amount Integer 자산배분후수량 new_valuation String 자산배분후평가금 new_ratio String 자산배분후포트폴리오비중 distributed_cash String 종목배분금 stock_price String 종목현재가 Request Body Example "total_asset": 30000000, "stock_position": 1, "distribute_type": "0", "stocks": [ "holding_amount": 10, "stock_code": "000640", "stock_name": " 동아쏘시오홀딩스 " "holding_amount": 40, "stock_code": "000880", "stock_name": " 한화 "
"holding_amount": 15, "stock_code": "002170", "stock_name": " 삼양통상 " ~~ 중략 ~~ ] "holding_amount": 14, "stock_code": "005850", "stock_name": " 에스엘 " "holding_amount": 13, "stock_code": "006650", "stock_name": " 대한유화 " "holding_amount": 11, "stock_code": "010960", "stock_name": " 삼호개발 " Response Body Example "stock_position": 1, "invest_amount": 30000000, "stocks": [ "holding_valuation": 1250000, "stock_price": 125000, "stock_code": "000640", "holding_amount": 10, "new_ratio": 0.0167, "stock_name": " 동아쏘시오홀딩스 ", "distributed_cash": 563115, "new_stock_valuation": 500000, "new_amount": 4, "holding_ratio": 0.0417 "holding_valuation": 1914000, "stock_price": 47850, "stock_code": "000880", "holding_amount": 40, "new_ratio": 0.0207, "stock_name": " 한화 ", "distributed_cash": 631021, "new_stock_valuation": 622050, "new_amount": 13, "holding_ratio": 0.0638 "holding_valuation": 750000, "stock_price": 50000, "stock_code": "002170", "holding_amount": 15, "new_ratio": 0.0283,
"stock_name": " 삼양통상 ", "distributed_cash": 858352, "new_stock_valuation": 850000, "new_amount": 17, "holding_ratio": 0.025 ~~ 중략 ~~ ] "holding_valuation": 291200, "stock_price": 20800, "stock_code": "005850", "holding_amount": 14, "new_ratio": 0.0222, "stock_name": " 에스엘 ", "distributed_cash": 674672, "new_stock_valuation": 665600, "new_amount": 32, "holding_ratio": 0.0097 "holding_valuation": 3126500, "stock_price": 240500, "stock_code": "006650", "holding_amount": 13, "new_ratio": 0.024, "stock_name": " 대한유화 ", "distributed_cash": 738337, "new_stock_valuation": 721500, "new_amount": 3, "holding_ratio": 0.1042 "holding_valuation": 55110, "stock_price": 5010, "stock_code": "010960", "holding_amount": 11, "new_ratio": 0.069, "stock_name": " 삼호개발 ", "distributed_cash": 2069654, "new_stock_valuation": 2069130, "new_amount": 413, "holding_ratio": 0.0018
[ 별첨 ] 1. 포트폴리오유형 - 1. 안정형 : 수익과위험을고려하여안정적으로운용합니다. 종목구성 : 주식 30종목, 채권형 ETF 1종목 투자대상 : 주식시가총액 1000억원이상, 채권형 ETF - 2. 준안정형 : 안정형보다채권비중을낮추고주식비중은높여운용합니다. 종목구성 : 주식 30종목, 채권형 ETF 1종목 투자대상 : 주식시가총액 1000억원이상, 채권형 ETF - 3. 표준형 : 주식을위주로투자하는투자자를대상으로합니다. 종목구성 : 주식 30종목 투자대상 : 주식시가총액 1000억원이상 - 4. 준적극형 : 주식을위주로투자하는투자자를대상으로합니다. 종목구성 : 주식 30종목 투자대상 : 주식시가총액 500억원이상 - 5. 적극형 : 고수익을목표로가장공격적으로투자하는투자자를대상으로합니다. 종목구성 : 주식 20종목 투자대상 : 주식시가총액 250억원이상 2. WICS 분류 - BIGBOT 에서는업종분류를 WISEfn 에서사용하는 Sector 분류기준인 WICS 으로했습니다. - 분류코드상세 분류코드 101010 에너지장비및서비스 101020 석유와가스 151010 화학 WICS 소분류
151030 포장재 151040 비철금속 151050 철강 151060 종이와목재 201010 우주항공과국방 201020 건축제품 201025 건축자재 201030 건설 201035 가구 201040 전기장비 201050 복합기업 201060 기계 201065 조선 201070 무역회사와판매업체 202010 상업서비스와공급품 203010 항공화물운송과물류 203020 항공사 203030 해운사 203040 도로와철도운송 203050 운송인프라 251010 자동차부품 251020 자동차 252040 가정용기기와용품 252050 레저용장비와제품 252060 섬유, 의류, 신발, 호화품 252065 화장품 252070 문구류 253010 호텔, 레스토랑, 레저 253020 다각화된소비자서비스 254010 광고 254020 방송과엔터테인먼트 254030 출판
255010 판매업체 255020 인터넷과카탈로그소매 255030 백화점과일반상점 255040 전문소매 256010 교육서비스 301010 식품과기본식료품소매 302010 음료 302020 식품 302030 담배 303010 가정용품 351010 건강관리장비와용품 351020 건강관리업체및서비스 351030 건강관리기술 352010 생물공학 352020 제약 352030 생명과학도구및서비스 401010 은행 402010 증권 403020 창업투자 403030 카드 403040 기타금융 404010 손해보험 404020 생명보험 405020 부동산 405510 신용평가서비스 405520 결제관련서비스 451010 인터넷소프트웨어와서비스 451020 IT 서비스 451030 소프트웨어 451035 게임소프트웨어와서비스 452010 통신장비 452015 핸드셋
452020 컴퓨터와주변기기 452030 전자장비와기기 452040 사무용전자제품 453010 반도체와반도체장비 453510 전자제품 453520 전기제품 454010 디스플레이패널 454020 디스플레이장비및부품 501010 다각화된통신서비스 501020 무선통신서비스 551010 전기유틸리티 551020 가스유틸리티 551030 복합유틸리티 551040 수도유틸리티 551050 독립전력생산및에너지거래