본문 바로가기
PHP/PHP

[polygon.io API] 종목 관련 데이터 및 배당금 API 소개

by 집탱구리 2023. 4. 15.
반응형

polygon.io API소개

 

Daily Open/Close

Daily Open/Close API는 주식 종목의 특정 날짜의 시가(open), 종가(close), 고가(high), 저가(low) 등의 데이터를 반환합니다. 이 API를 사용하여 해당 날짜의 주식 가격 정보를 얻을 수 있습니다.

https://api.polygon.io/v1/open-close/{ticker}/{date}

위 엔드포인트에서 {ticker}는 종목 심볼을 의미합니다. {date}에는 날짜를 입력합니다.

예를 들어 Apple(AAPL)의 전일 종가를 가져오려면 다음과 같이 API를 호출합니다.

https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/2022-04-08/2022-04-08?unadjusted=false&apiKey=<your-api-key>

 

API의 요청 매개변수는 다음과 같습니다.

매개변수 설명
apiKey API 키
symbol 종목 심볼.
date YYYY-MM-DD 형식의 날짜 문자열.
unadjusted true로 설정하면 분할, 배당 등에 대한 보정을 수행하지 않은 데이터를 반환합니다.
false(기본값)로 설정하면 보정된 데이터를 반환합니다.

 

응답 데이터는 다음과 같습니다.

{
    "status": "OK",
    "from": "2023-01-09",
    "symbol": "AAPL",
    "open": 130.465,
    "high": 133.41,
    "low": 129.89,
    "close": 130.15,
    "volume": 70790813,
    "afterHours": 129.85,
    "preMarket": 129.6
}

 

응답 데이터는 다음과 같은 항목으로 구성됩니다.

데이터 항목 설명
symbol 종목 심볼
date YYYY-MM-DD 형식의 날짜.
open 거래일 시장 개장 시 최초 거래 가격.
high 거래일 중 거래 가격 중 가장 높은 가격.
low 거래일 중 거래 가격 중 가장 낮은 가격.
close 거래일 시장 마감 시 가격.
volume 거래량.
openTime 거래일 시장 개장 시각 (Unix 타임스탬프).
closeTime 거래일 시장 마감 시각 (Unix 타임스탬프).

 

Previous Close

특정 종목의 전일 종가 데이터를 제공합니다. 이 API를 사용하여 특정 종목의 전일 종가를 가져올 수 있습니다.

https://api.polygon.io/v2/aggs/ticker/{ticker}/prev

위 엔드포인트에서 {ticker}는 종목 심볼을 의미합니다.

예를 들어 Apple(AAPL)의 전일 종가를 가져오려면 다음과 같이 API를 호출합니다.

https://api.polygon.io/v2/aggs/ticker/AAPL/prev?adjusted=true&apiKey=<your-api-key>

 

이 API의 요청 매개변수는 다음과 같습니다.

매개변수 설명
apiKey Polygon.io에서 발급하는 API 키
symbol 종목 심볼.
unadjusted true로 설정하면 수정된 가격이 아닌 조정되지 않은 가격을 반환합니다.
false (기본값) 조정되지 않은 가격 반환

 

응답 데이터는 다음과 같이 구성됩니다.

{
    "ticker": "AAPL",
    "queryCount": 1,
    "resultsCount": 1,
    "adjusted": true,
    "results": [
        {
            "T": "AAPL",
            "v": 50133415,
            "vw": 160.8846,
            "o": 161.22,
            "c": 160.1,
            "h": 162.06,
            "l": 159.78,
            "t": 1681329600000,
            "n": 514267
        }
    ],
    "status": "OK",
    "request_id": "ac988160b3587f94bb629dea174d444f",
    "count": 1
}

 

 

응답 데이터는 다음과 같은 항목으로 구성됩니다.

데이터 항목 설명
ticker 종목 심볼
status API 호출 상태. "OK"는 성공, "ERROR"는 실패
queryCount API 쿼리 수
resultsCount 결과 데이터 수
adjusted 결과 데이터가 수정된 가격인지 여부
results 결과 데이터 배열. 각 요소는 다음과 같은 필드를 포함합니다.
v 거래량
vw 가중평균 가격
o 시가
c 종가
h 고가
l 저가
t 타임스탬프 (밀리초)
n 거래 횟수

위 API를 사용하여 이전 거래일의 종가를 가져와서 투자 전략을 수립하는 등 다양한 용도로 사용할 수 있습니다.

 

 

 

