> ## 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.

# Descripción general del SDK de JavaScript de ChainPatrol

> El SDK de JavaScript de ChainPatrol ofrece ThreatDetector, Relay, Storage y herramientas de cliente de API para proteger a los usuarios de tu app frente a URL de phishing y estafas.

El **phishing** y las **URL de estafa** son un problema enorme en internet.
Para que a quienes desarrollan wallets, dApps y otras apps enfocadas en la seguridad les resulte más fácil
proteger a sus usuarios de estas amenazas, creamos un SDK de JavaScript que puedes usar para
interactuar con nuestras API de detección de amenazas.

```js theme={null}
import { ThreatDetector } from "@chainpatrol/sdk";

const detector = new ThreatDetector({
  mode: "cloud",
  apiKey: "YOUR_API_KEY",
});

const result = await detector.url("https://scam-site.com");
```

## Instalación

> [tab] npm
>
> ```bash theme={null}
> npm install --save @chainpatrol/sdk
> ```

> [tab] yarn
>
> ```bash theme={null}
> yarn add @chainpatrol/sdk
> ```

> [tab] pnpm
>
> ```bash theme={null}
> pnpm add @chainpatrol/sdk
> ```

## Características

> [card] Compatibilidad con TypeScript
>
> Escrito en TypeScript con definiciones de tipos completas

> [card] Multiplataforma
>
> Funciona en todos los navegadores modernos, en Node.js y en extensiones de navegador

> [card] Liviano
>
> Dependencias mínimas

> [card] Pensado para escalar
>
> Diseñado con caché y límite de solicitudes (rate limiting) integrados

## Exportaciones

| Nombre | Descripción |
| :- | :- |
| [ThreatDetector](./threat-detector) | Una interfaz sencilla para detectar URL de phishing |
| [Storage](./storage) | Implementación de caché de almacenamiento para ThreatDetector |
| [Relay](./relay) | Un relay de mensajes para compartir eventos entre los contextos de una extensión de navegador |
| [ChainPatrolClient](./chainpatrol-client) | Se usa para crear un cliente que se conecta a la API de ChainPatrol |


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