# API (추출작업 상태, 결제정보)

## API (추출작업 상태, 결제정보)

본 문서에 포함된 API Endpoint 들은 실험 목적으로 개발, 운영 중입니다.

{% hint style="info" %}
**API 기본 사용법은** [**API (추출데이터)**](https://help.listly.io/docs/ko/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>

```
{
    "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**

<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>

```
{
    "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**

<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>

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


---

# 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/ko/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.