> For the complete documentation index, see [llms.txt](https://help.listly.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.listly.io/getting-started/result-page-features/api-status.md).

# API (Status & Billing Info)

The API Endpoints included in this document are being developed and operated for experimental purposes.

{% hint style="info" %}
**Check** [**API (Extraction Data)**](/getting-started/result-page-features/api-data.md) **for basic API usage.**
{% endhint %}

## API (Extraction Task Status, Billing Info) Types

* Billing: Shows billing information for subscribed products.
* SingleTask Status: Shows extraction task status (wait, doing, success, fail).
* GroupTask Status: Shows extraction task status (wait, doing, success, fail).

## API Endpoint & Response

### Billing API

| Type    |                                 URI | Method |
| ------- | ----------------------------------: | :----: |
| Billing | **<https://listly.io/api/billing>** |   GET  |

Returns the following information:

* plan: Subscribed plan
* reset: Next month subscription renewal date
* expire: (For annual subscription) Subscription expiration date
* usage: Available URL count
* proxy: Proxy servers to auto-purchase with automatic billing
* url: URLs to auto-purchase with automatic billing
* autopay: Whether automatic billing next month

{% code title="Response example" %}

```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 (Single Extraction Status) API

| Type              |                                            URI | Method |
| ----------------- | ---------------------------------------------: | :----: |
| SingleTask Status | **<https://listly.io/api/single/status?key=>** |   GET  |

Returns the following information:

* key: Single extraction task key
* type: whole or part (full or partial extraction)
* status: Extraction status (wait, doing, success, fail)
* updated: Extraction task last modified date
* created: Extraction task initial creation date

{% code title="Response example" %}

```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 (Group Extraction Status) API

| Type                           |                                           URI | Method |
| ------------------------------ | --------------------------------------------: | :----: |
| Group info. & GroupTask Status | **<https://listly.io/api/group/status?key=>** |   GET  |

Returns the following information:

* key: Group extraction task key
* type: whole or part (full or partial extraction)
* name: Group name
* status: Extraction status (wait, doing, success, fail) — may include counts (e.g., success/total)
* updated: Extraction task last modified date
* created: Extraction task initial creation date
* tasks: Registered group extraction task info and extraction status

{% code title="Response example" %}

```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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.