OpenSanctions Entities Scraper
Pricing
Pay per event
OpenSanctions Entities Scraper
Stream public OpenSanctions entities for AML/KYC screening. Filter sanctions, PEPs, companies, vessels, and watchlists by dataset, topic, schema, country, or name.
OpenSanctions Entities Scraper
Pricing
Pay per event
Stream public OpenSanctions entities for AML/KYC screening. Filter sanctions, PEPs, companies, vessels, and watchlists by dataset, topic, schema, country, or name.
You can access the OpenSanctions Entities Scraper programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, youโll need an Apify account and your API token, found in API & Integrations in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "0.1", "x-build-id": "y0RY4rKZ6myF5A1Au" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~opensanctions-entities-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-opensanctions-entities-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/automation-lab~opensanctions-entities-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-opensanctions-entities-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/automation-lab~opensanctions-entities-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-opensanctions-entities-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "datasetSlug": { "title": "OpenSanctions dataset slug", "type": "string", "description": "Dataset folder from data.opensanctions.org. Use default for the aggregated OpenSanctions export, or values such as sanctions, peps, wikidata, or another public dataset slug.", "default": "default" }, "exportUrl": { "title": "Custom entities.ftm.json URL", "type": "string", "description": "Optional full HTTPS OpenSanctions export URL. Leave empty to use datasetSlug with the latest public export." }, "maxItems": { "title": "Maximum entities to save", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum matching entity records to push to the dataset.", "default": 10 }, "maxScanLines": { "title": "Maximum export lines to scan", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Safety cap for streaming large OpenSanctions exports. Increase when narrow filters do not appear near the beginning of the file.", "default": 20 }, "schemas": { "title": "Entity schemas", "type": "array", "description": "Optional FollowTheMoney schemas to include, e.g. Person, Company, Organization, Vessel, LegalEntity, Sanction.", "items": { "type": "string" } }, "countries": { "title": "Countries / jurisdictions", "type": "array", "description": "Optional country, nationality, citizenship, jurisdiction, or incorporation country codes/names to include.", "items": { "type": "string" } }, "datasets": { "title": "OpenSanctions source datasets", "type": "array", "description": "Optional source dataset ids to include, e.g. us_ofac_sdn, eu_fsf, wd_peps. Matches the entity datasets array.", "items": { "type": "string" } }, "topics": { "title": "Topics", "type": "array", "description": "Optional inferred topics to include: sanctions, peps, crime, debarment, watchlists.", "items": { "type": "string" } }, "nameQuery": { "title": "Name / caption contains", "type": "string", "description": "Optional case-insensitive substring matched against caption, names, and aliases." }, "targetOnly": { "title": "Only target entities", "type": "boolean", "description": "When enabled, only return entities marked as OpenSanctions screening targets.", "default": false }, "includeProperties": { "title": "Include raw properties", "type": "boolean", "description": "Include the raw FollowTheMoney properties object for downstream mapping. This can make dataset rows much larger.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for OpenSanctions Entities Scraper from the options below:
If youโd like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: