ImportYeti
PowerQuery
GET

Rank overseas suppliers from US import data

1 per 10 records

Aggregate US import bills of lading into a ranked list of overseas suppliers.

Parameters#

Query parameters

30 parameters
  • page_sizenumberoptionaldefault 10

    Number of returned results

  • offsetnumberoptionaldefault 0

    Results starting position

  • start_datestringoptionaldefault 01/01/2021
  • end_datestringoptionaldefault 08/31/2026
  • pagenumberoptional

    Page number (1-indexed). Takes precedence over offset.

  • companystringoptional

    Company identifier

  • supplierstringoptional

    Supplier identifier

  • product_descriptionstringoptional

    Supports boolean operators and wildcards

    AND / OR / NOTwildcards * ?
  • weightstringoptional

    Supports ranges

    ranges [a TO b]
  • teustringoptional

    Supports ranges

    ranges [a TO b]
  • company_total_shipmentsstringoptional

    Supports ranges

    ranges [a TO b]
  • supplier_total_shipmentsstringoptional

    Supports ranges

    ranges [a TO b]

fields, exclude, and format work the same way on every endpoint — Response shaping has worked examples.

Response#

A volume-ranked list of overseas suppliers that match your filters.

Response shape
{
  "requestCost": 1,
  "creditsRemaining": 9998.5,
  "data": {
    "data": [
      {
        "key": "Eucatex Industria E Comercio",
        "doc_count": 22,
        "total_shipments": 10468,
        "name_variations": ["Eucatex Industria E Comercio Ltda"],
        "supplier_address": [["R Ribeirao Preto 811 / 909 Jardim Marilia - Salto - Brasil Cep: 13323-010 Tecnpj 14 675 270 0004 50"]],
        "supplier_country_code": "BR",
        "supplier_country": "Brazil",
        "supplier_link": "supplier/eucatex-industria-e-comercio"
        // …14 more fields
      }
    ],
    "totalSuppliers": 59583
  },
  "executionTime": "224ms"
}

Rows are nested one level deeper

PowerQuery routes put the records at data.data — not at data. The total number of matches is on data.totalSuppliers, which is the value you page against. Note that this key is named per route family (totalCount, totalCompanies, totalSuppliers, totalBrokers).

Top-level fields#

  • data — an object holding the result rows (data.data) and the match total (data.totalSuppliers)
  • requestCost — Data credits used for this call (0 if none)
  • creditsRemaining — Your data credit balance after the call
  • executionTime — How long the request took
  • totalSuppliers — Total matching suppliers, not just this page

Fields on each row in data.data#

FieldExample
22 fields
  • keystringEucatex Industria E Comercio
  • doc_countnumber22

    How many documents matched your filters for this bucket — not the company's lifetime total.

  • total_shipmentsnumber10468

    The company's total shipments on record, independent of the filters in this query.

  • name_variationsstring[]["Eucatex Industria E Comercio Ltda"]
  • supplier_addressstring[][["R Ribeirao Preto 811 / 909 Jardim Marilia - Salto - Brasil Cep: 13323-010 Tecnpj 14 675 270 0004 50"]]
  • supplier_country_codestringBR
  • supplier_countrystringBrazil
  • supplier_websitestring[]["eucatex.com"]

  • emails, phone_numbers

  • supplier_main_phone_numberstring1111122222
  • [{"key": "Eucatex Of North America Inc", "doc_count": 70932}]

    Who the carrier notifies on arrival — frequently the freight forwarder or customs broker rather than the buyer.

    key, doc_count

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.