Saltar al contenido principal
GET
List organization assets

Descripción general

Lista todos los assets (Asset: activo digital, como una URL, dirección, perfil, app, etc.) que pertenecen a tu organización, con filtros opcionales por tipo, grupo y consulta de búsqueda. La organización se infiere automáticamente a partir de tu clave de API. Este endpoint admite paginación para manejar de forma eficiente colecciones grandes de assets.

Inicio rápido

Autenticación

Todos los endpoints de organización requieren una clave de API con acceso a la organización. Incluye tu clave de API en el encabezado X-API-KEY:

Solicitud de ejemplo

Parámetros de consulta

Respuesta

Respuesta exitosa

Campos de la respuesta

Paginación

Para obtener todos los assets, usa el cursor next_page que se devuelve en cada respuesta:

Ejemplos de filtrado

Filtrar por tipo

Obtén solo los assets de tipo URL:

Filtrar por grupo

Obtén los assets de un grupo específico:
Obtén solo los assets sin grupo:

Buscar assets

Busca assets que contengan “wallet”:

Combinar filtros

Obtén los assets de tipo URL del grupo 1 que contengan “main”:

Respuestas de error

401 Unauthorized

Se devuelve cuando falta la clave de API, no es válida o no tiene acceso a la organización:

400 Bad Request

Se devuelve cuando los parámetros de consulta no son válidos:

Buenas prácticas

Paginación

  • Usa per_page=500 o más para operaciones masivas, a fin de minimizar las llamadas a la API
  • Usa per_page=50-100 para la paginación en la interfaz, a fin de ofrecer una experiencia de usuario ágil
  • Revisa siempre si la respuesta incluye next_page para determinar si hay más resultados

Filtrado

  • Aplica los filtros del lado del servidor en lugar de obtener todos los assets y filtrarlos del lado del cliente
  • Combina filtros para acotar los resultados de forma eficiente
  • Usa el parámetro query para funciones de búsqueda impulsadas por el usuario

Rendimiento

  • Guarda en caché las listas de assets cuando corresponda para reducir las llamadas a la API
  • Usa valores de per_page adecuados según tu caso de uso
  • Considera implementar una carga incremental para conjuntos de datos grandes

Notas

  • La organización se determina automáticamente a partir de tu clave de API
  • Todas las marcas de tiempo están en formato ISO 8601 con zona horaria UTC
  • El status de los assets de la organización normalmente es ALLOWED
  • El campo group es null cuando un asset no está asignado a ningún grupo
  • El cursor next_page es opaco y no se debe analizar ni modificar

Autorizaciones

X-API-KEY
string
header
requerido

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.

Parámetros de consulta

slug
string
type
enum<string>
Opciones disponibles:
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,
APK_GOLD,
GLASSDOOR,
PUMP_FUN,
TUMBLR,
MASTODON
groupId
integer
query
string
per_page
integer
predeterminado:100

The number of assets to return per page (max 1000)

Rango requerido: 1 <= x <= 1000
next_page
string | null

Cursor for fetching the next page of results

Respuesta

Successful response

Successful operation

assets
object[]
requerido

List of assets

next_page
string | null

Cursor for fetching the next page of results