Rank US buyers by product specialization
Find US companies most relevant to a product keyword (relevance / specialization ranking).
Parameters#
Path parameters
productstringrequired
Query parameters
page_sizenumberoptionaldefault10Number of returned results
offsetnumberoptionaldefault0Results starting position
countriesstringoptionalComma-separated list of supplier countries
exclude_countriesstringoptionalComma-separated list of supplier countries to exclude
fieldsstringoptionalComma-separated list of fields to keep on each returned record, e.g.
bol_number,arrival_date,supplier_name. Everything else is omitted. Names that the record does not carry are ignored. The envelope (requestCost,creditsRemaining,executionTime,totalCount) is always returned in full. Cannot be combined withexclude. Omit for the full record.excludestringoptionalComma-separated list of fields to drop from each returned record, e.g.
containers,shipping_rate. Every other field is kept. Cannot be combined withfields. Omit for the full record.formatstringoptionaldefaultjsonResponse encoding. Defaults to
json. Passtoonto receive TOON — the same data in a compact, token-efficient text form intended for LLM prompts. Error responses are always JSON.one ofjsontoon
fields, exclude, and format work the same way on every endpoint — Response shaping has worked examples.
Response#
A ranked list of US companies most relevant to that product keyword.
{
"requestCost": 1,
"creditsRemaining": 9998.5,
"data": [
{
"company_link": "/company/fashion-footwear",
"company_name": "Fashion Footwear",
"matching_shipments": 967,
"specialization": 89.87,
"company_total_shipments": 1076,
"company_experience": 3.3,
"product_description": ["Shoes", "Ladies Shoes", "Mens Shoes"],
"company_suppliers": ["Wenzhou Qimao Import & Export"]
// …3 more fields
}
],
"executionTime": "224ms"
}Top-level fields#
data— an array of matching recordsrequestCost— Data credits used for this call (0 if none)creditsRemaining— Your data credit balance after the callexecutionTime— How long the request took
Fields on each item in data#
company_linkstring/company/fashion-footwearcompany_namestringFashion Footwearmatching_shipmentsnumber967How many of this supplier's shipments matched the product you searched.
specializationnumber89.87company_total_shipmentsnumber1076company_experiencenumber3.3product_descriptionstring[]["Shoes", "Ladies Shoes", "Mens Shoes"]company_suppliersstring[]["Wenzhou Qimao Import & Export"]total_suppliersnumber1weightnumber23906858relevance_scorenumber98.99
Errors#
Failures come back as JSON with a statusCode and message. The ones worth handling here are 401 (bad or missing key), 403 (out of credits), and 404 (no such record). See all error responses.