Asset List

List assets

curl --request POST \
  --url https://app.chainpatrol.io/api/v2/asset/list \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "status": "BLOCKED",
  "startDate": "<string>",
  "endDate": "<string>",
  "per_page": 100,
  "next_page": "<string>"
}
'

import requests

url = "https://app.chainpatrol.io/api/v2/asset/list"

payload = {
    "status": "BLOCKED",
    "startDate": "<string>",
    "endDate": "<string>",
    "per_page": 100,
    "next_page": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    status: 'BLOCKED',
    startDate: '<string>',
    endDate: '<string>',
    per_page: 100,
    next_page: '<string>'
  })
};

fetch('https://app.chainpatrol.io/api/v2/asset/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chainpatrol.io/api/v2/asset/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => 'BLOCKED',
    'startDate' => '<string>',
    'endDate' => '<string>',
    'per_page' => 100,
    'next_page' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chainpatrol.io/api/v2/asset/list"

	payload := strings.NewReader("{\n  \"status\": \"BLOCKED\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"per_page\": 100,\n  \"next_page\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.chainpatrol.io/api/v2/asset/list")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"BLOCKED\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"per_page\": 100,\n  \"next_page\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chainpatrol.io/api/v2/asset/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"BLOCKED\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"per_page\": 100,\n  \"next_page\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "assets": [
    {
      "id": 123,
      "content": "<string>",
      "blockedAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "next_page": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

POST

asset

list

List assets

curl --request POST \
  --url https://app.chainpatrol.io/api/v2/asset/list \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "status": "BLOCKED",
  "startDate": "<string>",
  "endDate": "<string>",
  "per_page": 100,
  "next_page": "<string>"
}
'

import requests

url = "https://app.chainpatrol.io/api/v2/asset/list"

payload = {
    "status": "BLOCKED",
    "startDate": "<string>",
    "endDate": "<string>",
    "per_page": 100,
    "next_page": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    status: 'BLOCKED',
    startDate: '<string>',
    endDate: '<string>',
    per_page: 100,
    next_page: '<string>'
  })
};

fetch('https://app.chainpatrol.io/api/v2/asset/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chainpatrol.io/api/v2/asset/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => 'BLOCKED',
    'startDate' => '<string>',
    'endDate' => '<string>',
    'per_page' => 100,
    'next_page' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chainpatrol.io/api/v2/asset/list"

	payload := strings.NewReader("{\n  \"status\": \"BLOCKED\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"per_page\": 100,\n  \"next_page\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.chainpatrol.io/api/v2/asset/list")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"BLOCKED\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"per_page\": 100,\n  \"next_page\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chainpatrol.io/api/v2/asset/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"BLOCKED\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"per_page\": 100,\n  \"next_page\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "assets": [
    {
      "id": 123,
      "content": "<string>",
      "blockedAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "next_page": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Quick Start

Authentication

Include your API key in the X-API-KEY header:

X-API-KEY: <api-key>

Sync Strategy and Removals

When using time-based filtering (e.g., fetching only the last 5 minutes of blocklist data), you may miss asset removals from the blocklist. To ensure complete data consistency, use one of these approaches:

Recommended Approaches

Monitor allowlist and unknown list for removals: Check both the allowlist and unknown list endpoints periodically to detect assets that have been removed from the blocklist.
Periodic full sync: Perform a complete sync of the full blocklist at regular intervals (e.g., hourly or daily) to catch any missed changes.
Hybrid approach: Use time-based filtering for frequent updates combined with periodic full syncs for comprehensive coverage.

Why This Matters

Asset status changes can move assets between different lists (blocklist, allowlist, unknown). Time-based queries on a single endpoint may not capture these transitions, potentially leaving your local cache with outdated information about blocked assets that should no longer be blocked.

Pagination

To use pagination, include the per_page and next_page parameters in your request:

per_page <number>: Number of items to return per page (max: 10000)
next_page <string>: Cursor for the next page of results

Example implementation for pagination:

async function fetchAllAssets(type, status) {
  let allAssets = [];
  let nextPage = null;
  while (true) {
    const response = await fetch(
      "https://app.chainpatrol.io/api/v2/asset/list",
      {
        method: "POST",
        headers: {
          "Content-Type": "application/json",
          "X-API-KEY": "YOUR_API_KEY_HERE",
        },
        body: JSON.stringify({
          type,
          status,
          per_page: 500,
          next_page: nextPage,
        }),
      }
    );
    const data = await response.json();
    allAssets = allAssets.concat(data.assets);
    nextPage = data.next_page;
    if (!nextPage) {
      break;
    }
  }
  return allAssets;
}
fetchAllAssets("URL", "BLOCKED")
  .then((assets) => console.log("All assets:", assets))
  .catch((error) => console.error("Error fetching assets:", error));

async function fetchAllAssets(type: string, status: string): Promise<any[]> {
  let allAssets: any[] = [];
  let nextPage: string | null = null;

  while (true) {
    const response = await fetch(
      "https://app.chainpatrol.io/api/v2/asset/list",
      {
        method: "POST",
        headers: {
          "Content-Type": "application/json",
          "X-API-KEY": "YOUR_API_KEY_HERE",
        },
        body: JSON.stringify({
          type,
          status,
          per_page: 500,
          next_page: nextPage,
        }),
      }
    );
    const data = await response.json();
    allAssets = allAssets.concat(data.assets);
    nextPage = data.next_page;

    if (!nextPage) {
      break;
    }
  }
  return allAssets;
}

fetchAllAssets("URL", "BLOCKED")
  .then((assets) => console.log("All assets:", assets))
  .catch((error) => console.error("Error fetching assets:", error));

import requests

def fetch_all_assets(type: str, status: str) -> list:
    all_assets = []
    next_page = None
    while True:
        response = requests.post(
            "https://app.chainpatrol.io/api/v2/asset/list",
            headers={
                "Content-Type": "application/json",
                "X-API-KEY": "YOUR_API_KEY_HERE",
            },
            json={
                "type": type,
                "status": status,
                "per_page": 500,
                "next_page": next_page,
            },
        )
        data = response.json()
        all_assets.extend(data["assets"])
        next_page = data.get("next_page")
        if not next_page:
            break
    return all_assets

try:
    assets = fetch_all_assets("URL", "BLOCKED")
    print("All assets:", assets)
except Exception as error:
    print("Error fetching assets:", str(error))

Authorizations

X-API-KEY

string

header

required

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.

Body

application/json

List asset request body

Defaults to getting all the updates in the last 1 day.

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>

required

Asset type

Available options:

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

status

enum<string>

default:BLOCKED

Status of the assets to retrieve

Available options:

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

default:100

The number of assets to return per page

Required range: 1 <= x <= 10000

next_page

string | null

Cursor for fetching the next page of results

Response

Successful response

Successful operation

assets

object[]

required

Show child attributes

next_page

string | null

Cursor for fetching the next page of results

⌘I

External API

Assets

Blocklist Sync

Organization Assets

Organization Asset Groups

Organization Brands

Reports

Organization Reports

Threats

Disputes

Takedowns

Organization Metrics

Operations

Healthchecks

Account & Access

Webhooks

Quick Start

Authentication

Sync Strategy and Removals

Recommended Approaches

Why This Matters

Authorizations

Body

Response

​Quick Start

​Authentication

​Sync Strategy and Removals

​Recommended Approaches

​Why This Matters

​Pagination

​Example implementation for pagination:

Authorizations

Body

Response

Quick Start

Authentication

Sync Strategy and Removals

Recommended Approaches

Why This Matters

Pagination

Example implementation for pagination: