Margin Trading Outstandings (/markets/weekly_margin_interest)

Weekly margin trading outstandings is available.

Overview

Weekly margin trading outstandings as of the last business day of each week is available.

This data is also available via the following site. https://www.jpx.co.jp/english/markets/statistics-equities/margin/index.html

Attention

• Even in the event of a corporate action for the issue, items of trading volume will not be retrospectively adjusted.

• No data is provided for weeks with two or fewer business days like New Year's holiday.

• Stocks that are not listed on the TSE (including issue listed only on the other exchanges) are not included in the data.

Parameter and Response

In your request message, either "code" or "date" must be specified. Combination of parameter in the request and results are as below.

code	date	from /to	Result
			All historical data of a specific issue.
			Data of a specific issue for the specified period.
			All listed issue data for the specific date.

Get weekly margin trading outstandings

GET https://api.jquants.com/v1/markets/weekly_margin_interest

Either "code" or "date" must be specified.

"*" Required.

Query Parameters

Name	Type	Description
code	String	issue code （e.g. 27800 or 2780） If a 4-character issue code is specified, only the data of common stock will be obtained for the issue on which both common and preferred stocks are listed.
from	String	starting point of data period （e.g. 20210901 or 2021-09-01）
to	String	end point of data period （e.g. 20210907 or 2021-09-07）
date	String	date of data （e.g. 20210907 or 2021-09-07）
pagination_key	String	The primary key of the first item that this operation will evaluate. Use the value that was returned for pagination_key in the previous operation.

Headers

Name	Type	Description
Authorization*	String	Access key

200: OK

{
    "weekly_margin_interest": [
        {
            "Date": "2023-02-17",
            "Code": "13010",
            "ShortMarginTradeVolume": 4100.0,
            "LongMarginTradeVolume": 27600.0,
            "ShortNegotiableMarginTradeVolume": 1300.0,
            "LongNegotiableMarginTradeVolume": 7600.0,
            "ShortStandardizedMarginTradeVolume": 2800.0,
            "LongStandardizedMarginTradeVolume": 20000.0,
            "IssueType": "2"
        }
    ],
    "pagination_key": "value1.value2."
}

400: Bad Request

{
    "message": "<Error Message>"
}

401: Unauthorized

{
    "message": "The incoming token is invalid or expired."
}

403: Forbidden

{
    "message": "Missing Authentication Token. The method or resources may not be supported."
}

500: Internal Server Error

{
    "message": "Unexpected error. Please try again later."
}

413: Payload Too Large

{
    "message": "Response data is too large. Specify parameters to reduce the acquired data range."
}

Data Item

Variable	Description	Data type	Remark
Date	Record Date	String	YYYY-MM-DD Base date of margin trading outstandings(usually on Friday)
Code	issue code	String
ShortMarginTradeVolume	Total margin trading (negotiable and standardized margin trading) weekend short positions	Number
LongMarginTradeVolume	Total margin trading (negotiable and standardized margin trading) weekend long positions	Number
ShortNegotiableMarginTradeVolume	Negotiable margin trading weekend short positions	Number	Negotiable part of the total margin trading weekend short positions
LongNegotiableMarginTradeVolume	Negotiable margin trading weekend long positions	Number	Negotiable part of the total margin trading weekend long positions
ShortStandardizedMarginTradeVolume	Standardized margin trading weekend short positions	Number	Standardized part of the total margin trading weekend short positions
LongStandardizedMarginTradeVolume	Standardized margin positions weekend long positions	Number	Standardized part of the total margin trading weekend long positions
IssueType	Issue Classifications	String	1: Margin issues, 2: Loan issues, 3: Other issues(non-loan, non-margin)

Sample Code

Curl

idToken=<YOUR idToken> && curl https://api.jquants.com/v1/markets/weekly_margin_interest?code=86970 -H "Authorization: Bearer $idToken" 

Python

import requests
import json

idToken = "YOUR idToken"
headers = {'Authorization': 'Bearer {}'.format(idToken)}
r = requests.get("https://api.jquants.com/v1/markets/weekly_margin_interest?code=86970", headers=headers)
r.json()