ID Token (/token/auth_refresh)

The ID token can be obtained using the refresh token obtained on the sign in page.

Overview

Retrieving an ID Token Using a Refresh Token.

The refresh token can be obtained from menu page or refresh token API after user registration and subscription plan registration.

Attention

The refresh token is valid for one week and the ID token is valid for 24 hours.

Parameter and Response

Get the ID token

POST https://api.jquants.com/v1/token/auth_refresh

To acquire data, a refresh token must be specified.

"*" is a mandatory item.

Query Parameters

Name	Type	Description
refreshtoken*	String	Refresh token

Headers

Name	Type	Description
Not required	Not required	Not required

200: OK

{
    "idToken": "<YOUR idToken>" 
}

400: Bad Request

{
    "message": "'refreshtoken' is required."
}

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."
}

Data Item

Variable	Description	Data type	Remark
idToken	ID token	String

Sample Code

Curl

REFRESH_TOKEN=<YOUR REFRESH_TOKEN> && curl -XPOST https://api.jquants.com/v1/token/auth_refresh?refreshtoken=$REFRESH_TOKEN

Python

import requests
import json

REFRESH_TOKEN = "YOUR refreshtokenID"
r_post = requests.post(f"https://api.jquants.com/v1/token/auth_refresh?refreshtoken={REFRESH_TOKEN}")
r_post.json()