Download the full entity list for a source list

Updated

The GET /screen/lists/{slug}/entities endpoint returns every identifier currently active on a single source list, in either JSON or CSV format. It is free and unauthenticated — no API token needed. This is the same dataset that powers the screening endpoints, published for reference, bulk download, and offline analysis.

How to use it

  1. Find the slug for the list you want by calling GET /screen/lists. Valid slugs include values like ofac, eu_fsf, il_mod_crypto, and others shown in that response.
  2. Call GET /api/v1/screen/lists/{slug}/entities, replacing {slug} with your chosen list's slug.
  3. To download a CSV instead of JSON, add ?format=csv to the request.
  4. Use ?limit= to control how many entities are returned in one response (default 5000, maximum 100000). The total field in the JSON response always reports the full list size, regardless of the limit applied.
# JSON downloadcurl "https://api.compliapi.com/api/v1/screen/lists/ofac/entities"

# CSV downloadcurl "https://api.compliapi.com/api/v1/screen/lists/ofac/entities?format=csv"

Response format

The JSON response includes the list's slug, display_name, list_type, total entity count, last_updated timestamp, and an entities array. Each entity has an entity_type (onchain_address, email, website, or government_id), a value, a source_url, a listed_at timestamp, and a metadata object. The CSV format uses fixed columns — value, entity_type, listed_at, source_url — plus one additional column per metadata key that the list carries, so the exact columns vary by list.

Tips and limits

  • Delisted entities are not included. Only currently active entries appear in this response. Identifiers that have been removed from a list appear on the GET /delisted endpoint instead.
  • Unknown or disabled list slugs return 404. Verify your slug against GET /screen/lists before making the request.
  • This endpoint is intended for bulk reference and download, not for real-time screening decisions. For production compliance checks with audit logging and a sanctioned/flagged verdict, use the /screen/* endpoints.

← All articles

Powered by Shipstar