원문 key는 환경변수나 secret manager에 저장하고 Git, 브라우저 번들, 공개 로그에 남기지 않습니다.
FINATA API 개발자 문서
계약 고객의 개발자가 인증, endpoint, OpenAPI, 샘플 클라이언트를 빠르게 확인하는 기술 허브입니다.
계약 API key로 첫 호출을 확인합니다
계약 범위 resource를 005930 같은 대표 ticker로 먼저 확인합니다.
X-Quota-Used, X-Quota-Limit, X-RateLimit-Remaining을 운영 로그에 함께 남깁니다.
Bearer token 또는 X-API-Key header를 사용합니다
curl -H "Authorization: Bearer $FINATA_API_KEY" \
"https://finata.co.kr/api/v1/stocks/005930/metrics"
$env:FINATA_API_KEY='finata_live_...'
$headers = @{ Authorization = "Bearer $env:FINATA_API_KEY" }
Invoke-RestMethod `
-Uri "https://finata.co.kr/api/v1/stocks/005930/activism" `
-Headers $headers
node finata_public_api_client.js \
--ticker 005930 \
--resource activism
python finata_public_api_client.py \
--ticker 005930 \
--resource all
계약 key가 필요한 데이터 resource
/api/v1/stocks/{ticker}/metrics
/api/v1/stocks/{ticker}/financials
/api/v1/stocks/{ticker}/ownership
/api/v1/stocks/{ticker}/governance
/api/v1/stocks/{ticker}/activism
/api/risk-radar?resource=scores&ticker={ticker}
| Resource | 용도 | 주요 확인 항목 |
|---|---|---|
| metrics | 종목 핵심 지표와 스코어 | ticker, data 기준일, quota header |
| financials | 연간 재무제표 shard | source_files, 회계연도, 결측 처리 |
| ownership | 최대주주와 지분 구조 | 최종 지배구조, 특수관계인, source_files |
| governance | 이사회, 감사, 의결사항 | 주주 영향 신호, 안건 분류, 데이터 기준일 |
| activism | 행동주의/주주관여 후보 신호 | opportunity_score, target_band, agenda impact |
외부 dependency 없는 샘플 클라이언트
JavaScript 샘플은 Node.js 18+ 내장 fetch를, Python 샘플은 표준 라이브러리 urllib를 사용합니다. 고객사 내부 검증 저장소에서 복사해 바로 실행할 수 있습니다.
API v1과 샘플 변경 이력
Endpoint path는 /api/v1을 기준으로 유지합니다. 응답 필드는 하위 호환을 우선하고, 제거 또는 의미 변경은 계약 고객에게 사전 안내합니다.
명세는 /api/v1/openapi에서 확인합니다. 내부 gateway 검수나 SDK 생성 전 최신 명세를 다시 내려받습니다.
JavaScript/Python 샘플은 dependency-free reference client입니다. 패키지 메타데이터는 private 고객 전달과 내부 registry 준비용입니다.
/developers 문서, OpenAPI 링크, 샘플 클라이언트, 운영 로그 기준을 한 화면에 정리했습니다.
행동주의/주주관여 후보 신호 endpoint와 agenda impact 검토 기준을 문서화했습니다.
Node.js 18+ 내장 fetch와 Python 표준 라이브러리 기반 샘플에 package.json, pyproject.toml, CHANGELOG.md, release guard를 추가했습니다.
운영 로그에 함께 남길 항목
X-Quota-Used와 X-Quota-Limit를 저장해 quota 초과 전에 운영자에게 알립니다.
429 응답이 반복되면 호출 간격, 캐시, 배치 전략을 먼저 점검합니다.
장애 문의에는 key prefix, 요청 시각, endpoint, HTTP status만 공유합니다.
FINATA API는 실시간 시세, 투자자문, 의결권 자문, 매매추천, 법률 판단 서비스를 제공하지 않습니다. 고객 서비스에 노출할 때는 계약 범위와 사용자 고지를 먼저 확인해야 합니다.
API key 발급은 계약 절차 후 진행됩니다
사용 목적, 예상 호출량, 노출 범위, 재배포 여부를 알려주시면 파일럿 조건과 검증 resource를 함께 정리합니다.