# API (estado e información de facturación)

Los API Endpoints incluidos en este documento están siendo desarrollados y operados con fines experimentales.

{% hint style="info" %}
**Para el uso básico de la API, consulta** [**API (Datos Extraídos)**](https://help.listly.io/docs/ko/getting-started/result-page-features/api-data)**.**
{% endhint %}

## Tipos de API (Estado de Extracción, Información de Pago)

* Información de Pago (Billing): Muestra información de pago para el producto suscrito.
* Estado de Extracción Single (SingleTask Status): Muestra el estado del trabajo de extracción (wait, doing, success, fail).
* Estado de Extracción Group (GroupTask Status): Muestra el estado del trabajo de extracción (wait, doing, success, fail).

### API Endpoint y Respuesta

## API de Información de Pago (Billing)

**Endpoint:** <https://listly.io/api/billing\\>
**Método:** GET

Devuelve la siguiente información:

* plan: Plan suscrito
* reset: Fecha de renovación de suscripción del próximo mes
* expire: (Si es suscripción anual) Fecha de vencimiento de la suscripción
* usage: Número de URLs disponibles
* proxy: Servidores proxy para compra adicional con pago automático
* url: URLs para compra adicional con pago automático
* autopay: Si el pago automático está habilitado para el próximo mes

{% code title="Ejemplo de respuesta (JSON)" %}

```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 %}

***

## API de Estado de SingleTask (Estado de Extracción Single)

**Endpoint:** <https://listly.io/api/single/status?key=\\>
**Método:** GET

Devuelve la siguiente información:

* key: taskkey de la extracción single
* type: whole o part (extracción completa o parcial)
* status: Estado de extracción (wait, doing, success, fail)
* updated: Última fecha de modificación del trabajo de extracción
* created: Fecha de creación inicial del trabajo de extracción

{% code title="Ejemplo de respuesta (JSON)" %}

```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 %}

***

## API de Estado de GroupTask (Estado de Extracción Group)

**Endpoint:** <https://listly.io/api/group/status?key=\\>
**Método:** GET

Devuelve la siguiente información:

* key: taskkey de la extracción grupal
* type: whole o part (extracción completa o parcial)
* name: Nombre del grupo
* status: Estado de extracción (por ejemplo, objeto con counts como success y total)
* updated: Última fecha de modificación del trabajo de extracción
* created: Fecha de creación inicial del trabajo de extracción
* tasks: Información y estado de extracción de los trabajos de extracción grupal registrados

{% code title="Ejemplo de respuesta (JSON)" %}

```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/es/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.