# TDnet/Company Disclosure Index List (/td/list)

`GET`    /v2/td/list

## Overview

You can retrieve a list of timely disclosure index information (e.g. disclosure number, date/time, title).\
Specify a date or issue code to retrieve data.

### Attention

> **Info**
>
> - This API requires the TimelyDisclosure add-on.
> - Data is available for the past 5 years.
> - In the current implementation, the following behavior applies when a timely disclosure is corrected or deleted:
>   - If the title of a disclosure file is corrected, the correction is not reflected in the data returned by this API.
>   - If a disclosure file itself is corrected, a new disclosure number is assigned and it is treated as a new record.
>   - Even if a disclosure is deleted, this API continues to return the disclosure.
> - In the current implementation, DiscStatus is always null and RevNo is always 1.

## Retrieve TDnet/Company Disclosure Index List

`GET` `https://api.jquants.com/v2/td/list`

Either a date (date) or an issue code (code) must be specified to retrieve data.

### Parameter and Response

Either a date (date) or an issue code (code) must be specified.\
Parameter in the request and results are as below:

- date: ✓, code: –, from/to: – → List of disclosures on the specified date

- date: –, code: ✓, from/to: – → List of disclosures for the specified issue (last 5 years)

- date: –, code: ✓, from/to: ✓ → List of disclosures for the specified issue during the specified period

### Retrieving disclosures using cursor

By calling the API with `date` set to today, you can retrieve the list of disclosures available at the time of the call. By passing the `cursor` from the previous response along with the `date` parameter in the next call, you can retrieve only the disclosures published after the ones you have already fetched.

If the response contains a `pagination_key`, it means not all results could be retrieved in a single request. Specify the `pagination_key` as a request parameter and re-fetch immediately to retrieve the remaining data.

### Requests

### Headers

| Parameter | Type   | Required | Description |
| --------- | ------ | -------- | ----------- |
| x-api-key | string | Required | API Key     |

### Query Parameters

> **Note**
>
> Either **date** or **code** must be specified.

| Parameter       | Type   | Required | Description                                                                                                                                                                                                                                                                                                                             |
| --------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| date            | string | Optional | Disclosure date (e.g. 20250401 or 2025-04-01)                                                                                                                                                                                                                                                                                           |
| code            | string | Optional | Issue code (e.g. 13010 or 1301) If a 4-character code is specified, 0 is appended at the end.                                                                                                                                                                                                                                           |
| from            | string | Optional | Start date (e.g. 20250301 or 2025-03-01) Used in combination with code. Must be specified together with to.                                                                                                                                                                                                                             |
| to              | string | Optional | End date (e.g. 20250401 or 2025-04-01) Used in combination with code. Must be specified together with from.                                                                                                                                                                                                                             |
| discItems       | string | Optional | Filter by public item code (multiple values can be specified separated by commas, AND condition) (e.g. 11101 or 11101,11102) For the list of public item codes, refer to [Appendix 1 of the TDnet API Specifications](https://www.jpx.co.jp/english/markets/paid-info-listing/tdnet/p1j4l40000000q03-att/tdnetapi_specificationsE.pdf). |
| cursor          | string | Optional | Pagination key for real-time retrieval of today's data Use the value returned as cursor in the previous response. Cannot be specified together with pagination\_key.                                                                                                                                                                    |
| pagination\_key | string | Optional | Pagination key Use the value returned as pagination\_key in the previous response. Cannot be specified together with cursor.                                                                                                                                                                                                            |

### Sample Code

/v2/td/list

**cURL**

```bash
curl -G https://api.jquants.com/v2/td/list \
-H "x-api-key: {{apiKey}}" \
-d date="{{date}}"
```

**JavaScript**

```javascript
import axios from 'axios'

const client = axios.create({
  baseURL: 'https://api.jquants.com',
  headers: { 'x-api-key': '{{apiKey}}' },
})

await client.get('/v2/td/list', {
  params: {
    date: '{{date}}',
  },
})
```

**Python**

```python
import requests

headers = {"x-api-key": "{{apiKey}}"}
resp = requests.get(
    "https://api.jquants.com/v2/td/list",
    params={"date": "{{date}}"},
    headers=headers,
)
print(resp.json())
```

### Responses

### Data Item

| Parameter       | Type      | Required | Description                                                                                                                                                        |
| --------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| DiscNo          | string    | Required | Disclosure number (14 digits)                                                                                                                                      |
| Code            | string    | Required | Issue code                                                                                                                                                         |
| Name            | string    | Required | Company name (Japanese)                                                                                                                                            |
| DiscDate        | string    | Required | Disclosure date (YYYY-MM-DD)                                                                                                                                       |
| DiscTime        | string    | Required | Disclosure time (HH:MM)                                                                                                                                            |
| Title           | string    | Required | Disclosure title (Japanese)                                                                                                                                        |
| DiscStatus      | string    | Required | Handling type (null: new disclosure, 'revision': corrected disclosure, 'delete': deleted disclosure)                                                               |
| RevNo           | number    | Required | Disclosure revision number (1 to 99)                                                                                                                               |
| DiscItems       | string\[] | Required | List of public item codes                                                                                                                                          |
| Docs            | string\[] | Required | List of document types (g: full PDF, s: summary PDF, x: XBRL)                                                                                                      |
| cursor          | string    | Required | Time pointer indicating up to which disclosure has been fetched (returned only when date equals today and all results fit in a single response without pagination) |
| pagination\_key | string    | Required | Pagination key                                                                                                                                                     |

### Response Sample

```bash {{ title: "200:OK" }}
{
    "data": [
        {
            "DiscNo": "20250401130100",
            "Code": "86970",
            "Name": "日本取引所グループ",
            "DiscDate": "2025-04-01",
            "DiscTime": "08:00",
            "Title": "2025年3月期 決算短信〔日本基準〕（連結）",
            "DiscStatus": null,
            "RevNo": 1,
            "DiscItems": ["11101"],
            "Docs": ["g", "s", "x"]
        }
    ],
    "cursor": "eyJkIjoiMjAyNS0wNC0wMSIsInQiOiIyMDI1LTA0LTAxVDA4OjAwOjAwWiMyMDI1MDQwMTEzMDEwMCJ9"
}
```
