SFTP Specifications

This section describes the usage and specifications of the SFTP

SFTP Connection Configurations

The SFTP connection details are as follows.

Item	Value
host name	sftp-v2.jquants-pro.com
username	username registered with J-Quants Pro
password	password registered with J-Quants Pro
port number	port 22

No need for a private key or public key.

Examples

Here are examples of methods for establishing SFTP connection.

• With SFTP command [Powershell(Windows), terminal(Mac), Linux etc.]

// connect using SFTP commands
sftp -o User=[e-mail] sftp-v2.jquants-pro.com

• If you see the message 'Are you sure you want to continue connecting (yes/no/[fingerprint])?', then please enter 'yes' to proceed.

• You'll receive a password prompt, so go ahead and enter the password you used for your J-Quants for Pro registration.

If you see the message 'Connected to sftp-v2.jquants-pro.com', your connection has been successfully established.

• With SFTP client [WinSCP, Cyberduck etc.]

This is an example using Cyberduck, but the process is similar for other SFTP clients.

From the 'New Connection', input the following details and proceed to connect. (Please enter the username and password you've registered with J-Quants for Pro.)

example of Cyberduck

If you've been authenticated and can view the directory, your connection has been successfully established.

Provided datasets

The following is information about the data that can be obtained through an SFTP connection.

Available data and periods

Data	Data period	Column definition
Listed Issue Information	Begging of Data period to recently	API Specifications >Listed Issue Information >Data Item
Listed Shares Flash Data	Same as above	API Specifications >Listed Shares Flash Data >Data Item
Listed Shares Corporate Action Factors	Same as above	API Specifications >Listed Shares Corporate Action Factors >Data Item
Stock Prices (OHLC)	Same as above	API Specifications >Stock Prices (OHLC) >Data Item
ToSTNeT Super Large Lot	Same as above	API Specifications >ToSTNeT super large lot >Data Item
Trading by Type of Investors	Same as above	API Specifications >Trading by Type of Investors >Data Item
Detail Breakdown Trading Data	Same as above	API Specifications >Breakdown Trading Data >Data Item
Margin Trading Outstandings(Issues Subject to Daily Publication)	Same as above	API Specifications >Margin Trading Outstandings(Issues Subject to Daily Publication) >Data Item
Margin Trading Outstanding (Daily)	Same as above (scheduled to be released on September 28, 2026)	API Specifications >Margin Trading Outstanding (Daily) >Data Item
Margin Trading Outstandings (Weekly)	Same as above	API Specifications >Margin Trading Outstandings (Weekly) >Data Item
Outstanding Short Selling Positions Reported	Same as above	API Specifications >Outstanding Short Selling Positions Reported >Data Item
Financial Data	Same as above	API Specifications >Financial Data >Data Item
Financial Statement Data(BS/PL/CF)	Same as above	API Specifications >Financial Statement Data(BS/PL/CF) >Data Item
Earnings Announcement Dates & Times	Same as above	API Specifications >Earnings Announcement Dates & Times >Data Item
Earnings Announcement Dates	Same as above	API Specifications >Earnings Announcement Dates >Data Item
Derivatives Trading Volume by Participants	Same as above	API Specifications >Derivatives Trading Volume by Participants >Data Item
Open Interest by Trading Participant	Same as above	API Specifications >Derivatives Open Interest by Participant >Data Item
Open Interest by Trading Issue	Same as above	API Specifications >Derivatives Open Interest by Issue >Data Item
Off-Auction Distribution	Same as above	API Specifications >Off-Auction Distribution >Data Item
Share Buyback Information (TDnet)	Same as above	API Specifications >Share Buyback Information (TDnet) >Data Item
Share Buyback Information (EDINET)	Same as above	API Specifications >Share Buyback Information (EDINET) >Data Item
Major Shareholders	Same as above	API Specifications >Major Shareholders >Data Item
Policy Shareholdings	Same as above	API Specifications >Policy Shareholdings >Data Item
Large Shareholding Reports	Same as above	API Specifications >Large Shareholding Reports >Data Item
Off-Auction Share Buyback	Same as above	API Specifications >Off-Auction Share Buyback >Data Item
Corporate Action Data	Same as above	API Specifications >Corporate Action Data >Data Item

The data periods is subject to change.

Directory structure

Files are located under directories with the names of the available APIs for each user.

/(root)
├─ breakdown
│  ├─ historical
│  │  ├─ breakdown_20100104-20101230.csv
│  │  └─ ...
│  │
│  └─ live
│     ├─ breakdown_2024-07-31.csv
│     └─ ...
│
├─ trades-spec
│  ├─ historical
│  │  ├─ value
│  │  │  ├─ trades_spec_value_20080116-20081230.csv
│  │  │  └─ ...
│  │  │
│  │  └─ volume
│  │     ├─ trades_spec_volume_20080116-20081230.csv
│  │     └─ ...
│  │
│  └─ live
│     ├─ value
│     │  ├─ trades_spec_value_2024-07-30.csv
│     │  └─ ...
│     │
│     └─ volume
│        ├─ trades_spec_volume_2024-07-30.csv
│        └─ ...
├─...
│  └─ ...

Files are separated on an annual basis. The file names indicate the time period covered by each file.

Data up to the previous month is stored in the "historical" directory, while the current month's data is placed in the "live" directory as daily or weekly files.

For Listed Shares Flash Data, there are no "historical" or "live" directories, and all data up to that day is stored in a single file.

Additionally, "Trading by Type of Investors" information is separated into "volume" and "value" folders, containing quantity-based and monetary value-based data respectively.

For "Trading by Type of Investors" information, data in terms of volume and value are respectively divided into "trades_spec_vloume" and "trades_spec_value" files.

Trading by Type of Investors (/markets/trades_spec)

For financial data,"statements" contains two subdirectories: "statements" and "fs_details". Financial Data (/fins/statements) is located within "statements", and Financial Statement Data(BS/PL/CF) (/fins/fs_details) is located within "fs_details".

Financial Data (/fins/statements)

Financial Statement Data(BS/PL/CF) (/fins/fs_details)

For derivatives data, "volume_by_participant" contains three subdirectories: "volume_by_participant", "open_interest_by_participant" and "open_interest_by_issue". Volume by Participant (/derivatives/volume_by_participant) is located within "volume_by_participant", Open Interest by Participant (/derivatives/open_interest_by_participant) is located within "open_interest_by_participant", and Open Interest by Issue (/derivatives/open_interest_by_issue) is located within "open_interest_by_issue".

Derivatives Trading Volume by Participant (/derivatives/volume_by_participant)

Open Interest by Trading Participant (/derivatives/open_interest_by_participant)

Open Interest by Issue (/derivatives/open_interest_by_issue)

For shareholder ownership data, "ownership" contains three subdirectories: "major-shareholders", "policy-shareholdings" and "large-shareholding-reports". Major Shareholders (/markets/major_shareholders) is located within "major-shareholders", Policy Shareholdings (/markets/policy_shareholdings) is located within "policy-shareholdings", and Large Shareholding Reports (/markets/large_shareholding_reports) is located within "large-shareholding-reports".

Major Shareholders (/markets/major_shareholders)

Policy Shareholdings (/markets/policy_shareholdings)

Large Shareholding Reports (/markets/large_shareholding_reports)