Quickstart

This guide explains the overall flow to start using J-Quants API and the steps to send actual requests.

Overall Flow

1. Register as a user and subscribe to a plan on the J-Quants Website (first time only).
2. Get your API Key from the dashboard.
3. Use the acquired API Key to access each API.

Try with Google Colab

There is a J-Quants API Quickstart Guide available using Google Colaboratory. If you want to try it out immediately without setting up an environment, please try the "Open in Colab" link below.

Preparation: User Registration and API Key Acquisition

1. User Registration

Register your email address for the J-Quants API service from the User Registration Page, and complete the registration from the URL in the email sent to you.

2. Subscription Registration

After logging in from the Sign In Page, register for a subscription plan.

3. Get API Key

Please issue and obtain your API Key from [Settings » API Key] in the menu. This key is used for request authentication.

Choose a Client

Before sending your first API request, decide which client to use. Here, we will use cURL, JavaScript, and Python as examples.

# cURL is already installed in many environments
curl --version

Send Your First API Request

Once your client is ready, let's send an actual request to J-Quants API. Here, as an example, we will send a GET request to the /v2/equities/bars/daily endpoint to retrieve daily stock prices, with code and date parameters.

curl -G https://api.jquants.com/v2/equities/bars/daily \
-H "x-api-key: {loading}" \
-d code="86970" \
-d date="20240104"

What's Next?

You have now completed the API client preparation and sent your first request. As a next step, it is useful to refer to the following pages:

• API Key management screen in the Dashboard
• Reference for each endpoint (Resources section)
• Guides for error handling and pagination