Sanctions Search API
Full-text search across sanctioned entities, returning matching entities with schema type, names and ID.
ENDPOINTS
POST /api/v1/sanctions/search
Request parameters
keyword
string
Search keyword.
- Required:
Yes - Example:
MARKETS
datasourceType
integer
Data source type. 1 = collection, 2 = dataset.
- Required:
No - Example:
2
datasourceId
string
Data source ID. Use ID from /sanctions/collection or /sanctions/datasets.
- Required:
No - Example:
gem_energy_ownership
Request Example
{
"keyword": "MARKETS",
"datasourceType": 2,
"datasourceId": "gem_energy_ownership"
}
curl https://api.tradedata.io/api/v1/sanctions/search \
-H "Authorization: Bearer yourTokenHere" \
-H "Content-Type: application/json" \
-d '{"keyword": "MARKETS", "datasourceType": 2, "datasourceId": "gem_energy_ownership"}'
import requests
response = requests.post(
"https://api.tradedata.io/api/v1/sanctions/search",
headers={
"Authorization": "Bearer yourTokenHere",
"Content-Type": "application/json",
},
json={
"keyword": "MARKETS",
"datasourceType": 2,
"datasourceId": "gem_energy_ownership",
},
)
print(response.json())
const response = await fetch("https://api.tradedata.io/api/v1/sanctions/search", {
method: "POST",
headers: {
"Authorization": "Bearer yourTokenHere",
"Content-Type": "application/json",
},
body: JSON.stringify({
"keyword": "MARKETS",
"datasourceType": 2,
"datasourceId": "gem_energy_ownership"
}),
});
const data = await response.json();
<?php
$ch = curl_init("https://api.tradedata.io/api/v1/sanctions/search");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer yourTokenHere",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"keyword" => "MARKETS",
"datasourceType" => 2,
"datasourceId" => "gem_energy_ownership"
]),
]);
echo curl_exec($ch);
Response parameters
data
array
Matched entity list.
data.schema
string
Entity schema type (e.g. Person, Company, Vessel).
- Example:
Company
data.names
array
All known names for this entity.
data.caption
string
Primary display name.
- Example:
Statkraft Markets
data.id
string
Entity ID — use in /sanctions/detail.
- Example:
37155cd82e152a9c4f2f6f8d200ba9b3ac6986b48d2fc63301769a4567cdf119
Response Example
{
"code": 200,
"success": true,
"data": [
{
"schema": "Company",
"names": [
"Statkraft Markets"
],
"caption": "Statkraft Markets",
"id": "37155cd82e152a9c4f2f6f8d200ba9b3ac6986b48d2fc63301769a4567cdf119"
}
],
"msg": "success",
"total": 0,
"pageSize": 0,
"current": 0,
"sumResult": null
}