International IP Pro

Was this page helpful?

URL	Request Methods	Content-Type	Output Format	Character Set
api-base-url?partner_code=xxx&partner_key=xxx	POST	application/json	JSON	UTF-8

URL

Request Methods

Content-Type

Output Format

Character Set

api-base-url?partner_code=xxx&partner_key=xxx

POST

application/json

JSON

UTF-8

Parameter	Type	Description	Required/Optional	Notes
partner_code	String	Partner Code	required	assigned by TD
partner_key	String	Partner Key	required	assigned by TD

Parameter

Type

Description

Required/Optional

Notes

partner_code

String

Partner Code

required

assigned by TD

partner_key

String

Partner Key

required

assigned by TD

Parameter	Type	Description	Required/Optional	Notes
ip	String	Public IP Address	required	IPV4 and IPV6 supported

Parameter

Type

Description

Required/Optional

Notes

String

Public IP Address

required

IPV4 and IPV6 supported

Parameter	Type	Description	Notes
code	Integer	API Status Code
message	String	Status Message	specific abnormal reasons will be provided if the API is abnormal
sequence_id	String	Unique ID of Response	A unique ID used to mark each request
continent	String	Continent
country_id	String	Country ID
country	String	Country
province	String	Province
city	String	City
longitude	String	Longitude
latitude	String	Latitude
owner	String	Owner
operator	String	Operator
zip_code	String	Zip Code
time_zone	String	Time Zone
domain	String	Domain
asn	String	AS Number
as	String	AS Name
risk_score	Integer	Risk Score	range: 0 - 100
scenario	String	Scenario	enumeration: reserved unallocated unrouted unused used isp idc ixp school satellite_comms enterprise organization home_broadband mobile_network wlan infra dedicated anycast cdn
authenticity_score	Integer	Authenticity Score	range: 0 - 100
network_risk_labels	Array	Network Risk	proxy idc vpn dynamic tor scan brute_force
risk_labels	Array	Behavioral Risk	tampered_device fake_device high_risk_device

Parameter

Type

Description

Notes

code

Integer

API Status Code

message

String

Status Message

specific abnormal reasons will be provided if the API is abnormal

sequence_id

String

Unique ID of Response

A unique ID used to mark each request

continent

String

Continent

country_id

String

Country ID

country

String

Country

province

String

Province

city

String

City

longitude

String

Longitude

latitude

String

Latitude

owner

String

Owner

operator

String

Operator

zip_code

String

Zip Code

time_zone

String

Time Zone

domain

String

Domain

asn

String

AS Number

String

AS Name

risk_score

Integer

Risk Score

range: 0 - 100

scenario

String

Scenario

enumeration:
reserved
unallocated
unrouted
unused
used
isp
idc
ixp
school
satellite_comms
enterprise
organization
home_broadband
mobile_network
wlan
infra
dedicated
anycast
cdn

authenticity_score

Integer

Authenticity Score

range: 0 - 100

network_risk_labels

Array

Network Risk

proxy
idc
vpn
dynamic
tor
scan
brute_force

risk_labels

Array

Behavioral Risk

tampered_device
fake_device
high_risk_device

code	Description
200	Success
301	Service not purchased
302	Traffic blocked
303	Traffic insufficient
304	Service expired
305	Daily maximum volume reached
9600	System error
9601	Illegal ip
9606	Illegal parameter

code

Description

200

Success

301

Service not purchased

302

Traffic blocked

303

Traffic insufficient

304

Service expired

305

Daily maximum volume reached

9600

System error

9601

Illegal ip

9606

Illegal parameter

{ "code": 200, "message": "", "sequence_id": "1648777165770866F82AC7F326307055", "continent": "Asian", "country_id": "CN", "country": "China", "province": "Zhejiang", "city": "Hangzhou", "longitude": "120.288024", "latitude": "30.174930", "owner": "China Mobile", "operator": "China Mobile", "zip_code": "310000", "time_zone": "UTC+8", "domain": "xxx.com", "asn": "4538", "as": "CNIX", "risk_score": 85, "scenario": "idc", "authenticity_score": 30, "network_risk_labels": ["idc", "proxy"], "risk_labels": ["fake_device"] }

