List Threats

​

Quick Start

​

Authentication

X-API-KEY: <api-key>

​

Example Request

curl --request POST \
  --url https://api.chainpatrol.io/threats/list \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
    "query": "phishing",
    "assetType": ["URL", "ADDRESS"],
    "startDate": "2024-01-01",
    "endDate": "2024-01-31",
    "per_page": 50,
    "sorting": [
      {
        "key": "blockedAt",
        "direction": "desc"
      }
    ]
  }'

​

Request Schema

​

Request Body

​

Sorting Configuration

​

Available Sort Fields

• "id" - Sort by threat ID
• "blockedAt" - Sort by when the asset was blocked
• "content" - Sort by threat content
• "type" - Sort by asset type

​

Asset Type Filter

​

Response Schema

​

Response Body

{
  threats: ThreatResult[];
  next_page: string | null;
}

​

Threat Result Object

​

Complete Response Example

{
  "threats": [
    {
      "id": 12345,
      "content": "https://fake-site.com",
      "type": "URL",
      "blockedAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "id": 12346,
      "content": "eip155:1:0x1234567890123456789012345678901234567890",
      "type": "ADDRESS",
      "blockedAt": "2024-01-15T09:15:00.000Z"
    },
    {
      "id": 12347,
      "content": "twitter.com/fake_account",
      "type": "TWITTER",
      "blockedAt": "2024-01-15T08:45:00.000Z"
    }
  ],
  "next_page": "12348"
}

​

Access Control

1. Organization API Keys:
   • Can only access threats for their associated organization
   • Returns only threats that were blocked by the organization
   • Example: An API key for “acme-org” can only query threats blocked by “acme-org”
2. User API Keys:
   • Can access threats for any organization where the user is a member
   • Requires the user to be an active member of the queried organization

​

Default Behavior

• Date Range: If no startDate or endDate is provided, the API defaults to returning threats from the last 1 day
• Pagination: If no next_page is provided, returns the first page of results
• Sorting: Defaults to sorting by id in ascending order
• Page Size: Defaults to 10 results per page (max 100)

​

Example Implementation

async function fetchThreats(params) {
  const response = await fetch("https://api.chainpatrol.io/threats/list", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "X-API-KEY": "<api-key>",
    },
    body: JSON.stringify(params),
  });
  return response.json();
}

// Example usage
fetchThreats({
  query: "phishing",
  assetType: ["URL", "ADDRESS"],
  startDate: "2024-01-01",
  endDate: "2024-01-31",
  per_page: 50,
  sorting: [
    {
      key: "blockedAt",
      direction: "desc",
    },
  ],
})
  .then((data) => {
    console.log("Threats found:", data.threats.length);
    data.threats.forEach((threat) => {
      console.log(`ID: ${threat.id}`);
      console.log(`Content: ${threat.content}`);
      console.log(`Type: ${threat.type}`);
      console.log(`Blocked At: ${threat.blockedAt}`);
      console.log("---");
    });

    if (data.next_page) {
      console.log("More results available with next_page:", data.next_page);
    }
  })
  .catch((error) => console.error("Error fetching threats:", error));