# API (ステータス & 課金情報)

本文書に含まれるAPI Endpointは実験目的で開発・運営中です。

{% hint style="info" %}
**APIの基本的な使い方は** [**API（抽出データ）**](https://app.gitbook.com/o/Uu6AM3fgpZza0EpsJM4N/s/I8js41AfLS5QdXKB7e8A/~/edit/~/changes/9/getting-started/result-page-features/api-data)**でご確認ください。**
{% endhint %}

## API（抽出作業ステータス、決済情報）の種類

* 決済情報（Billing）：購読中の商品に関する決済情報を表示します。
* シングル抽出ステータス（SingleTask Status）：抽出作業のステータス（wait、doing、success、fail）を表示します。
* グループ抽出ステータス（GroupTask Status）：抽出作業のステータス（wait、doing、success、fail）を表示します。

### API Endpoint & Response

**Billing（決済情報）API**

<table><thead><tr><th width="82.453125">種類</th><th width="587.59765625">URI</th><th>リクエスト方式</th></tr></thead><tbody><tr><td>Billing</td><td><strong>https://listly.io/api/billing</strong></td><td>GET</td></tr><tr><td></td><td><p>次の情報を返します。</p><p>plan：購読中のプラン<br>reset：次月の購読更新日<br>expire：（年間購読の場合）購読満了日<br>usage：使用可能なURL数<br>proxy：自動決済で追加購入するプロキシサーバー<br>url：自動決済で追加購入するURL<br>autopay：次月の自動決済の有無</p></td><td></td></tr></tbody></table>

{% code title="レスポンス例" %}

```json
{
    "plan": "business",
    "reset": "2023-04-17T19:00:00+09:00",
    "expire": "2023-09-05T13:48:39.443+09:00",
    "usage": {
        "available": 8738,
        "total": 9000
    },
    "addon": {
        "proxy": {
            "currency": "KRW",
            "price": 0
        },
        "url": {
            "currency": "KRW",
            "price": 0
        }
    },
    "autopay": false
}
```

{% endcode %}

**SingleTask（シングル抽出ステータス）API**

<table><thead><tr><th width="154.2421875">種類</th><th width="516.015625">URI</th><th>リクエスト方式</th></tr></thead><tbody><tr><td>SingleTask Status</td><td><strong>https://listly.io/api/single/status?key=</strong><mark style="color:red;"><strong>&#x3C;singlekey></strong></mark></td><td>GET</td></tr><tr><td></td><td><p>次の情報を返します。</p><p>key：シングル抽出のtaskkey<br>type：wholeまたはpart（全体または部分抽出）<br>status：抽出ステータス（wait、doing、success、fail）<br>updated：抽出作業の最終変更日<br>created：抽出作業の最初の作成日</p></td><td></td></tr></tbody></table>

{% code title="レスポンス例" %}

```json
{
    "key": "SGzSoRqJ",
    "type": "part",
    "status": "success",
    "updated": "2023-04-11T08:45:01.109+09:00",
    "created": "2022-12-02T17:23:46.108+09:00"
}
```

{% endcode %}

**GroupTask（グループ抽出ステータス）API**

<table><thead><tr><th width="177.08984375">種類</th><th width="488.41796875">URI</th><th>リクエスト方式</th></tr></thead><tbody><tr><td>Group info.<br>&#x26; GroupTask Status</td><td><strong>https://listly.io/api/group/status?key=</strong><mark style="color:red;"><strong>&#x3C;groupkey></strong></mark></td><td>GET</td></tr><tr><td></td><td><p>次の情報を返します。</p><p>key：グループ抽出のtaskkey<br>type：wholeまたはpart（全体または部分抽出）<br>name：グループ名<br>status：抽出ステータス（wait、doing、success、fail）<br>updated：抽出作業の最終変更日<br>created：抽出作業の最初の作成日<br>tasks：登録されたグループ抽出作業の情報および抽出ステータス</p></td><td></td></tr></tbody></table>

{% code title="レスポンス例" %}

```json
{
    "key": "vk9q2sJQ",
    "type": "part",
    "name": "www.youtube.com",
    "status": {
        "success": 246,
        "total": 246
    },
    "updated": "2022-09-29T00:19:33.794+09:00",
    "created": "2022-09-28T23:47:16.708+09:00",
    "tasks": [
        {
            "url": "https://www.youtube.com/watch?v=0KnUyy6pH-U",
            "status": "success",
            "updated": "2022-09-29T00:08:13.905059+09:00",
            "created": "2022-09-28T23:47:17.102288+09:00"
        },
        {
            "url": "https://www.youtube.com/watch?v=bGpzWPUbP3s",
            "status": "success",
            "updated": "2022-09-28T23:47:20.634761+09:00",
            "created": "2022-09-28T23:47:17.102359+09:00"
        },
        
				...,

        {
            "url": "https://www.youtube.com/watch?v=QD0by6q-9Go",
            "status": "success",
            "updated": "2022-09-28T23:58:49.095977+09:00",
            "created": "2022-09-28T23:47:17.116181+09:00"
        }
    ]
}
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.listly.io/docs/ja/getting-started/result-page-features/api-status.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.