POST
/
asset
/
list

The /asset/list API will soon require an API Key, whereas previously this API was usable without an API Key. Please double check you are using a ChainPatrol issued API key.

We’ve recently updated this endpoint to support pagination. If you encounter errors related to payload size, please consider using the pagination feature as described below.

​
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:

Authorizations

​
X-API-KEY
string
headerrequired

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at [email protected] 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
​
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

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

200 - application/json

Successful operation

​
assets
object[]
required
​
next_page
string | null

Cursor for fetching the next page of results

Was this page helpful?

Asset SubmitAsset Changelog