ImportYeti
PowerQuery
GET

Rank US export companies

1 per 10 records

Aggregate US export bills of lading into a ranked list of companies.

Parameters#

Query parameters

23 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.

  • 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]
  • hs_codestringoptional

    Supports boolean operators and wildcards

    AND / OR / NOTwildcards * ?
  • entry_portstringoptional

    Supports boolean operators and wildcards

    AND / OR / NOTwildcards * ?
  • exit_portstringoptional

    Supports boolean operators and wildcards

    AND / OR / NOTwildcards * ?

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

Response#

A volume-ranked list of US export companies that match your filters.

Response shape
{
  "requestCost": 1,
  "creditsRemaining": 9998.5,
  "data": {
    "data": [
      {
        "company_name": "Double Ace Cargo Inc",
        "total_shipments": 10468,
        "name_variations": ["Double Ace Cargo C/O", "Double Ace Cargo Network"],
        "company_address": ["2175 Nw 115Th Ave, Miami, Fl 33172, Us"],
        "company_country_code": "US",
        "company_country": "United States",
        "company_contact_info_emails": ["[email protected]"],
        "company_contact_info_phone_numbers": ["19058212111"]
        // …6 more fields
      }
    ],
    "totalCompanies": 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.totalCompanies, 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.totalCompanies)
  • requestCost — Data credits used for this call (0 if none)
  • creditsRemaining — Your data credit balance after the call
  • executionTime — How long the request took
  • totalCompanies — Total matching companies, not just this page

Fields on each row in data.data#

FieldExample
14 fields
  • company_namestringDouble Ace Cargo Inc
  • total_shipmentsnumber10468

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

  • name_variationsstring[]["Double Ace Cargo C/O", "Double Ace Cargo Network"]
  • company_addressstring[]["2175 Nw 115Th Ave, Miami, Fl 33172, Us"]
  • company_country_codestringUS
  • company_countrystringUnited States
  • company_contact_info_emailsstring[]["[email protected]"]
  • company_contact_info_phone_numbersstring[]["19058212111"]
  • company_main_phone_numberstring19058212111
  • exit_portsstring[]["Long Beach, Ca"]
  • entry_portsstring[]["Panama"]
  • product_descriptionsstring[]["Vacum Systems"]

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.