API Specifications

This section describes the usage and specifications of the API

Quick Start Guide

We have a quick start guide for J-Quants API using Google Colaboratory. Please try it from the "Open in Colab" link below.

Important Notes

Please refer to the following page.

pageImportant Notes

How to read API documentation

Please refer to the following page.

pageHow to Read API Specifications

About each API

Access Key Related API (/token)

pageRefresh Token (/token/auth_user)pageID Token (/token/auth_refresh)

Stock Information Related API (/listed)

pageListed Issue Information (/listed/info)

Stock Price Related API (/prices)

pageStock Prices (OHLC)(/prices/daily_quotes)pageMorning Session Stock Prices(OHLC) (/prices/prices_am)

Market Information Related API (/markets)

pageTrading by Type of Investors (/markets/trades_spec)pageMargin Trading Outstandings (/markets/weekly_margin_interest)pageShort Sale Value and Ratio by Sector (/markets/short_selling)pageBreakdown Trading Data　(/markets/breakdown)

TOPIX Prices Related API (/indices)

pageTOPIX Prices (OHLC) (/indices/topix)

Financial Data Related API (/fins)

pageFinancial Data (/fins/statements)pageFinancial Statement Data(BS/PL) (/fins/fs_details)pageCash Dividend Data (/fins/dividend)pageEarnings Calendar (/fins/announcement)

Index Option Prices Related API (/option)

pageIndex Option Prices(OHLC)(/option/index_option)