API（狀態與帳單資訊）

本文件包含的 API Endpoint 是以實驗目的開發、運營中。

API 基本使用方法請在 API (提取資料)確認。

API 種類

• 付款資訊 (Billing)：顯示訂閱中商品的付款資訊。

• 單一提取狀態 (SingleTask Status)：顯示提取作業的狀態 (wait, doing, success, fail)。

• 群組提取狀態 (GroupTask Status)：顯示提取作業的狀態 (wait, doing, success, fail)。

---

Billing (付款資訊) API

URI: https://listly.io/api/billing 請求方式: GET

返回資訊說明：

• plan: 訂閱中的方案

• reset: 下個月訂閱更新日

• expire: (如為年度訂閱) 訂閱到期日

• usage: 可用 URL 數量（包含 available、total）

• addon: 自動付款額外購買項目（proxy、url，每項包含 currency、price）

• autopay: 下個月自動付款與否（boolean）

範例回應：

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

---

SingleTask (單一提取狀態) API

URI: https://listly.io/api/single/status?key= 請求方式: GET

返回資訊說明：

• key: 單一提取的 taskkey

• type: whole 或 part (全頁或部分提取)

• status: 提取狀態 (wait, doing, success, fail)

• updated: 提取作業最近變更日

• created: 提取作業最初建立日

範例回應：

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

---

GroupTask (群組提取狀態) API

URI: https://listly.io/api/group/status?key= 請求方式: GET

返回資訊說明：

• key: 群組提取的 taskkey

• type: whole 或 part (全頁或部分提取)

• name: 群組名稱

• status: 提取整體狀態（例如包含 success、total）

• updated: 提取作業最近變更日

• created: 提取作業最初建立日

• tasks: 註冊的群組提取作業資訊及各自提取狀態（每項包含 url、status、updated、created）

範例回應：

{
    "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"
        }
    ]
}

---