Sanctions Page API
Paginated search across sanctioned entities, with filtering by country, datasource and topic.
ENDPOINTS
POST /api/v1/sanctions/page
Request parameters
keyword
string
Search keyword.
- Required:
Yes - Example:
TCL LIMITED
datasourceType
integer
Data source type. 1 = collection, 2 = dataset.
- Required:
No - Example:
1
datasourceId
string
Data source ID.
- Required:
No - Example:
default
current
integer
Current page number. Default: 1.
- Required:
Yes - Example:
1
size
integer
Page size. Default: 10, max: 50.
- Required:
Yes - Example:
10
f_country
array
Filter by country ISO2 codes.
- Required:
No - Example:
["cn", "pk"]
f_datasource
array
Filter by datasource keys.
- Required:
No - Example:
["us_trade_csl"]
f_topics
array
Filter by topic keys.
- Required:
No - Example:
["sanction"]
Request Example
{
"keyword": "TCL LIMITED",
"datasourceType": 1,
"datasourceId": "default",
"current": 1,
"size": 10,
"f_country": [
"cn",
"pk"
],
"f_datasource": [
"us_trade_csl"
],
"f_topics": [
"sanction"
]
}
curl https://api.tradedata.io/api/v1/sanctions/page \
-H "Authorization: Bearer yourTokenHere" \
-H "Content-Type: application/json" \
-d '{"keyword": "TCL LIMITED", "datasourceType": 1, "datasourceId": "default", "current": 1, "size": 10, "f_country": ["cn", "pk"], "f_datasource": ["us_trade_csl"], "f_topics": ["sanction"]}'
import requests
response = requests.post(
"https://api.tradedata.io/api/v1/sanctions/page",
headers={
"Authorization": "Bearer yourTokenHere",
"Content-Type": "application/json",
},
json={
"keyword": "TCL LIMITED",
"datasourceType": 1,
"datasourceId": "default",
"current": 1,
"size": 10,
"f_country": [
"cn",
"pk",
],
"f_datasource": [
"us_trade_csl",
],
"f_topics": [
"sanction",
],
},
)
print(response.json())
const response = await fetch("https://api.tradedata.io/api/v1/sanctions/page", {
method: "POST",
headers: {
"Authorization": "Bearer yourTokenHere",
"Content-Type": "application/json",
},
body: JSON.stringify({
"keyword": "TCL LIMITED",
"datasourceType": 1,
"datasourceId": "default",
"current": 1,
"size": 10,
"f_country": [
"cn",
"pk"
],
"f_datasource": [
"us_trade_csl"
],
"f_topics": [
"sanction"
]
}),
});
const data = await response.json();
<?php
$ch = curl_init("https://api.tradedata.io/api/v1/sanctions/page");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer yourTokenHere",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"keyword" => "TCL LIMITED",
"datasourceType" => 1,
"datasourceId" => "default",
"current" => 1,
"size" => 10,
"f_country" => [
"cn",
"pk"
],
"f_datasource" => [
"us_trade_csl"
],
"f_topics" => [
"sanction"
]
]),
]);
echo curl_exec($ch);
Response parameters
data
array
Matched entity list.
data.schema
string
Entity schema type.
- Example:
Company
data.highLightName
array
Name with search term highlighted in <em> tags.
data.first_seen
string
Date the entity first appeared in the dataset.
- Example:
2024-10-30T14:10:02
data.last_change
string
Date of the last data change.
- Example:
2026-01-31T16:05:18
data.caption
string
Primary display name.
- Example:
3K Group Limited
data.id
string
Entity ID — use in /sanctions/detail.
- Example:
f77cd246ea5daf26e3b5f7677787bc56a66db06b9472ca141ea660155fd0f7b9
data.properties
object
Entity properties (name, address, topics, etc.).
data.highLightCaption
string
Caption with search term highlighted in <em> tags.
data.countryInfo
array
Country information for this entity.
data.countryInfo.iso3Code
string
Country ISO3 code.
- Example:
HKG
data.countryInfo.countryName
string
Country name.
- Example:
HongKong, China
total
integer
Total matching records.
- Example:
458
pageSize
integer
Page size.
- Example:
10
current
integer
Current page number.
- Example:
1
Response Example
{
"code": 200,
"success": true,
"data": [
{
"schema": "Company",
"highLightName": [],
"first_seen": "2024-10-30T14:10:02",
"last_change": "2026-01-31T16:05:18",
"caption": "3K Group Limited",
"id": "f77cd246ea5daf26e3b5f7677787bc56a66db06b9472ca141ea660155fd0f7b9",
"countryInfo": [
{
"iso3Code": "HKG",
"countryName": "HongKong, China"
}
],
"properties": {
"country": [
"hk"
],
"topics": [
"sanction"
],
"name": [
"3K GROUP LIMITED"
]
},
"highLightCaption": "3K Group <em>Limited</em>"
}
],
"msg": "OK",
"total": 458,
"pageSize": 10,
"current": 1,
"sumResult": null
}