Tickers

Polygon에서 사용 가능한 모든 주식에 대한 정보를 검색할 수 있도록합니다. 이 API를 사용하여 주식, ETF, 채권 등 모든 종목의 정보를 검색할 수 있습니다.

https://api.polygon.io/v3/reference/tickers

다음은 예제 URL입니다.

https://api.polygon.io/v3/reference/tickers?apiKey=<your-api-key>&sort=ticker&type=cs&market=STOCKS&locale=us&perpage=50&page=1&active=true

 

이 API의 요청 매개변수는 다음과 같습니다. 

매개변수 설명
apikey 사용자의 API 키
sort 결과를 정렬할 기준 필드. 'ticker', 'market' 또는 'locale' 선택
type 결과 필터링을 위한 종목 유형. 'etf' 또는 'cs' 선택
market 결과 필터링을 위한 시장. 'stocks', 'indices' 또는 'crypto' 선택
locale 결과 필터링을 위한 지역. 'us' 선택
search ticker를 검색하기 위한 검색어
active 상장 여부 필터링. 'true' 또는 'false' 선택
perpage 페이지 당 결과 수. 최대 50 개까지 가능
page 요청할 페이지 번호
exchange 결과 필터링을 위한 거래소 선택
currency 결과 필터링을 위한 화폐 선택
marketcap 시가총액 필터링. 'mega', 'large', 'mid', 'small' 또는 'micro' 선택
volume 거래량 필터링. 'over', 'under' 또는 'none' 선택
percentchange 전일 대비 등락률 필터링. 'gte', 'lte', 'gt', 'lt' 선택 가능
lastsale 최근 체결가 필터링. 'gte', 'lte', 'gt', 'lt' 선택 가능
ipoyear IPO 연도 필터링. 'year', 'none' 선택 가능
netsharepurchaseactivity 최근 주식 순매수 필터링. 'net', 'buy' 또는 'sell' 선택 가능

 

응답 데이터는 다음과 같이 구성됩니다.

{
    "results": [
        {
            "ticker": "AAPL",
            "name": "Apple Inc.",
            "market": "stocks",
            "locale": "us",
            "primary_exchange": "XNAS",
            "type": "CS",
            "active": true,
            "currency_name": "usd",
            "cik": "0000320193",
            "composite_figi": "BBG000B9XRY4",
            "share_class_figi": "BBG001S5N8V8",
            "last_updated_utc": "2023-04-11T00:00:00Z"
        }
    ],
    "status": "OK",
    "request_id": "d23696b2260e5ebaee0ca3955451f245",
    "count": 1
}

 

응답 데이터는 다음과 같은 항목으로 구성됩니다. 

데이터 항목 설명
ticker 종목 심볼
name 종목 이름
market 거래소
locale 지역
type 종목 유형
currency 화폐
active 상장 여부
primaryExch 기본 거래소
updated 최근 업데이트 일자
url 상세 정보 페이지 URL
score 검색 결과 스코어. 높을수록 높은 순위
lastTrade 최근 체결가
tradeable 거래 가능 여부
marketCap 시가 총액
ADR ADR 정보
bloomberg 블룸버그 심볼
figi FGI ID
cik CIK
lei LEI
sic SIC 코드
country 국가
industry 산업 분류 코드
sector 산업 섹터 코드

 

 

 

Ticker Details v3

특정 ticker의 상세 정보를 제공하는 REST API입니다.

API의 기본 URL은 다음과 같습니다.

https://api.polygon.io/v3/reference/tickers/{ticker}

위 엔드포인트에서 {ticker}는 종목 심볼을 의미합니다.

예를 들어 Apple(AAPL)의 종목 정보를 가져오려면 다음과 같이 API를 호출합니다.

https://api.polygon.io/v3/reference/tickers/AAPL?apiKey=<your-api-key>

 

이 API의 요청 매개변수는 다음과 같습니다. 

