ChainPatrolClient Overview

The ChainPatrolClient class connects your Node.js or browser JavaScript app to the ChainPatrol API for asset checks, listings, and submissions.

A ChainPatrolClient allows you to interface with the ChainPatrol API from a Node.js or browser application.

import { ChainPatrolClient } from "@chainpatrol/sdk";

const chainpatrol = new ChainPatrolClient({ apiKey: "<API_KEY>" });

​

Constructor

​

new ChainPatrolClient()

Creates a new ChainPatrolClient instance.

---

​

Instance Methods

​

asset.check()

Checks the status of an asset to see if it is malicious or not.

​

asset.list()

Lists all assets (and their statuses) that have been reviewed by ChainPatrol.

​

asset.submit()

Submits up to 100 assets to ChainPatrol for automated classification.

​

report.create()

Creates a report with one or more assets for ChainPatrol to review.