Saltar al contenido principal
POST
List assets

Inicio rápido

Autenticación

Incluye tu clave de API en el encabezado X-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:
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:
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.
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

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:

Autorizaciones

X-API-KEY
string
header
requerido

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Cuerpo

application/json

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 for parsing the dates.

type
enum<string>

Asset type to retrieve. Omit the field entirely to retrieve assets of every type in a single paginated sweep; an explicit null is rejected.

Opciones disponibles:
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
status
enum<string>
predeterminado:BLOCKED

Status of the assets to retrieve

Opciones disponibles:
UNKNOWN,
ALLOWED,
BLOCKED
startDate
string

The start date to list assets from. This should be in the format YYYY-MM-DD and is inclusive.

endDate
string

The end date to list assets from. This should be in the format YYYY-MM-DD and is inclusive.

per_page
integer
predeterminado:100

The number of assets to return per page

Rango requerido: 1 <= x <= 10000
next_page
string | null

Cursor for fetching the next page of results

Respuesta

Successful response

Successful operation

assets
object[]
requerido
next_page
string | null

Cursor for fetching the next page of results