> ## Documentation Index
> Fetch the complete documentation index at: https://chainpatrol.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar assets

> Answers 'which assets does ChainPatrol hold at this status?'. Returns a paginated list defaulting to `BLOCKED`, optionally narrowed to a single `type` and to a date range. Omit `type` to sweep every asset type on one cursor, which is the cheapest way to mirror the whole blocklist. Built for bulk export and sync — pass `next_page` from the previous response to continue. To check one specific asset, use `/asset/check` instead; for an organization's own monitored assets, use `/organization/assets`.

## Inicio rápido

### Autenticación

Incluye tu clave de API en el encabezado `X-API-KEY`:

```bash theme={null}
X-API-KEY: <api-key>
```

## Tipos de asset

`type` es opcional. Omítelo para obtener **Assets** (activos digitales: URL, dirección, perfil,
app, etc.) de **todos** los tipos de asset con un solo cursor de paginación:

```json theme={null}
{ "status": "BLOCKED", "per_page": 1000 }
```

Esta es la forma más económica de replicar la **Blocklist** (lista de bloqueo) completa: un solo
recorrido paginado en lugar de un recorrido por cada miembro del enum `AssetType`. Cada asset devuelto
conserva su propio `type`, así que puedes agrupar los resultados del lado del cliente.

Indica `type` para limitar el recorrido a un solo tipo de asset, exactamente como antes:

```json theme={null}
{ "type": "URL", "status": "BLOCKED", "per_page": 1000 }
```

Omite el campo por completo para obtener el recorrido completo. Un `"type": null` explícito se
rechaza con un 400, así que un cliente que arma el cuerpo a partir de un struct debe dejar
la clave fuera en lugar de asignarle null.

> [!NOTE]
>
> Una sola respuesta devuelve como máximo **1000** assets, sin importar lo que pida `per_page`.
> Se aceptan valores mayores, pero se recortan a ese máximo, así que sigue siempre `next_page`
> hasta que devuelva `null` en lugar de suponer que una página lo contiene todo.
> Las respuestas también tienen un límite de 4 MB.

## Estrategia de sincronización y eliminaciones

> [!WARNING]
>
> Al usar filtros basados en tiempo (p. ej., obtener solo los últimos 5 minutos de datos de la Blocklist), es posible que no detectes los assets que se quitaron de la Blocklist. Para garantizar la consistencia completa de los datos, usa uno de estos enfoques:

### Enfoques recomendados

1. **Monitorea la Allowlist (lista de permitidos) y la lista de assets `UNKNOWN` para detectar eliminaciones**: Consulta periódicamente los endpoints de la Allowlist y de la lista `UNKNOWN` para detectar los assets que se quitaron de la Blocklist.

2. **Sincronización completa periódica**: Realiza una sincronización completa de toda la Blocklist a intervalos regulares (p. ej., cada hora o cada día) para detectar cualquier cambio que se haya pasado por alto.

3. **Enfoque híbrido**: Usa filtros basados en tiempo para las actualizaciones frecuentes, combinados con sincronizaciones completas periódicas para lograr una cobertura integral.

### Por qué es importante

Los cambios de estado de los assets pueden moverlos entre distintas listas (Blocklist, Allowlist, `UNKNOWN`). Las consultas basadas en tiempo sobre un solo endpoint pueden no captar estas transiciones, lo que podría dejar tu caché local con información desactualizada sobre assets bloqueados que ya no deberían estarlo.

### Assets con eliminación lógica (soft-deleted)

Los assets que ChainPatrol eliminó de forma lógica (soft-delete) se excluyen de todas las respuestas,
de modo que una réplica construida a partir de este endpoint coincide con la instantánea de la Blocklist del propio ChainPatrol.

Esto es un cambio de comportamiento: antes el endpoint devolvía los assets con eliminación
lógica. Una réplica construida antes del cambio puede conservar filas que nunca volverán a
aparecer; una resincronización completa las elimina.

## Paginación

Para usar la paginación, incluye los parámetros `per_page` y `next_page` en tu solicitud:

* `per_page <number>`: Elementos por página. Se aceptan valores de hasta 10000, pero una respuesta devuelve como máximo 1000; sigue siempre `next_page`.
* `next_page <string>`: Cursor de la siguiente página de resultados