매개변수 설명
apikey 사용자의 API 키
sort 결과를 정렬할 기준 필드. 'ticker', 'market' 또는 'locale' 선택
type 결과 필터링을 위한 종목 유형. 'etf' 또는 'cs' 선택
market 결과 필터링을 위한 시장. 'stocks', 'indices' 또는 'crypto' 선택
locale 결과 필터링을 위한 지역. 'us' 선택
search ticker를 검색하기 위한 검색어
active 상장 여부 필터링. 'true' 또는 'false' 선택
perpage 페이지 당 결과 수. 최대 50 개까지 가능
page 요청할 페이지 번호
exchange 결과 필터링을 위한 거래소 선택
currency 결과 필터링을 위한 화폐 선택
marketcap 시가총액 필터링. 'mega', 'large', 'mid', 'small' 또는 'micro' 선택
volume 거래량 필터링. 'over', 'under' 또는 'none' 선택
percentchange 전일 대비 등락률 필터링. 'gte', 'lte', 'gt', 'lt' 선택 가능
lastsale 최근 체결가 필터링. 'gte', 'lte', 'gt', 'lt' 선택 가능
ipoyear IPO 연도 필터링. 'year', 'none' 선택 가능
netsharepurchaseactivity 최근 주식 순매수 필터링. 'net', 'buy' 또는 'sell' 선택 가능

 

응답 데이터는 다음과 같이 구성됩니다.

{
    "results": {
        "ticker": "AAPL",
        "name": "Apple Inc.",
        "market": "stocks",
        "locale": "us",
        "primary_exchange": "XNAS",
        "type": "CS",
        "active": true,
        "currency_name": "usd",
        "cik": "0000320193",
        "composite_figi": "BBG000B9XRY4",
        "share_class_figi": "BBG001S5N8V8",
        "market_cap": 2544168916800,
        "phone_number": "(408) 996-1010",
        "address": {
            "address1": "ONE APPLE PARK WAY",
            "city": "CUPERTINO",
            "state": "CA",
            "postal_code": "95014"
        },
        "description": "Apple designs a wide variety of consumer electronic devices, 
 		including smartphones (iPhone), tablets (iPad), PCs (Mac), 
		smartwatches (Apple Watch),and AirPods. 
		The iPhone makes up most of Apple's total revenue. 
		In addition, Apple offers its customers a variety of services 
		such as Apple Music, iCloud, Apple Care, Apple TV+, Apple Arcade, 
		Apple Fitness, Apple Card, and Apple Pay, among others. 
		Apple's products include internally developed 
		software and semiconductors, and the firm is well known 
		for its integration of hardware, software, semiconductors, and services.
		Apple's products are distributed online as well as through 
		company-owned stores and third-party retailers.
		The company generates roughly 40% of its revenue from the Americas,
		with the remainder earned internationally.",
        "sic_code": "3571",
        "sic_description": "ELECTRONIC COMPUTERS",
        "ticker_root": "AAPL",
        "homepage_url": "<https://www.apple.com>",
        "total_employees": 164000,
        "list_date": "1980-12-12",
        "branding": {
            "logo_url": "<https://api.polygon.io/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2023-04-01_logo.svg>",
            "icon_url": "<https://api.polygon.io/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2023-04-01_icon.jpeg>"
        },
        "share_class_shares_outstanding": 15821950000,
        "weighted_shares_outstanding": 15821946000,
        "round_lot": 100
    },
    "status": "OK"
}

 

응답 데이터는 다음과 같은 항목으로 구성됩니다. 

데이터항목 설명
ticker 종목 심볼
name 종목 이름
market 거래소
locale 지역
type 종목 유형
currency 화폐
active 상장 여부
primaryExch 기본 거래소
updated 최근 업데이트 일자
url 상세 정보 페이지 URL
score 검색 결과 스코어. 높을수록 높은 순위
lastTrade 최근 체결가
tradeable 거래 가능 여부
marketCap 시가 총액
ADR ADR 정보
bloomberg 블룸버그 심볼
figi FGI ID
cik CIK
lei LEI
sic SIC 코드
country 국가
industry 산업 분류 코드
sector 산업 섹터 코드

 

 

Ticker News

즉각적이고 빠르게 업데이트되는 뉴스 정보를 제공합니다. 이 API를 사용하면 주식 시장에서 발생한 최신 뉴스에 대한 전반적인 개요를 얻을 수 있습니다. 뉴스 API에는 폴리곤 데이터베이스와 연결된 다양한 뉴스 출처가 포함되어 있으며, 뉴스 기사와 관련된 시장 데이터도 제공합니다.

API의 기본 URL은 다음과 같습니다.

<https://api.polygon.io/v3/reference/tickers/{ticker}>

위 엔드포인트에서 {ticker}는 종목 심볼을 의미합니다.

