Skip to main content
POST
/
api
/
track17
/
carriers
/
search
/track17/carriers/search
curl --request POST \
  --url https://api.anysite.io/api/track17/carriers/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "keyword": "<string>",
  "country": "US"
}
'
[
  {
    "id": 123,
    "name": "<string>",
    "@type": "@track17_carrier",
    "name_zh_cn": "<string>",
    "name_zh_hk": "<string>",
    "country": "<string>",
    "country_code": 123,
    "web_url": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "group_code": "<string>",
    "scope": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
count
integer
required

Max number of carriers to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
keyword
string | null

Filter carriers whose name contains this text (case-insensitive)

Minimum string length: 1
​
country
string | null

Filter carriers by two-letter ISO country code

Required string length: 2
Example:

"US"

Response

Successful Response

​
id
integer
required
​
name
string
required
​
@type
string
default:@track17_carrier
​
name_zh_cn
string | null
​
name_zh_hk
string | null
​
country
string | null
​
country_code
integer | null
​
web_url
string | null
​
email
string | null
​
phone
string | null
​
group_code
string | null
​
scope
string[]