### Ejemplo de implementación de la paginación:

```javascript JavaScript theme={null}
// Pass `type` to sweep one asset type, or leave it out to sweep them all.
async function fetchAllAssets(status, type) {
  let allAssets = [];
  let nextPage = null;
  while (true) {
    const response = await fetch(
      "https://app.chainpatrol.io/api/v2/asset/list",
      {
        method: "POST",
        headers: {
          "Content-Type": "application/json",
          "X-API-KEY": "YOUR_API_KEY_HERE",
        },
        body: JSON.stringify({
          ...(type ? { type } : {}),
          status,
          per_page: 1000,
          next_page: nextPage,
        }),
      }
    );
    const data = await response.json();
    allAssets = allAssets.concat(data.assets);
    nextPage = data.next_page;
    if (!nextPage) {
      break;
    }
  }
  return allAssets;
}
// Every asset type in one sweep:
fetchAllAssets("BLOCKED")
  .then((assets) => console.log("All assets:", assets))
  .catch((error) => console.error("Error fetching assets:", error));
```

```typescript TypeScript theme={null}
// `type` is optional — omit it to sweep every asset type on one cursor.
async function fetchAllAssets(status: string, type?: string): Promise<any[]> {
  let allAssets: any[] = [];
  let nextPage: string | null = null;

  while (true) {
    const response = await fetch(
      "https://app.chainpatrol.io/api/v2/asset/list",
      {
        method: "POST",
        headers: {
          "Content-Type": "application/json",
          "X-API-KEY": "YOUR_API_KEY_HERE",
        },
        body: JSON.stringify({
          ...(type ? { type } : {}),
          status,
          per_page: 1000,
          next_page: nextPage,
        }),
      }
    );
    const data = await response.json();
    allAssets = allAssets.concat(data.assets);
    nextPage = data.next_page;

    if (!nextPage) {
      break;
    }
  }
  return allAssets;
}

// Every asset type in one sweep:
fetchAllAssets("BLOCKED")
  .then((assets) => console.log("All assets:", assets))
  .catch((error) => console.error("Error fetching assets:", error));
```

```python Python theme={null}
import requests

# `type` is optional. Leave the key out of the body entirely to sweep every
# asset type on one cursor.
def fetch_all_assets(status: str, type: str | None = None) -> list:
    all_assets = []
    next_page = None
    while True:
        body = {
            "status": status,
            "per_page": 1000,
            "next_page": next_page,
        }
        if type is not None:
            body["type"] = type
        response = requests.post(
            "https://app.chainpatrol.io/api/v2/asset/list",
            headers={
                "Content-Type": "application/json",
                "X-API-KEY": "YOUR_API_KEY_HERE",
            },
            json=body,
        )
        data = response.json()
        all_assets.extend(data["assets"])
        next_page = data.get("next_page")
        if not next_page:
            break
    return all_assets

try:
    # Every asset type in one sweep:
    assets = fetch_all_assets("BLOCKED")
    print("All assets:", assets)
except Exception as error:
    print("Error fetching assets:", str(error))
```


## OpenAPI

````yaml POST /asset/list
openapi: 3.0.3
info:
  title: ChainPatrol External API - OpenAPI 3.0
  description: ChainPatrol External API documentation
  version: 2.0.0
servers:
  - url: https://app.chainpatrol.io/api/v2
security: []
tags:
  - name: asset
  - name: report
  - name: dark-web
externalDocs:
  url: https://chainpatrol.com/docs
paths:
  /asset/list:
    post:
      tags:
        - asset
      summary: List assets
      description: >-
        Answers 'which assets does ChainPatrol hold at this status?'. Returns a
        paginated list defaulting to `BLOCKED`, optionally narrowed to a single
        `type` and to a date range. Omit `type` to sweep every asset type on one
        cursor, which is the cheapest way to mirror the whole blocklist. Built
        for bulk export and sync — pass `next_page` from the previous response
        to continue. To check one specific asset, use `/asset/check` instead;
        for an organization's own monitored assets, use `/organization/assets`.
      operationId: assetList
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - URL
                    - PAGE
                    - ADDRESS
                    - DISCORD
                    - LINKEDIN
                    - TWITTER
                    - FACEBOOK
                    - YOUTUBE
                    - REDDIT
                    - TELEGRAM
                    - GOOGLE_APP_STORE
                    - APPLE_APP_STORE
                    - AMAZON_APP_STORE
                    - MICROSOFT_APP_STORE
                    - TIKTOK
                    - INSTAGRAM
                    - THREADS
                    - MEDIUM
                    - CHROME_WEB_STORE
                    - MOZILLA_ADDONS
                    - OPERA_ADDONS
                    - EMAIL
                    - PATREON
                    - OPENSEA
                    - FARCASTER
                    - IPFS
                    - GOOGLE_FORM
                    - WHATSAPP
                    - DISCORD_USER
                    - QUORA
                    - GITHUB
                    - TEACHABLE
                    - SUBSTACK
                    - DEBANK
                    - TAWK_TO
                    - JOTFORM
                    - PRIMAL
                    - BLUESKY
                    - SNAPCHAT
                    - DESO
                    - PINTEREST
                    - FLICKR
                    - GALXE
                    - VELOG
                    - NPM
                    - PYPI
                    - HEX
                    - DOCKER_HUB
                    - VOCAL_MEDIA
                    - TECKFINE
                    - TENDERLY
                    - HACKMD
                    - ETSY
                    - ZAZZLE
                    - BASENAME
                    - BILIBILI_TV
                    - VIMEO
                    - DAILYMOTION
                    - PHONE_NUMBER
                    - SLACK
                    - CALENDLY
                    - NGROK
                    - RARIBLE
                    - RUST_PACKAGE
                    - FLATHUB
                    - VIDLII
                    - VEVIOZ
                    - ISSUU
                    - SOUNDCLOUD
                    - ZAPPER
                    - REDNOTE
                    - SAMSUNG_APP_STORE
                    - HUAWEI_APP_STORE
                    - XIAOMI_APP_STORE
                    - TENCENT_APP_STORE
                    - OPPO_APP_STORE
                    - VIVO_APP_STORE
                    - F_DROID
                    - GOOGLE_AD
                    - BING_AD
                    - TWITCH
                    - BEHANCE
                    - ZORA
                    - META_AD
                    - SIGNAL
                    - DEVIANTART
                    - BANDCAMP
                    - ARCHIVE_ORG
                    - FIVE_HUNDRED_PX
                    - LUMA
                    - SMARTMONEYMATCH
                    - APK_GOLD
                    - GLASSDOOR
                    - PUMP_FUN
                    - TUMBLR
                    - MASTODON
                  description: >-
                    Asset type to retrieve. Omit the field entirely to retrieve
                    assets of every type in a single paginated sweep; an
                    explicit null is rejected.
                status:
                  type: string
                  enum:
                    - UNKNOWN
                    - ALLOWED
                    - BLOCKED
                  default: BLOCKED
                  description: Status of the assets to retrieve
                startDate:
                  type: string
                  description: >-
                    The start date to list assets from. This should be in the
                    format `YYYY-MM-DD` and is inclusive.
                endDate:
                  type: string
                  description: >-
                    The end date to list assets from. This should be in the
                    format `YYYY-MM-DD` and is inclusive.
                per_page:
                  type: integer
                  minimum: 1
                  maximum: 10000
                  default: 100
                  description: The number of assets to return per page
                next_page:
                  type: string
                  nullable: true
                  description: Cursor for fetching the next page of results
              description: >-
                List asset request body


                With no `startDate`, this returns every matching asset
                regardless of age — there

                is no implicit one-day window. Pass `startDate` to get a delta
                instead.


                You can also choose a `startDate` and `endDate` for the range of
                asset updates, most 

                timestamp formats should work, we use
                [Luxon](https://moment.github.io/luxon/#/parsing) 

                for parsing the dates.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  assets:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          description: >-
                            Asset ID — use to reference the asset in follow-up
                            calls
                        content:
                          type: string
                          description: Asset content
                        type:
                          type: string
                          enum:
                            - URL
                            - PAGE
                            - ADDRESS
                            - DISCORD
                            - LINKEDIN
                            - TWITTER
                            - FACEBOOK
                            - YOUTUBE
                            - REDDIT
                            - TELEGRAM
                            - GOOGLE_APP_STORE
                            - APPLE_APP_STORE
                            - AMAZON_APP_STORE
                            - MICROSOFT_APP_STORE
                            - TIKTOK
                            - INSTAGRAM
                            - THREADS
                            - MEDIUM
                            - CHROME_WEB_STORE
                            - MOZILLA_ADDONS
                            - OPERA_ADDONS
                            - EMAIL
                            - PATREON
                            - OPENSEA
                            - FARCASTER
                            - IPFS
                            - GOOGLE_FORM
                            - WHATSAPP
                            - DISCORD_USER
                            - QUORA
                            - GITHUB
                            - TEACHABLE
                            - SUBSTACK
                            - DEBANK
                            - TAWK_TO
                            - JOTFORM
                            - PRIMAL
                            - BLUESKY
                            - SNAPCHAT
                            - DESO
                            - PINTEREST
                            - FLICKR
                            - GALXE
                            - VELOG
                            - NPM
                            - PYPI
                            - HEX
                            - DOCKER_HUB
                            - VOCAL_MEDIA
                            - TECKFINE
                            - TENDERLY
                            - HACKMD
                            - ETSY
                            - ZAZZLE
                            - BASENAME
                            - BILIBILI_TV
                            - VIMEO
                            - DAILYMOTION
                            - PHONE_NUMBER
                            - SLACK
                            - CALENDLY
                            - NGROK
                            - RARIBLE
                            - RUST_PACKAGE
                            - FLATHUB
                            - VIDLII
                            - VEVIOZ
                            - ISSUU
                            - SOUNDCLOUD
                            - ZAPPER
                            - REDNOTE
                            - SAMSUNG_APP_STORE
                            - HUAWEI_APP_STORE
                            - XIAOMI_APP_STORE
                            - TENCENT_APP_STORE
                            - OPPO_APP_STORE
                            - VIVO_APP_STORE
                            - F_DROID
                            - GOOGLE_AD
                            - BING_AD
                            - TWITCH
                            - BEHANCE
                            - ZORA
                            - META_AD
                            - SIGNAL
                            - DEVIANTART
                            - BANDCAMP
                            - ARCHIVE_ORG
                            - FIVE_HUNDRED_PX
                            - LUMA
                            - SMARTMONEYMATCH
                            - APK_GOLD
                            - GLASSDOOR
                            - PUMP_FUN
                            - TUMBLR
                            - MASTODON
                          description: Asset type
                        status:
                          type: string
                          enum:
                            - UNKNOWN
                            - ALLOWED
                            - BLOCKED
                          description: The result of the asset status check
                        watchStatus:
                          type: string
                          enum:
                            - ENABLED
                            - DISABLED
                          description: The watch status of the asset
                        livenessStatus:
                          type: string
                          nullable: true
                          enum:
                            - UNKNOWN
                            - ALIVE
                            - DEAD
                            - null
                          description: >-
                            Whether the asset is currently reachable (`ALIVE`),
                            gone (`DEAD`), or hasn't been checked (`UNKNOWN`).
                            `null` when liveness has never been evaluated.
                        blockedAt:
                          type: string
                          nullable: true
                          description: >-
                            When the asset transitioned to BLOCKED status.
                            `null` for non-blocked assets or blocks predating
                            the field. Distinct from `updatedAt`, which changes
                            on any mutation.
                        updatedAt:
                          type: string
                      required:
                        - id
                        - content
                        - type
                        - status
                        - watchStatus
                        - livenessStatus
                        - blockedAt
                        - updatedAt
                  next_page:
                    type: string
                    nullable: true
                    description: Cursor for fetching the next page of results
                required:
                  - assets
                description: Successful operation
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
      security:
        - ApiKey: []
components:
  schemas:
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Authorization not provided
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
    error.FORBIDDEN:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Insufficient access
        code:
          type: string
          description: The error code
          example: FORBIDDEN
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        Your API key. This is required by most endpoints to access our API
        programatically. Reach out to us at
        [support@chainpatrol.io](mailto:support@chainpatrol.io?subject=Re:%20API%20Key%20for%20SDK&body=Company:%20%0AName:%20%0APurpose:%20)
        to get an API key for your use.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.