URL	Request Methods	Content-Type	Output Format	Character Set
api-base-url?partner_code=xxx&partner_key=xxx	POST	application/json	JSON	UTF-8

URL

Request Methods

Content-Type

Output Format

Character Set

api-base-url?partner_code=xxx&partner_key=xxx

POST

application/json

JSON

UTF-8

Parameter	Type	Description	Required/Optional	Notes
partner_code	String	Partner Code	required	assigned by TD
partner_key	String	Partner Key	required	assigned by TD

Parameter

Type

Description

Required/Optional

Notes

partner_code

String

Partner Code

required

assigned by TD

partner_key

String

Partner Key

required

assigned by TD

Parameter	Type	Description	Required/Optional	Notes
ip	String	Public IP Address	required	IPV4 and IPV6 supported

Parameter

Type

Description

Required/Optional

Notes

String

Public IP Address

required

IPV4 and IPV6 supported

Parameter	Type	Description	Notes
code	Integer	API Status Code
message	String	Status Message	specific abnormal reasons will be provided if the API is abnormal
sequence_id	String	Unique ID of Response	A unique ID used to mark each request
continent	String	Continent
country_id	String	Country ID
country	String	Country
province	String	Province
city	String	City
longitude	String	Longitude
latitude	String	Latitude
owner	String	Owner
operator	String	Operator
zip_code	String	Zip Code
time_zone	String	Time Zone
domain	String	Domain
asn	String	AS Number
as	String	AS Name
risk_score	Integer	Risk Score	range: 0 - 100
scenario	String	Scenario	enumeration: reserved unallocated unrouted unused used isp idc ixp school satellite_comms enterprise organization home_broadband mobile_network wlan infra dedicated anycast cdn
authenticity_score	Integer	Authenticity Score	range: 0 - 100
network_risk_labels	Array	Network Risk	proxy idc vpn dynamic tor scan brute_force
risk_labels	Array	Behavioral Risk	tampered_device fake_device high_risk_device

Parameter

Type

Description

Notes

code

Integer

API Status Code

message

String

Status Message

specific abnormal reasons will be provided if the API is abnormal

sequence_id

String

Unique ID of Response

A unique ID used to mark each request

continent

String

Continent

country_id

String

Country ID

country

String

Country

province

String

Province

city

String

City

longitude

String

Longitude

latitude

String

Latitude

owner

String

Owner

operator

String

Operator

zip_code

String

Zip Code

time_zone

String

Time Zone

domain

String

Domain

asn

String

AS Number

String

AS Name

risk_score

Integer

Risk Score

range: 0 - 100

scenario

String

Scenario

enumeration:
reserved
unallocated
unrouted
unused
used
isp
idc
ixp
school
satellite_comms
enterprise
organization
home_broadband
mobile_network
wlan
infra
dedicated
anycast
cdn

authenticity_score

Integer

Authenticity Score

range: 0 - 100

network_risk_labels

Array

Network Risk

proxy
idc
vpn
dynamic
tor
scan
brute_force

risk_labels

Array

Behavioral Risk

tampered_device
fake_device
high_risk_device

code	Description
200	Success
301	Service not purchased
302	Traffic blocked
303	Traffic insufficient
304	Service expired
305	Daily maximum volume reached
9600	System error
9601	Illegal ip
9606	Illegal parameter

code

Description

200

Success

301

Service not purchased

302

Traffic blocked

303

Traffic insufficient

304

Service expired

305

Daily maximum volume reached

9600

System error

9601

Illegal ip

9606

Illegal parameter

International IP Pro

International IP Pro

API Format#

Base URL#

API#

Authentication

Request#

Request Example#

Response Parameter#

Response Example#

API Format#

Base URL#

API#

Authentication

Request#

Request Example#

Response Parameter#

Response Example#