Embargo | Node.js SDK

The Pangea Embargo API lets developers quickly check IPs and country codes against known sanction and trade embargo lists.

Embargo

constructor(token: string, config: PangeaConfig): EmbargoService

Creates a new EmbargoService with the given Pangea API token and configuration.

required parameters

token

string

Pangea API token.

configPangeaConfig

Configuration.

Response Object

EmbargoService

const config = new PangeaConfig({ domain: "pangea_domain" });
const embargo = new EmbargoService("pangea_token", config);

Check IP

ipCheck(ipAddress: string): Promise<PangeaResponse<CheckResult>>

Check an IP against known sanction and trade embargo lists.

required parameters

ipAddress

string

Geolocate this IP and check the corresponding country against the enabled embargo lists.

Response Object

CheckResult

Promise<PangeaResponse<CheckResult>>

const response = await embargo.ipCheck("190.6.64.94");

ISO code check

isoCheck(isoCode: string): Promise<PangeaResponse<CheckResult>>

Check a country code against known sanction and trade embargo lists.

required parameters

isoCode

string

Check the country against code the enabled embargo lists.

Response Object

CheckResult

Promise<PangeaResponse<CheckResult>>

const response = await embargo.isoCheck("CU");

post(endpoint: string, data: object, options: PostOptions): Promise<PangeaResponse<R>>

POST request.

required parameters

endpoint

string

Endpoint path.

data

object

Request body.

optionsPostOptions

Additional options.

Response Object

R

Promise<PangeaResponse<R>>

Interface CheckResult

CheckResult

required parameters

sanctionsArray<Sanction>

Interface Sanction

Sanction

required parameters

annotations

object

embargoed_country_iso_code

string

embargoed_country_name

string

issuing_country

string

list_name

string