API interface description
Interface method
Base URL
- China: https://cn.apitd.net/device/v1
- America: https://us.apitd.net/device/v1
- Singapore：https://sg.apitd.net/device/v1
- Germany: https://de.apitd.net/device/v1
- Indonesia: https://id.apitd.net/device/v1
API
| URL | Request method | Content-Type | Output format | Character set |
|---|---|---|---|---|
| api-base-url?partner_code=xxx&partner_key=xxx | POST | application/json | JSON | UTF-8 |
Authentication
| Field | Type | Meaning | Required fields | Remarks |
|---|---|---|---|---|
| partner_code | String | Partner identify | Yes | Provided by TD |
| partner_key | String | Partner secret key | Yes | Provided by TD |
Request
| Field | Type | Meaning | Required fields | Remarks |
|---|---|---|---|---|
| black_box | String | Vouchers for access to device information | Yes | Obtain from SDK |
Example Request
{
"black_box": "aGPH1658920283672ropYaFxT7"
}
Response
| Field | Type | Meaning | Output situation | Remarks |
|---|---|---|---|---|
| code | Integer | interface response status codes | All | Refer to the status code description |
| message | String | status Info | All | Specific reasons for an exception |
| sequence_id | String | unique Identifier ID | All | A unique identifier for each request-response |
| device_id | String | device unique ID | All | Unique identification of the device |
| device_os | String | device type | All | Android、Harmony、iOS、Web |
| device_detail | Object | device details | Pro, Enterprise version | Please see description of device details |
| ip_location | Object | location information corresponding to the IP of the device | Pro, Enterprise version | Please refer to the IP location information description |
| device_risk_score | Integer | device risk score | Pro, Enterprise version | Range 0 - 100 |
| device_risk_label | Array | device risk label list | Enterprise version | Please see the list of device risk labels for descriptions |
| device_risk_tools | Object | device risk tools | Enterprise version | Please refer to the description of the device risk tool |
Device Details
There are differences in the device fields corresponding to different device types and the following lists the field descriptions for the different device types
Android
| Field | Type | Meaning | Remarks |
|---|---|---|---|
| app_version | String | app versions | E.g. "4.1.6" |
| system_version | String | android system versions | E.g. "6.0.1" |
| api_version | String | android API versions | E.g. "23" |
| fp_version | String | SDK versions | E.g. "4.1.6" |
| model | String | device model | E.g. "2014811" |
| brand | String | device Brand | E.g. "Xiaomi" |
| device_name | String | device name | E.g. "HM2014811" |
| network_type | String | network type | E.g. "2g"、"3g"、"4g"、"5g"、"wifi"、"mobile"、"bluetooth_tethering"、"unknown" |
| ip | String | IP address | E.g. "123.157.153.130" |
| time_zone | String | time zone | E.g. "UTC+0800" |
| startup_time | String | boot time | E.g. "2021-01-01 00:00:00" |
| up_time | Long | uptime | E.g. "568273951" |
| charge_state | String | charging status | E.g. "charging"、"full"、"not_charging"、"discharging"、"unknown" |
| battery_level | Integer | electrical quantities | Range 0 - 100 |
| screen_resolution | String | screen resolution | Width x Height，Example："720x1280" |
| screen_brightness | Integer | screen brightness | Range -1 - 256 |
| total_memory | Long | total memory size | Bytes |
| available_memory | Long | available memory size | Bytes |
| total_storage | Long | total storage size | Bytes |
| available_storage | Long | available storage size | Bytes |
| latitude | Double | latitude | Accuracy to 6 decimal places， Example 30.282331 |
| longitude | Double | longitude | Accuracy to 6 decimal places， Example 120.011395 |
| carrier | String | carrier | E.g. "Viettel" |
| bssid | String | bssid | E.g. "00:1a:8c:a0:69:0a" |
| wifi_ip | String | wifi ip | E.g. "10.57.3.135" |
| device_svn | String | device svn | E.g. "07" |
| hardware | String | hardware | E.g. "qcom" |
| dns_address | String | dns address | E.g. "211.137.32.178" |
| product | String | product | E.g. "A37T" |
| host | String | host | E.g. "qh-miui-ota-offline07" |
| sim_operator | String | sim operator | E.g. "Viettel,VinaPhone" |
| ssid | String | ssid | E.g. "xiaoming 的 wifi" |
| vpn_ip | String | vpn ip | E.g. "10.251.37.229" |
| cell_ip | String | cell ip | E.g. "10.3.4.9" |
| current_time | Long | current time | E.g. "1687764437374" |
| package_name | String | package name | E.g. "cn.tongdun. android&3.0.0" |
| language | String | language | E.g. "zh" |
| android_id | String | android id | E.g. "952b0b1edda80b44" |
| cpu_hardware | String | cpu hardware | E.g. "ARMv7 Processor rev 0 (v7l)" |
| cpu_type | String | cpu type | E.g. "Qualcomm Technologies" |
| baseband_version | String | baseband version | E.g. "MPSS.DPM.1.0.c7. 18-00023" |
| mnc | String | mobile network code | E.g. "01" |
| mcc | String | mobile country code | E.g. "460" |
| installed_packages | String | installed packages | E.g. "[{\"package\":\"com.miui.screenrecorder\",\"name\":\"-\"},{\"package\":\"com.miui.fm\",\"name\":\"-\"}]" |
| running_packages | String | running packages | E.g. "com.xiaomi.shop" |
| ipv6 | String | ipv6 | E.g. "fe80::bfd7:21d8:318a:693b" |
| sign_md5 | String | sign md5 | E.g. "6fb472cac420436b773a6325d4cdd7bd" |
| proxy_info | String | proxy info | E.g. "42.235.30.24:8080" |
| country_iso | String | iso country code | E.g. "cn,cn" |
iOS
| Field | Type | Meaning | Remarks |
|---|---|---|---|
| app_version | String | app versions | E.g. "1.0.3" |
| system_version | String | ios system versions | E.g. "10.2.1" |
| fp_version | String | SDK versions | E.g. "4.1.2" |
| model | String | device model | E.g. "iPhone 6s" |
| device_name | String | device name | E.g. "iPhone" |
| network_type | String | network type | E.g. "2g"、"3g"、"4g"、"5g"、"wifi"、"mobile"、"bluetooth_tethering"、"unknown" |
| ip | String | IP address | E.g. "123.157.153.130" |
| time_zone | String | time zone | E.g. "UTC+0800" |
| startup_time | String | boot time | E.g. "2021-01-01 00:00:00" |
| up_time | Long | uptime | E.g. "568273951" |
| charge_state | String | charging status | E.g. "charging"、"unplugged"、"unknown" |
| battery_level | Integer | electrical quantities | Range 0 - 100 |
| screen_resolution | String | screen resolution | Width x Height，Example："720x1280" |
| screen_brightness | Integer | screen brightness | Range 0 - 100 |
| total_memory | Long | total memory size | Bytes |
| available_memory | Long | available memory size | Bytes |
| total_storage | Long | total storage size | Bytes |
| available_storage | Long | available storage size | Bytes |
| latitude | Double | latitude | Accuracy to 6 decimal places， Example 30.282331 |
| longitude | Double | longitude | Accuracy to 6 decimal places， Example 120.011395 |
| current_time | String | current time | E.g. "1687764437374" |
| cell_ip | String | cell ip | E.g. "10.5.2.39" |
| wifi_ip | String | wifi ip | E.g. "192.168.10.111" |
| language | String | language | E.g. "en" |
| carrier | String | carrier | E.g. "Viettel,VinaPhone" |
| mnc | String | mobile network code | E.g. "0" |
| mcc | String | mobile country code | E.g. "460" |
| country_iso | String | iso country code | E.g. "cn" |
| bundle_id | String | bundle id | E.g. "cn.fraudmetrix. FMDeviceManager" |
| proxy_info | String | proxy info | E.g. "10.2.3.4:8080" |
| ssid | String | ssid | E.g. "TP-LINK_03FE" |
| bssid | String | bssid | E.g. "80:2f:3e:dd:03:fe" |
| dns_address | String | dns address | E.g. "192.168.10.1" |
| vpn_ip | String | vpn ip | E.g. "10.32.3.98" |
| ipv6 | String | ipv6 | E.g. "fe08:393ed3" |
Harmony
| Field | Type | Meaning | Remarks |
|---|---|---|---|
| fp_version | String | device type | E.g. "1.0.2" |
| screen_resolution | String | screen resolution | E.g. "1344x2772" |
| current_time | Long | current time | E.g. 1711594081876 |
| startup_time | String | boot time | E.g. "2024-03-28 09:48:37" |
| up_time | Long | up time | E.g. 3503141 |
| time_zone | String | time zone | E.g. UTC+08:00 |
| language | String | language | E.g. "zh-Hans" |
| charge_state | String | charging status | E.g. "unknown"、"charging"、"unplugged、"unplugged"、"full" |
| battery_level | Integer | battery level | E.g. 20 |
| network_type | string | network type | E.g. "wifi" |
| total_storage | Long | total storage size | E.g. 243041042432 |
| available_storage | Long | available storage size | E.g. 231078236160 |
| cell_ip | String | cell ip | E.g. "10.24.207.224" |
| wifi_ip | String | wifi ip | E.g. "192.168.101.38" |
| vpn_ip | String | vpn ip | E.g. "198.18.0.1" |
| proxy_info | string | proxy info | E.g. "10.57.241.80:8888" |
| device_type | String | device type | E.g. "phone" |
| brand | String | device brand | E.g. "HUAWEI" |
| market_name | String | market name | E.g. "HUAWEI Mate 40 Pro" |
| model | String | model | E.g. "NON-AN00" |
| hardware | String | hardware | E.g. "HN1NOAHM" |
| serial_no | String | serial no | E.g. "05b37354f0dd7f2e" |
| system_version | String | system version | E.g. "2.1.6.6(Beta2)" |
| api_version | String | API versions | E.g. "11" |
| udid | String | udid | E.g. "default" |
| package_name | string | package name | E.g. "com.example.harmonyosdemo" |
| app_version | string | app versions | E.g. "1.0.1" |
| sign_md5 | string | sign md5 | E.g. "8CC29B99116E11A24A7762539327BB566D65773CB64C1521D68E67316DE1923F" |
| country_iso | string | iso country code | E.g. "cn,-" |
| sim_operator | string | sim operator | E.g. "Viettel,VinaPhone" |
| latitude | double | latitude | Accuracy to 6 decimal places， Example 30.282331 |
| longitude | double | longitude | Accuracy to 6 decimal places， Example 120.011395 |
| ip | String | IP address | 223.104.160.62 |
Web
| Field | Type | Meaning | Remarks |
|---|---|---|---|
| browser_name | String | browser name | E.g. "Chrome" |
| browser_version | String | browser version | E.g. "56.0.2924.87" |
| fp_version | String | SDK versions | E.g."3.8.5" |
| user_agent | String | browser userAgent | E.g. "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36" |
| url | String | uniform resource locator | E.g. "file:///Users/td/Documents/td/fp/demo_web.html" |
| device_type | String | device type | E.g. "Mac" |
| os | String | device operating system | E.g. "Mac OS" |
| ip | String | ip addresses | E.g. "123.157.153.130" |
| time_zone | String | time zone | E.g. "UTC+0800" |
| screen_resolution | String | screen resolution | Width x Height，Example："720x1280" |
| language | String | language | E.g. "zh-CN" |
| referer | String | referer | E.g."http://10.57.30.164:8088/" |
| canvas | String | canvas | E.g. "c8a8455d02d7cec9e dbe980b6b9e0ff8" |
| current_time | Long | current time | E.g. "1481694227762" |
IP Location Information
| Field | Type | Meaning | Remarks |
|---|---|---|---|
| continent | String | continent | E.g. "North America" |
| country | String | country | E.g. "The United States" |
| country_id | String | country code | E.g. "US" |
| region | String | province/state/region | E.g. "Virginia" |
| city | String | city | E.g. "Ashburn" |
Device Risk Label
| Field | Type | Applicable platform | Description | Remarks |
|---|---|---|---|---|
| abnormal_time | String | Android, iOS, Web,Mini program | current device time abnormal | Excessive deviation of device times from actual times |
| emulator | String | Android, iOS, Web,Mini program | device is a simulator | The device is an emulator installed on the computer |
| incognito_mode | String | Web | incognito mode | |
| headless_mode | String | Web | virtual browser | |
| abnormal_useragent | String | Web,Mini program | useragent abnormal | |
| debugger_detected | String | Android, iOS, Web | debugger is detected | Debugger is detected |
| hook_tool_detected | String | Android, iOS | hook tool detected | |
| device_info_tampered | String | Android, Web | tampering with device parameters | Device information tampering detected |
| group_control | String | Android, iOS | group control | Using cloud handsets, group control devices |
| no_sim | String | Android, iOS、Harmony | without sim card inserted | Device without a sim card inserted |
| abnormal_device_attr | String | iOS, Web,Mini program | device parameter abnormal | Hash check exceptions, some fields hit special values |
| script_tempered | String | Web | script tampering | |
| virtual_machine | String | Web | device as a virtual machine | The current device is detected as a virtual machine |
| local_debug | String | Web | local debugging | Local debugging detected |
| adb_link | String | Android | android debug bridge | Mobile device connected to PC, in ADB debugging state |
| repackaged | String | Android, iOS | secondary packaging | |
| proxy_detected | String | Android, Harmony,iOS,Mini program(wechat) | using a proxy | |
| root | String | Android | root | |
| jail_break | String | iOS | jailbreak devices | |
| vpn_detected | String | Android, iOS | using vpn | |
| replay_attacks | String | Android,Harmony ,iOS, Web,Mini program | replay attack | The current device information has been repeatedly requested several times |
| cookie_tempered | String | Android, Harmony、iOS, Web,Mini program | cookie tampering | Cookie tampering on client device fingerprint |
| crawler | String | Web | web crawler | |
| malicious_crx | String | Web | malicious extension plugins | |
| debug_tool | String | Web | debugger tools | |
| app_multiple_running | String | Android | app multi opening | |
| sys_multiple_running | String | Android | system multi opening | |
| gps_fake | String | Android, iOS,Mini program(wechat) | virtual positioning | |
| risk_rom | String | Android | suspected risk rom | ROMs for non-native factory devices |
| camera_fake | String | Android, iOS | camera fake | |
| suspected_reset | String | Android | suspected reset |
Device Risk Tools
| Field | type | Description | Remarks |
|---|---|---|---|
| installed_risk_tools_type | Array | installation risk tool Type description | Please refer to installation risk tool Type description |
| running_risk_tools_type | Array | description of the type of risk tool running | Please refer to the description of the type of risk tool running |
Installation Risk Tools
| Field | Applicable platform | Description |
|---|---|---|
| quick_macro | Android, iOS | auto click tool |
| cydia | Android | Cydia |
| agent_app | Android, iOS | agent app |
| more_open | Android | double open tool |
| machine_change_tools | Android, iOS | hook tools |
| code_receiving_platform | Android | code receiving platform |
| magisk | Android | Magisk |
| group_control_software | Android | group control software |
| virtual_app | Android | VirtualApp |
| virtual_positioning | Android, iOS | GPS location fake |
| xposed | Android | Xposed |
| game_transmission | Android | game transmission |
| game_modifier | Android | game modifier |
| cloud_simulator | Android | cloud simulator |
| crowdsourcing_app | Android | crowdsourcing app |
| skip_ads | Android | skip ads |
| anti_crash_frame | Android | anti crash frame |
| capture_tool | Android | capture tool |
| frida | Android | frida |
Running Risk Tools
| Field | Applicable platform | Description |
|---|---|---|
| quick_macro | Android | auto click tool |
| cydia | Android | Cydia |
| magisk | Android | Magisk |
| test_frame | Android | TestFrame |
| virtual_app | Android | VirtualApp |
| xposed | Android | Xposed |
| capture_tool | Android | capture tool |
| frida | Android | frida |
Status Code
| Status Code | Suggestion |
|---|---|
| 200 | - |
| 306 | No available traffic, please contact operations |
| 406 | Wrong region, please check the calling region |
| 500 | Application exception, reserved errors, can be ignored |
| 512 | Service not purchased, please contact operations |
| 513 | Traffic disabled, please contact operations |
| 514 | Service expired, please contact operations |
| 515 | Lack of traffic, please contact operations |
| 9150 | Wrong region, please check the calling region |
| 9151 | Authentication failed, please check the authentication parameters |
| 9152 | Service exception, reserved errors, can be ignored |
| 9153 | Internal exception, reserved errors, maybe attacked |
| 9154 | SDK exception, please check the integration |
| 9155 | Replay, please mark |
| 9156 | Missing file, reserved errors, please check the integration |
| 9157 | Time out, please retry |
| 9158 | Credentials forgery, please mark |
| 9159 | Missing credentials, please check your code |
| 9160 | Wrong environment, confusion between production and testing environments |
| 9161 | Credentials expired, prohibit caching credentials |
Example of response
Basic
{
"code": 200,
"message": "",
"sequence_id": "xxxxxxxxxxxxxxxx",
"device_id": "xxxxxxx",
"device_os": "Android"
}
Pro
{
"code": 200,
"message": "",
"sequence_id": "xxxxxxxxxxxxxxxx",
"device_id": "xxxxxxx",
"device_os": "Android",
"device_detail":{
"android_id":"591b4eb2a65e88f5",
"api_version":"31",
"app_version":"4.1.5.6",
"available_memory":1509654528,
"available_storage":31845441536,
"baseband_version":"MOLY.LR12A.R3.MP.V98.1.P22",
"battery_level":100,
"brand":"Redmi",
"bssid":"24:f2:7f:bd:ec:f3",
"carrier":"Viettel,VinaPhone",
"cell_ip":"10.5.2.39",
"charge_state":"full",
"country_iso":"cn,cn",
"cpu_hardware":"ARMv7 Processor rev 0 (v7l)",
"cpu_type":"Qualcomm Technologies",
"current_time":1687767131368,
"device_name":"lancelot",
"device_svn":"07",
"dns_address":"192.168.8.55",
"fp_version":"4.1.5",
"hardware":"mt6768",
"host":"m1-xm-ota-bd274.bj.idc.xiaomi.com",
"installed_packages":"[{\"package\":\"com.miui.screenrecorder\",\"name\":\"-\"},{\"package\":\"com.miui.fm\",\"name\":\"-\"},{\"package\":\"com.mi.liveassistant\",\"name\":\"-\"},{\"package\":\"com.xiaomi.vipaccount\",\"name\":\"-\"},{\"package\":\"com.qiyi.video\",\"name\":\"-\"},{\"package\":\"cn.tongdun.android.demo4156\",\"name\":\"-\"},{\"package\":\"cn.tongdun.android.demo4159\",\"name\":\"-\"},{\"package\":\"com.miui.thirdappassistant\",\"name\":\"-\"},{\"package\":\"com.android.soundrecorder\",\"name\":\"-\"},{\"package\":\"cn.wps.moffice_eng\",\"name\":\"-\"}]",
"ip":"123.157.153.130",
"ipv6":"fe80::bfd7:21d8:318a:693b",
"language":"zh",
"latitude":30.281257,
"longitude":120.012748,
"mcc":"460,",
"mnc":"01,",
"model":"M2004J19C",
"network_type":"wifi",
"package_name":"cn.tongdun.android.demo",
"product":"lancelot",
"proxy_info":"fe80::bfd7:21d8:318a:693",
"running_packages":"cn.tongdun.android.demo",
"screen_brightness":256,
"screen_resolution":"1080x2340",
"sign_md5":"03ce925f76ceb40e1c2ed8bfe3fcdd0c480a7ba8689ff814c601edfbf79e339e",
"sim_operator":"Viettel,VinaPhone",
"ssid":"IT-YUNZM123",
"startup_time":"2023-06-21 02:14:59",
"system_version":"12",
"time_zone":"UTC+08:00",
"total_memory":3881115648,
"total_storage":50979336192,
"up_time":453431639,
"vpn_ip":"10.32.3.98",
"wifi_ip":"10.57.201.50"
},
"ip_location": {
"country": "China",
"region": "Zhejiang",
"city": "Hangzhou",
"country_id": "CN",
"continent": "Asia"
},
"device_risk_score": 50
}
Enterprise
{
"code": 200,
"message": "",
"sequence_id": "xxxxxxxxxxxxxxxx",
"device_id": "xxxxxxx",
"device_os": "Android",
"device_detail":{
"android_id":"591b4eb2a65e88f5",
"api_version":"31",
"app_version":"4.1.5.6",
"available_memory":1509654528,
"available_storage":31845441536,
"baseband_version":"MOLY.LR12A.R3.MP.V98.1.P22",
"battery_level":100,
"brand":"Redmi",
"bssid":"24:f2:7f:bd:ec:f3",
"carrier":"Viettel,VinaPhone",
"cell_ip":"10.3.4.9",
"charge_state":"full",
"country_iso":"cn,cn",
"cpu_hardware":"`AArch64 Processor rev 15 (aarch64)`",
"cpu_type":"Qualcomm Technologies, Inc ATOLL-AB",
"current_time":1687767131368,
"device_name":"lancelot",
"device_svn":"07",
"dns_address":"192.168.8.55",
"fp_version":"4.1.5",
"hardware":"mt6768",
"host":"m1-xm-ota-bd274.bj.idc.xiaomi.com",
"installed_packages":"[{\"package\":\"com.miui.screenrecorder\",\"name\":\"-\"},{\"package\":\"com.miui.fm\",\"name\":\"-\"},{\"package\":\"com.mi.liveassistant\",\"name\":\"-\"},{\"package\":\"com.xiaomi.vipaccount\",\"name\":\"-\"},{\"package\":\"com.qiyi.video\",\"name\":\"-\"},{\"package\":\"cn.tongdun.android.demo4156\",\"name\":\"-\"},{\"package\":\"cn.tongdun.android.demo4159\",\"name\":\"-\"},{\"package\":\"com.miui.thirdappassistant\",\"name\":\"-\"},{\"package\":\"com.android.soundrecorder\",\"name\":\"-\"},{\"package\":\"cn.wps.moffice_eng\",\"name\":\"-\"}]",
"ip":"123.157.153.130",
"ipv6":"fe08::cd:39:de:3ed3",
"language":"zh",
"latitude":30.281257,
"longitude":120.012748,
"mcc":"460,",
"mnc":"01,",
"model":"M2004J19C",
"network_type":"wifi",
"package_name":"cn.tongdun.android",
"product":"lancelot",
"proxy_info":"10.10.105.60:8080",
"running_packages":"cn.tongdun.android.demo",
"screen_brightness":256,
"screen_resolution":"1080x2340",
"sign_md5":"03ce925f76ceb40e1c2ed8bfe3fcdd0c480a7ba8689ff814c601edfbf79e339e",
"sim_operator":"Viettel,VinaPhone",
"ssid":"IT-YUNZM123",
"startup_time":"2023-06-21 02:14:59",
"system_version":"12",
"time_zone":"UTC+08:00",
"total_memory":3881115648,
"total_storage":50979336192,
"up_time":453431639,
"vpn_ip":"10.32.3.98",
"wifi_ip":"10.57.201.50"
},
"ip_location": {
"country": "China",
"region": "Zhejiang",
"city": "Hangzhou",
"country_id": "CN",
"continent": "Asia"
},
"device_risk_score": 50,
"device_risk_label": [
"abnormal_network_connection"
],
"device_risk_tools":{
"installed_risk_tools_type": [
"quick_macro"
],
"running_risk_tools_type": [
"quick_macro"
]
}
}