Saltar al contenido principal
POST
List threats

Inicio rápido

Autenticación

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

Solicitud de ejemplo

Esquema de la solicitud

Cuerpo de la solicitud

Sin startDate ni endDate, este endpoint devuelve solo las amenazas bloqueadas en el último día. Ambas fechas filtran por blockedAt. Para listar todas las amenazas confirmadas, envía un startDate antiguo, como "2020-01-01".

Bloqueos pendientes

Si la protección no está activa para tu organización, ChainPatrol igual revisa lo que encuentra, pero las amenazas confirmadas quedan en espera como Pending Blocked en lugar de aplicarse en la Blocklist (lista de bloqueo). De forma predeterminada se excluyen, porque este endpoint alimenta a los consumidores de la Blocklist. Establece includePending: true para incluirlas. Se devuelven con pendingStatus: "BLOCKED", y su blockedAt indica cuándo se confirmó el bloqueo.

Configuración de ordenamiento

Cada objeto de ordenamiento debe tener la siguiente estructura:

Campos de ordenamiento disponibles

  • "id" - Ordena por ID de la amenaza
  • "blockedAt" - Ordena por el momento en que se bloqueó el asset
  • "content" - Ordena por contenido de la amenaza
  • "type" - Ordena por tipo de asset

Filtro por tipo de asset

El parámetro assetType acepta un arreglo de tipos de asset por los que filtrar:
  • "URL" - URL de sitios web
  • "PAGE" - Páginas web
  • "ADDRESS" - Direcciones de blockchain
  • "LINKEDIN" - Perfiles de LinkedIn
  • "TWITTER" - Perfiles/publicaciones de Twitter
  • "FACEBOOK" - Perfiles/páginas de Facebook
  • "YOUTUBE" - Canales/videos de YouTube
  • "REDDIT" - Publicaciones/subreddits de Reddit
  • "TELEGRAM" - Canales/grupos de Telegram
  • "GOOGLE_APP_STORE" - Apps de Google Play Store
  • "APPLE_APP_STORE" - Apps de Apple App Store
  • "AMAZON_APP_STORE" - Apps de Amazon App Store
  • "MICROSOFT_APP_STORE" - Apps de Microsoft Store
  • "TIKTOK" - Perfiles de TikTok
  • "INSTAGRAM" - Perfiles de Instagram
  • "THREADS" - Perfiles de Threads
  • "MEDIUM" - Artículos/perfiles de Medium
  • "CHROME_WEB_STORE" - Extensiones de Chrome
  • "MOZILLA_ADDONS" - Complementos de Firefox
  • "OPERA_ADDONS" - Complementos de Opera
  • "EMAIL" - Direcciones de correo electrónico
  • "PATREON" - Perfiles de Patreon
  • "OPENSEA" - Colecciones/perfiles de OpenSea
  • "FARCASTER" - Perfiles de Farcaster
  • "IPFS" - Hashes de IPFS
  • "GOOGLE_FORM" - Formularios de Google Forms
  • "WHATSAPP" - Contactos de WhatsApp
  • "DISCORD_USER" - Usuarios de Discord
  • "QUORA" - Perfiles/publicaciones de Quora
  • "GITHUB" - Repositorios/perfiles de GitHub
  • "TEACHABLE" - Cursos de Teachable
  • "SUBSTACK" - Publicaciones de Substack
  • "DEBANK" - Perfiles de DeBank
  • "TAWK_TO" - Widgets de chat de Tawk.to
  • "JOTFORM" - Formularios de JotForm
  • "PRIMAL" - Perfiles de Primal
  • "BLUESKY" - Perfiles de Bluesky
  • "SNAPCHAT" - Perfiles de Snapchat
  • "DESO" - Perfiles de DeSo
  • "PINTEREST" - Perfiles/pines de Pinterest

Esquema de la respuesta

Cuerpo de la respuesta

Objeto de resultado de amenaza

Cada elemento del arreglo threats tiene la siguiente estructura:

Ejemplo de respuesta completa

Control de acceso

La API aplica un control de acceso estricto según tu clave de API:
  1. Claves de API de organización:
    • Solo pueden acceder a las amenazas de su organización asociada
    • Devuelven solo las amenazas que fueron bloqueadas por la organización
    • Ejemplo: una clave de API de “acme-org” solo puede consultar las amenazas bloqueadas por “acme-org”
  2. Claves de API de usuario:
    • Pueden acceder a las amenazas de cualquier organización de la que el usuario sea miembro
    • Requieren que el usuario sea un miembro activo de la organización consultada
Si intentas acceder a las amenazas sin los permisos adecuados, recibirás un error 401 Unauthorized con el mensaje: “Valid API key required”

Comportamiento predeterminado

  • Rango de fechas: Si no se proporciona startDate ni endDate, la API devuelve de forma predeterminada las amenazas del último día. Si solo se envía startDate, endDate toma como valor predeterminado el momento actual; si solo se envía endDate, startDate toma como valor predeterminado un día antes de esa fecha
  • Bloqueos pendientes: Se excluyen a menos que includePending sea true
  • Paginación: Si no se proporciona next_page, devuelve la primera página de resultados
  • Ordenamiento: De forma predeterminada ordena por id en orden ascendente
  • Tamaño de página: De forma predeterminada son 10 resultados por página (máx. 100)

Implementación de ejemplo

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 threats request body

Defaults to getting all threats in the last 1 day.

You can also choose a startDate and endDate for the range of threat updates, most timestamp formats should work, we use Luxon for parsing the dates.

query
string

Search query to filter threats by content

startDate
string

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

endDate
string

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

assetType
enum<string>[]

Filter by asset types

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
includePending
boolean
predeterminado:false

Also return threats confirmed malicious but not yet enforced because protection is not active for your organization (shown as "Pending Blocked" in the ChainPatrol app). These carry pendingStatus: BLOCKED. Defaults to false, which returns only assets on the blocklist.

sorting
object[]

Sorting configuration

per_page
integer
predeterminado:10

The number of threats to return per page

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

Cursor for fetching the next page of results

Respuesta

Successful response

Successful operation

threats
object[]
requerido
next_page
string | null

Cursor for fetching the next page of results