Get File Download URL (/bulk/get)
GET /v2/bulk/get
Overview
You can obtain a signed URL for downloading a file.
You can retrieve files in two ways: by specifying the Key obtained from List of Downloadable Files, or by specifying an endpoint and date combination.
For information on decompression methods and restrictions for CSV files obtained via Bulk API, please see File Download.
Attention
- The obtained URL expires in 5 minutes. Please complete the download within the validity period.
- The URL is temporary and cannot be reused.
- Files are compressed in gzip format.
- Specify either
keyor the combination ofendpointanddate. You cannot specify all three at the same time.
Retrieve file download URL
GET https://api.jquants.com/v2/bulk/get
In your request message, either "key" or the combination of "endpoint" and "date" must be specified.
Parameter and Response
In your request message, either "key" or the combination of "endpoint" and "date" must be specified.
Combination of parameter in the request and results are as below.
| key | endpoint | date | Results |
|---|---|---|---|
| Download URL for the file matching the specified Key | |||
| Download URL for the file matching the specified endpoint and date |
Requests
Headers
- x-api-keystringrequired
API Key
Query Parameters
Either key or endpoint + date is required.
- keystringoptional
File key (Key obtained from /bulk/list).
- endpointstringoptional
Endpoint name of the data to retrieve (e.g. /equities/bars/daily). Used in combination with
date. For a list of available values, please see here.- datestringoptional
Target date (YYYY-MM, YYYYMM, YYYY-MM-DD, or YYYYMMDD). Used in combination with
endpoint.
- By specifying
endpointanddatetogether, you can get the download URL for the matching file.
Sample Code
Request
curl -G https://api.jquants.com/v2/bulk/get \
-H "x-api-key: {loading}" \
-d key="equities/bars/daily/historical/2025/equities_bars_daily_202501.csv.gz"Responses
Data Item
- urlstring
- Signed URL for file download
Response Sample
{
"url": "https://example.presigned-url.com/..."
}