예를 들어 Apple(AAPL)의 종목 정보를 가져오려면 다음과 같이 API를 호출합니다.

<https://api.polygon.io/v3/reference/tickers/AAPL?apiKey=>

이 API의 요청 매개변수는 다음과 같습니다.

매개변수 설명
symbol 뉴스가 포함된 티커
limit 표시할 결과 수 제한. 최대 50까지 가능 (기본값: 10)
order 결과를 정렬하는 방법 (recent, popular). 기본값은 recent입니다.

 

응답 데이터는 다음과 같이 구성됩니다.

{
    "results": [
        {
            "ticker": "AAPL",
            "name": "Apple Inc.",
            "market": "stocks",
            "locale": "us",
            "primary_exchange": "XNAS",
            "type": "CS",
            "active": true,
            "currency_name": "usd",
            "cik": "0000320193",
            "composite_figi": "BBG000B9XRY4",
            "share_class_figi": "BBG001S5N8V8",
            "last_updated_utc": "2023-04-11T00:00:00Z"
        }
    ],
    "status": "OK",
    "request_id": "d23696b2260e5ebaee0ca3955451f245",
    "count": 1
}

 

응답 데이터는 다음과 같은 항목으로 구성됩니다.

데이터항목 설명
symbol 뉴스가 포함된 티커
title 뉴스 제목
url 뉴스 URL
source 뉴스 출처
summary 뉴스 요약
image 뉴스 이미지 URL
timestamp 뉴스가 생성된 Unix 타임스탬프
keywords 뉴스의 키워드 (미국 주식시장에 대한 것은 아닙니다.)
related 뉴스 관련
related.cik 미국 증권거래위원회 CIK 번호
related.sic 미국 Standard Industrial Classification Code
related.ticker 관련된 티커
related.CUSIP CUSIP
related.ISIN ISIN
related.Valoren Valoren
related.exchange 상장된 거래소
related.entityName 엔티티 이름
related.entityType 엔티티 타입
related.entityId 엔티티 ID
related.relationship 엔티티와의 관계

 

 

 

Dividends v3

특정 주식에 대한 배당금 정보를 제공합니다. 이 API를 통해 과거 배당금 이력을 확인할 수 있으며, 일정 기간 동안의 배당금 정보를 조회할 수 있습니다.

API의 기본 URL은 다음과 같습니다.

https://api.polygon.io/v3/reference/dividends/{ticker}

위 엔드포인트에서 {ticker}는 종목 심볼을 의미합니다.

예를 들어 Apple(AAPL)의 종목 정보를 가져오려면 다음과 같이 API를 호출합니다.

https://api.polygon.io/v3/reference/dividends?ticker=AAPL&apiKey=<your-api-key>

 

이 API의 요청 매개변수는 다음과 같습니다. 

매개변수 설명
symbol 종목 심볼
perPage 페이지 당 결과 수 (기본값 50, 최대 500)
page 요청 페이지 (기본값 1)
from 시작 일자 (YYYY-MM-DD)
to 종료 일자 (YYYY-MM-DD)

 

응답 데이터는 다음과 같이 구성됩니다.

{
  "count": 3,
  "results": [
    {
      "symbol": "AAPL",
      "exDate": "2021-02-05",
      "paymentDate": "2021-02-11",
      "recordDate": "2021-02-08",
      "declaredDate": "2021-01-27",
      "amount": 0.205,
      "type": "dividend"
    },
    {
      "symbol": "AAPL",
      "exDate": "2021-05-07",
      "paymentDate": "2021-05-13",
      "recordDate": "2021-05-10",
      "declaredDate": "2021-04-28",
      "amount": 0.22,
      "type": "dividend"
    },
    {
      "symbol": "AAPL",
      "exDate": "2021-08-06",
      "paymentDate": "2021-08-12",
      "recordDate": "2021-08-09",
      "declaredDate": "2021-07-27",
      "amount": 0.22,
      "type": "dividend"
    }
  ]
}

 

응답 데이터는 다음과 같은 항목으로 구성됩니다.

데이터 항목 설명
symbol 종목 심볼
exDate 배당락일 (YYYY-MM-DD)
paymentDate 배당금 지급일 (YYYY-MM-DD)
recordDate 배당금 참여 대상 일자 (YYYY-MM-DD)
declaredDate 배당금 공시일 (YYYY-MM-DD)
amount 배당금 금액
type 배당금 종류 (dividend, distribution)
반응형

댓글